Objetivos
Neste tutorial, explicaremos as etapas a seguir usando a biblioteca de cliente do Cloud Spanner para Go:
- Criar uma instância e um banco de dados do Cloud Spanner.
- Gravar, ler e executar consultas SQL em dados contidos no banco de dados.
- Atualizar o esquema do banco de dados.
- Atualizar dados usando uma transação de leitura e gravação.
- Adicionar um índice secundário ao banco de dados.
- Usar o índice para ler e executar consultas SQL nos dados.
- Recuperar dados usando uma transação somente leitura.
Custos
Neste tutorial, usamos o Cloud Spanner, que é um componente faturável do Google Cloud. Para informações sobre o custo de utilização do Cloud Spanner, consulte Preços.
Antes de começar
Conclua as etapas descritas em Configurar, que abrangem a criação e a configuração de um projeto padrão do Google Cloud, o faturamento, a API Cloud Spanner e a configuração do OAuth 2.0 para receber credenciais de autenticação para usar a API Cloud Spanner.
Especificamente, execute gcloud auth
application-default login
para configurar o ambiente de desenvolvimento local com credenciais de autenticação.
Preparar seu ambiente Go local
Se ainda não tiver feito isso, instale o Go (fazer download) no seu computador.
Caso ainda não tenha configurado a variável de ambiente
GOPATH
conforme descrito em Testar sua instalação (em inglês), faça isso agora.Faça o download das amostras para sua máquina.
go get -u github.com/GoogleCloudPlatform/golang-samples/spanner/...
Altere para o diretório que contém o código de amostra do Cloud Spanner:
cd $GOPATH/src/github.com/GoogleCloudPlatform/golang-samples/spanner/spanner_snippets
Defina a variável de ambiente
GCLOUD_PROJECT
para seu ID do projeto do Google Cloud.export GCLOUD_PROJECT=[MY_PROJECT_ID]
Criar uma instância
Ao usar o Cloud Spanner pela primeira vez, é necessário criar uma instância, que é uma alocação de recursos usados pelos bancos de dados do Cloud Spanner. Ao criar uma instância, escolha uma configuração que determine onde os dados serão armazenados e também o número de nós a serem usados. Isso determina a quantidade de recursos de exibição e armazenamento na instância.
Execute o seguinte comando para criar uma instância do Cloud Spanner na região us-central1
com um nó:
gcloud spanner instances create test-instance --config=regional-us-central1 \
--description="Test Instance" --nodes=1
A instância criada tem as seguintes características:
- Código da instância:
test-instance
- Nome de exibição:
Test Instance
- Configuração da instância:
regional-us-central1
as configurações regionais armazenam dados em uma região, enquanto as configurações multirregionais distribuem dados em várias regiões. Saiba mais em Instâncias. - Um nó
node_count
corresponde à quantidade de recursos de exibição e armazenamento disponíveis aos bancos de dados na instância. Saiba mais em Contagem de nós.
Você verá:
Creating instance...done.
Examinar arquivos de amostra
O repositório de amostras contém um exemplo que mostra como usar o Cloud Spanner com o Go.
Dê uma olhada no arquivosnippet.go
, que mostra como usar o Cloud Spanner. O código mostra como criar e usar um novo banco de dados. Os dados usam o esquema de exemplo exibido na página Esquema e modelo de dados.
Crie um banco de dados
Crie um banco de dados chamado example-db
na instância denominada test-instance
executando o seguinte comando na linha de comando.
go run snippet.go createdatabase projects/$GCLOUD_PROJECT/instances/test-instance/databases/example-db
Você verá:
Created database [example-db]
Você acabou de criar um banco de dados do Cloud Spanner. Veja a seguir o código usado na criação do banco de dados.
O código também define duas tabelas, Singers
e Albums
, para um aplicativo básico de música. Essas tabelas são usadas em toda esta página. Caso ainda não tenha feito isso, confira o exemplo de esquema.
A próxima etapa é gravar dados no seu banco de dados.
Criar um cliente de banco de dados
Antes de fazer leituras ou gravações, é necessário criar umClient
:
Pense em um Client
como uma conexão de banco de dados: todas as suas interações com o Cloud Spanner precisam passar por um Client
. Normalmente, você cria um Client
quando seu aplicativo é iniciado, depois reutiliza esse Client
para ler, gravar e executar transações. Como cada cliente usa recursos no Cloud Spanner, chame Client.Close()
para limpá-los, incluindo as conexões de rede.
Leia mais na referência de Client
.
O código acima também mostra como criar um
DatabaseAdminClient
,
que é usado para criar um banco de dados.
Gravar dados com DML
É possível inserir dados usando a linguagem de manipulação de dados (DML, na sigla em inglês) em uma transação de leitura/gravação.
Use o método Update()
para executar uma instrução DML.
Execute a amostra usando o argumento dmlwrite
:
go run snippet.go dmlwrite projects/$GCLOUD_PROJECT/instances/test-instance/databases/example-db
Você verá:
4 record(s) inserted.
Gravar dados com mutações
Também é possível inserir dados usando mutações.
Um Mutation
é um contêiner para operações de mutação. Um Mutation
representa uma sequência de inserções, atualizações e exclusões que o Cloud Spanner aplica atomicamente a diferentes linhas e tabelas em um banco de dados do Cloud Spanner.
Use Mutation.InsertOrUpdate()
(em inglês) para construir uma mutação INSERT_OR_UPDATE
, que adiciona uma nova linha ou atualiza valores de coluna caso a linha já exista. Como alternativa, use o método Mutation.Insert()
(em inglês) para construir uma mutação INSERT
, que adiciona uma nova linha.
Client.Apply()
(em inglês) aplica mutações atomicamente a um banco de dados.
Este código mostra como gravar dados usando mutações:
Execute a amostra usando o argumento write
:
go run snippet.go write projects/$GCLOUD_PROJECT/instances/test-instance/databases/example-db
Você verá o comando executado com sucesso.
Consultar dados usando SQL
O Cloud Spanner é compatível com uma interface SQL nativa para leitura de dados, que pode ser acessada na linha de comando usando a ferramenta de linha de comando gcloud
ou programaticamente usando a biblioteca de cliente do Cloud Spanner para Go.
Na linha de comando
Execute a instrução SQL a seguir para ler os valores de todas as colunas da tabela Albums
:
gcloud spanner databases execute-sql example-db --instance=test-instance \
--sql='SELECT SingerId, AlbumId, AlbumTitle FROM Albums'
O resultado será:
SingerId AlbumId AlbumTitle
1 1 Total Junk
1 2 Go, Go, Go
2 1 Green
2 2 Forever Hold Your Peace
2 3 Terrified
Usando a biblioteca de cliente do Cloud Spanner para Go
Além de executar uma instrução SQL na linha de comando, você pode emitir a mesma instrução SQL de forma programática usando a biblioteca de cliente do Cloud Spanner para Go.
Os métodos e tipos a seguir são usados para executar a consulta SQL:Client.Single()
: use para ler o valor de uma ou mais colunas de uma ou mais linhas em uma tabela do Cloud Spanner.Client.Single
retorna umReadOnlyTransaction
, que é usado para executar uma instrução de leitura ou SQL.ReadOnlyTransaction.Query()
: use este método para executar uma consulta em um banco de dados.- O tipo
Statement
: use-o para construir uma string SQL. - O tipo
Row
: use-o para acessar os dados retornados por uma instrução SQL ou uma chamada de leitura.
Veja como emitir a consulta e acessar os dados:
Execute a amostra usando o argumento query
.
go run snippet.go query projects/$GCLOUD_PROJECT/instances/test-instance/databases/example-db
Você verá o resultado a seguir:
1 1 Total Junk
1 2 Go, Go, Go
2 1 Green
2 2 Forever Hold Your Peace
2 3 Terrified
Consulta usando um parâmetro SQL
É possível incluir valores personalizados em instruções SQL usando tipos do SQL compatíveis.
Veja um exemplo de como usar @lastName
como um parâmetro na cláusula WHERE
para
consultar registros que contêm um valor específico para LastName
.
Execute a amostra usando o argumento querywithparameter.
go run snippet.go querywithparameter projects/$GCLOUD_PROJECT/instances/test-instance/databases/example-db
Você verá uma saída como:
12 Melissa Garcia
Ler dados usando a API de leitura
Além da interface SQL, o Cloud Spanner também é compatível com uma interface de leitura.
UseReadOnlyTransaction.Read()
para ler as linhas do banco de dados. Use KeySet
para definir um conjunto de chaves e intervalos de chaves a serem lidos.
Veja como ler os dados:
Execute a amostra usando o argumento read
.
go run snippet.go read projects/$GCLOUD_PROJECT/instances/test-instance/databases/example-db
Você verá uma saída como:
1 1 Total Junk
1 2 Go, Go, Go
2 1 Green
2 2 Forever Hold Your Peace
2 3 Terrified
Atualizar o esquema do banco de dados
Suponha que você precise adicionar uma nova coluna denominada MarketingBudget
à tabela Albums
. Para isso, é necessário atualizar seu esquema de banco de dados. O Cloud Spanner é compatível com atualizações de esquema em um banco de dados enquanto esse banco continua a disponibilizar o tráfego. Para fazer atualizações no esquema, não é necessário desconectar o banco de dados, nem bloquear tabelas ou colunas inteiras. É possível continuar gravando dados no banco de dados durante a atualização do esquema. Leia mais sobre as atualizações de esquemas compatíveis e o desempenho das alterações de esquemas em Atualizações de esquema.
Adicionar uma coluna
É possível adicionar uma coluna na linha de comando usando a ferramenta de linha de comando gcloud
ou programaticamente usando a biblioteca de cliente do Cloud Spanner para Go.
Na linha de comando
Use o seguinte comando ALTER TABLE
para adicionar a nova coluna à tabela:
gcloud spanner databases ddl update example-db --instance=test-instance \
--ddl='ALTER TABLE Albums ADD COLUMN MarketingBudget INT64'
Você verá:
Schema updating...done.
Usando a biblioteca de cliente do Cloud Spanner para Go
UseDatabaseAdminClient.UpdateDatabaseDdl()
para modificar o esquema:
Execute a amostra usando o argumento addnewcolumn
.
go run snippet.go addnewcolumn projects/$GCLOUD_PROJECT/instances/test-instance/databases/example-db
Você verá:
Added MarketingBudget column.
Gravar dados na nova coluna
O código a seguir grava dados na coluna nova. Ele define MarketingBudget
como 100000
para a linha indexada por Albums(1, 1)
e como 500000
para a linha indexada por Albums(2, 2)
.
Execute a amostra usando o argumento update
.
go run snippet.go update projects/$GCLOUD_PROJECT/instances/test-instance/databases/example-db
Também é possível executar uma consulta SQL ou uma chamada de leitura para coletar os valores que você acabou de gravar.
Veja a seguir o código para executar a consulta:
Para executar essa consulta, execute a amostra usando o argumento querynewcolumn
.
go run snippet.go querynewcolumn projects/$GCLOUD_PROJECT/instances/test-instance/databases/example-db
Você verá:
1 1 100000
1 2 NULL
2 1 NULL
2 2 500000
2 3 NULL
Atualizar dados
É possível atualizar dados usando DML em uma transação de leitura/gravação.
Use o método Update()
para executar uma instrução DML.
Execute a amostra usando o argumento dmlwritetxn
.
go run snippet.go dmlwritetxn projects/$GCLOUD_PROJECT/instances/test-instance/databases/example-db
Você verá:
Moved 200000 from Album2's MarketingBudget to Album1's.
Usar um índice secundário
Suponha que você queira buscar todas as linhas de Albums
que tenham valores AlbumTitle
em um determinado intervalo. É possível ler todos os valores da coluna AlbumTitle
usando uma instrução SQL ou uma chamada de leitura e descartar as linhas que não satisfazem os critérios, mas fazer essa verificação na tabela inteira é caro, especialmente para tabelas com muitas linhas. Em vez disso, acelere a recuperação de linhas ao pesquisar por colunas de chaves não primárias por meio da criação de um índice secundário na tabela.
Adicionar um índice secundário a uma tabela requer uma atualização de esquema. Como outras atualizações de esquema, o Cloud Spanner é compatível com a adição de um índice enquanto o banco de dados continua a disponibilizar o tráfego. O Cloud Spanner preenche automaticamente o índice com seus dados atuais. Os preenchimentos podem levar alguns minutos para serem concluídos, mas você não precisa ficar off-line ou evitar gravar na tabela indexada durante esse processo. Para mais detalhes, consulte o preenchimento de índices.
Depois que você adiciona um índice secundário, o Cloud Spanner o usa automaticamente para consultas SQL que provavelmente serão executadas mais rapidamente com o índice. Se você usar a interface de leitura, deverá especificar o índice que quer usar.
Adicionar um índice secundário
É possível adicionar um índice na linha de comando usando a ferramenta de linha de comando gcloud
ou programaticamente usando a biblioteca de cliente do Cloud Spanner para Go.
Na linha de comando
Use o comando CREATE INDEX
a seguir para adicionar um índice ao banco de dados:
gcloud spanner databases ddl update example-db --instance=test-instance \
--ddl='CREATE INDEX AlbumsByAlbumTitle ON Albums(AlbumTitle)'
Você verá:
Schema updating...done.
Usando a biblioteca de cliente do Cloud Spanner para Go
UseUpdateDatabaseDdl()
para adicionar um índice:
A adição do índice pode levar alguns minutos. Depois da adição, você verá:
Added index
Ler usando o índice
Para consultas SQL, o Cloud Spanner usa automaticamente um índice apropriado. Na interface de leitura, especifique o índice em sua solicitação.
Para usar o índice na interface de leitura, use ReadOnlyTransaction.ReadUsingIndex()
, que lê zero ou mais linhas de um banco de dados usando um índice.
O código a seguir busca todas as colunas AlbumId
e AlbumTitle
do índice AlbumsByAlbumTitle
.
Execute a amostra usando o argumento readindex
.
go run snippet.go readindex projects/$GCLOUD_PROJECT/instances/test-instance/databases/example-db
Você verá:
2 Forever Hold Your Peace
2 Go, Go, Go
1 Green
3 Terrified
1 Total Junk
Adicionar um índice com uma cláusula STORING
Talvez você tenha percebido que o exemplo de leitura acima não incluiu a leitura da coluna MarketingBudget
. Isso ocorre porque a interface de leitura do Cloud Spanner não é compatível com a capacidade de fazer a junção de um índice a uma tabela de dados para pesquisar valores que não estão armazenados no índice.
Crie uma definição alternativa de AlbumsByAlbumTitle
que armazene uma cópia de MarketingBudget
no índice.
Na linha de comando
gcloud spanner databases ddl update example-db --instance=test-instance \
--ddl='CREATE INDEX AlbumsByAlbumTitle2 ON Albums(AlbumTitle) STORING (MarketingBudget)'
A adição do índice pode levar alguns minutos. Depois da adição, você verá:
Schema updating...done.
Usando a biblioteca de cliente do Cloud Spanner para Go
UseUpdateDatabaseDdl()
para adicionar um índice com uma cláusula STORING
:
Execute a amostra usando o argumento addstoringindex
.
go run snippet.go addstoringindex projects/$GCLOUD_PROJECT/instances/test-instance/databases/example-db
A adição do índice pode levar alguns minutos. Depois da adição, você verá:
Added storing index
Agora é possível executar uma leitura que busque todas as colunas AlbumId
, AlbumTitle
e MarketingBudget
do índice AlbumsByAlbumTitle2
:
Execute a amostra usando o argumento readstoringindex
.
go run snippet.go readstoringindex projects/$GCLOUD_PROJECT/instances/test-instance/databases/example-db
Você verá uma saída como:
2 Forever Hold Your Peace 300000
2 Go, Go, Go NULL
1 Green NULL
3 Terrified NULL
1 Total Junk 300000
Recuperar dados usando transações somente leitura
Suponha que você queira executar mais de uma leitura no mesmo carimbo de data/hora. As transações somente leitura estão de acordo com um prefixo consistente do histórico de confirmações da transação. Portanto, o aplicativo sempre recebe dados consistentes.
Use o tipo ReadOnlyTransaction
para executar transações somente leitura. Use Client.ReadOnlyTransaction()
para receber um ReadOnlyTransaction
.
Veja a seguir como executar uma consulta e fazer uma leitura na mesma transação somente leitura.
Execute a amostra usando o argumento readonlytransaction
.
go run snippet.go readonlytransaction projects/$GCLOUD_PROJECT/instances/test-instance/databases/example-db
Você verá uma saída como:
2 2 Forever Hold Your Peace
1 2 Go, Go, Go
2 1 Green
2 3 Terrified
1 1 Total Junk
1 1 Total Junk
1 2 Go, Go, Go
2 1 Green
2 2 Forever Hold Your Peace
2 3 Terrified
Limpeza
Para não gerar cobranças extras na sua conta do Google Cloud pelos recursos usados neste tutorial, suspenda o banco de dados e exclua a instância que você criou.
Excluir o banco de dados
Se você excluir uma instância, todos os bancos de dados nela serão excluídos automaticamente. Nesta etapa, mostramos como excluir um banco de dados sem remover a instância. Ainda pode haver cobrança em relação à instância.
Na linha de comando
gcloud spanner databases delete example-db --instance=test-instance
No Console do Cloud
Acesse a página instâncias do Cloud Spanner no Console do Google Cloud.
Clique na instância.
Clique no banco de dados que você quer excluir.
Na página Detalhes do banco de dados, clique em Excluir.
Confirme se quer excluir o banco de dados e clique em Excluir.
Excluir a instância
A exclusão de uma instância descarta automaticamente todos os bancos de dados criados nela.
Na linha de comando
gcloud spanner instances delete test-instance
No Console do Cloud
Acesse a página instâncias do Cloud Spanner no Console do Google Cloud.
Clique na sua instância.
Clique em Excluir.
Confirme se quer excluir a instância e clique em Excluir.