Objetivos
En este instructivo, se explican los siguientes pasos para usar Spanner biblioteca cliente para Go:
- Crea una base de datos y una instancia de Spanner.
- Escribe, lee y ejecuta consultas de SQL sobre datos en la base de datos.
- Actualiza el esquema de la base de datos.
- Actualiza los datos mediante una transacción de lectura y escritura.
- Agrega un índice secundario a la base de datos.
- Usa el índice para leer y ejecutar consultas de SQL sobre datos.
- Recupera datos con una transacción de solo lectura.
Costos
En este instructivo, se usa Spanner, que es un componente facturable del en Google Cloud. Para obtener información sobre el costo de usar Spanner, consulta Precios.
Antes de comenzar
Completa los pasos descritos en Configuración, que abarcan la creación y configuración de un proyecto de Google Cloud predeterminado, la facturación, la habilitación de la API de Cloud Spanner y la configuración de OAuth 2.0 para obtener credenciales de autenticación para usar la API de Cloud Spanner.
En especial, asegúrate de ejecutar gcloud auth
application-default login
para configurar tu entorno de desarrollo local con credenciales de autenticación.
Prepara tu entorno local de Go
Instala Go (descargar) en tu máquina de desarrollo si aún no lo hiciste.
Configura la variable de entorno
GOPATH
si aún no está configurada, como se describe en la sección sobre probar la instalación.Descarga las muestras en tu máquina.
git clone https://github.com/GoogleCloudPlatform/golang-samples $GOPATH/src/github.com/GoogleCloudPlatform/golang-samples
Ve al directorio que contiene el código de muestra de Spanner:
cd $GOPATH/src/github.com/GoogleCloudPlatform/golang-samples/spanner/spanner_snippets
Establece la variable de entorno
GCLOUD_PROJECT
en tu ID del proyecto de Google Cloud:export GCLOUD_PROJECT=[MY_PROJECT_ID]
Crea una instancia
Cuando usas Spanner por primera vez, debes crear una instancia, que es un de los recursos que usan las bases de datos de Spanner. Cuando creas una instancia, debes elegir una configuración de instancia, que determina dónde se almacenan tus datos y también la cantidad de nodos que se usarán, lo que, a su vez, determina la cantidad de recursos de entrega y almacenamiento de tu instancia.
Ejecuta el siguiente comando para crear una instancia de Spanner en la región.
us-central1
con 1 nodo:
gcloud spanner instances create test-instance --config=regional-us-central1 \
--description="Test Instance" --nodes=1
Ten en cuenta que esto crea una instancia con las siguientes características:
- ID de instancia:
test-instance
- Nombre visible:
Test Instance
- Configuración de la instancia:
regional-us-central1
(la configuración regional almacena datos en una región, mientras que la multirregional distribuye datos en varias regiones; Para obtener más información, consulta Acerca de las instancias. - Recuento de nodos: 1 (
node_count
corresponde a la cantidad de recursos de procesamiento y almacenamiento disponibles para las bases de datos de la instancia; Obtén más información en Nodos y unidades de procesamiento de datos).
Deberías ver lo siguiente:
Creating instance...done.
Examina archivos de muestra
El repositorio de muestras contiene una muestra en la que se indica cómo usar Spanner con Go.
Revisa el archivosnippet.go
, que muestra cómo usar
Spanner El código es un instructivo sobre cómo crear y usar una base de datos nueva. Los datos utilizan el esquema de ejemplo de la página Esquema y modelo de datos.
Crea una base de datos
Crea una base de datos llamada example-db
en la instancia test-instance
. Para ello, haz lo siguiente:
ejecutando lo siguiente en la línea de comandos.
GoogleSQL
go run snippet.go createdatabase projects/$GCLOUD_PROJECT/instances/test-instance/databases/example-db
PostgreSQL
go run snippet.go pgcreatedatabase projects/$GCLOUD_PROJECT/instances/test-instance/databases/example-db
Deberías ver lo siguiente:
Created database [example-db]
GoogleSQL
PostgreSQL
El siguiente paso consiste en escribir datos en tu base de datos.
Crea un cliente de base de datos
Antes de realizar operaciones de lectura o escritura, debes crear unClient
:
Un Client
es como una conexión de base de datos: todas tus interacciones con Spanner deben pasar por un Client
. Normalmente, cuando se inicia la aplicación, se crea un Client
y se vuelve a usar ese Client
para leer, escribir y ejecutar transacciones. Cada cliente usa recursos en
Spanner
Si creas varios clientes en la misma app, debes llamar a Client.Close()
para realizar una limpieza de los recursos del cliente, incluidas las conexiones de red, cuando ya no sea necesario.
Obtén más información en la referencia de Client
.
En el código del ejemplo anterior, también se muestra cómo crear una
DatabaseAdminClient
,
que se usa para crear una base de datos.
Escribe datos con DML
Puedes insertar datos mediante el lenguaje de manipulación de datos (DML) en una transacción de lectura y escritura.
Usa el método Update()
para ejecutar una declaración DML.
GoogleSQL
PostgreSQL
Ejecuta la muestra con los argumentos dmlwrite
para Google SQL y pgdmlwrite
para PostgreSQL:
GoogleSQL
go run snippet.go dmlwrite projects/$GCLOUD_PROJECT/instances/test-instance/databases/example-db
PostgreSQL
go run snippet.go pgdmlwrite projects/$GCLOUD_PROJECT/instances/test-instance/databases/example-db
Deberías ver lo siguiente:
4 record(s) inserted.
Escribe datos con mutaciones
También puedes insertar datos mediante mutaciones.
Una Mutation
es un contenedor de operaciones de mutación. Un Mutation
representa una secuencia de
las inserciones, actualizaciones y eliminaciones que Spanner aplica de forma atómica
filas y tablas diferentes
en una base de datos de Spanner.
Usa Mutation.InsertOrUpdate()
para construir una mutación INSERT_OR_UPDATE
, que agrega una fila nueva o actualiza los valores de la columna si la fila ya existe. También puedes usar el método Mutation.Insert()
para construir una mutación INSERT
, que agrega una fila nueva.
Client.Apply()
aplica mutaciones de forma atómica a una base de datos.
En este código, se muestra cómo escribir los datos mediante mutaciones:
Ejecuta la muestra con el argumento write
:
go run snippet.go write projects/$GCLOUD_PROJECT/instances/test-instance/databases/example-db
Deberías ver que el comando se ejecuta con éxito.
Consulta datos mediante SQL
Spanner admite una interfaz de SQL para leer datos, a la que puedes acceder desde la línea de comandos con Google Cloud CLI o de manera programática con la biblioteca cliente de Spanner para Go.
En la línea de comandos
Ejecuta la siguiente instrucción de SQL para leer los valores de todas las columnas de la tabla Albums
:
gcloud spanner databases execute-sql example-db --instance=test-instance \
--sql='SELECT SingerId, AlbumId, AlbumTitle FROM Albums'
El resultado debería ser este:
SingerId AlbumId AlbumTitle
1 1 Total Junk
1 2 Go, Go, Go
2 1 Green
2 2 Forever Hold Your Peace
2 3 Terrified
Usa la biblioteca cliente de Spanner para Go
Además de ejecutar una instrucción de SQL en la línea de comandos, puedes emitir la misma instrucción de SQL de manera programática con la biblioteca cliente de Spanner para Go.
Los siguientes métodos y tipos se usan para ejecutar la consulta de SQL:Client.Single()
: usar esto para leer el valor de una o más columnas de una o más filas de una Tabla de Spanner.Client.Single
muestra unaReadOnlyTransaction
, que se usa para ejecutar una operación de lectura o una instrucción de SQL.ReadOnlyTransaction.Query()
: Usa este método para ejecutar una consulta en una base de datos.- El tipo
Statement
: Úsalo para construir una string de SQL. - El tipo
Row
: Úsalo para acceder. los datos devueltos por una instrucción de SQL o una llamada de lectura.
Aquí se muestra cómo enviar la consulta y acceder a los datos:
Ejecuta la muestra con el argumento query
.
go run snippet.go query projects/$GCLOUD_PROJECT/instances/test-instance/databases/example-db
Deberías ver el siguiente resultado:
1 1 Total Junk
1 2 Go, Go, Go
2 1 Green
2 2 Forever Hold Your Peace
2 3 Terrified
Consulta mediante un parámetro de SQL
Si tu aplicación tiene una consulta ejecutada con frecuencia, puedes mejorar su rendimiento. al parametrizarlo. La consulta paramétrica resultante se puede almacenar en caché y volver a usar, lo que reduce los costos de compilación. Para obtener más información, consulta Usa parámetros de consulta para agilizar las consultas que se ejecutan con frecuencia.
Este es un ejemplo del uso de un parámetro en la cláusula WHERE
para
Consultar registros que contengan un valor específico para LastName
.
GoogleSQL
PostgreSQL
Ejecuta la muestra con el argumento querywithparameter
para Google SQL y el argumento pgqueryparameter
para PostgreSQL.
GoogleSQL
go run snippet.go querywithparameter projects/$GCLOUD_PROJECT/instances/test-instance/databases/example-db
PostgreSQL
go run snippet.go pgqueryparameter projects/$GCLOUD_PROJECT/instances/test-instance/databases/example-db
Deberías ver un resultado similar a este:
12 Melissa Garcia
Lee datos con la API de lectura
Además de la interfaz de SQL de Spanner, Spanner también admite un de lectura.
UsaReadOnlyTransaction.Read()
para leer filas de la base de datos. Usa KeySet
para definir el conjunto de claves y los rangos de claves que desees leer.
Aquí te indicamos cómo leer los datos:
Ejecuta la muestra con el argumento read
.
go run snippet.go read projects/$GCLOUD_PROJECT/instances/test-instance/databases/example-db
Deberías ver un resultado similar a este:
1 1 Total Junk
1 2 Go, Go, Go
2 1 Green
2 2 Forever Hold Your Peace
2 3 Terrified
Actualiza el esquema de la base de datos
Supongamos que necesitas agregar una columna nueva llamada MarketingBudget
a la tabla Albums
. Para agregar una columna nueva a una tabla existente, es necesario actualizar el esquema de la base de datos. Spanner admite actualizaciones del esquema de una base de datos mientras esta sigue entregando tráfico. Las actualizaciones de esquema no requieren que la base de datos esté sin conexión y no bloquean tablas ni columnas completas. Puedes continuar escribiendo datos en la base de datos durante la actualización del esquema. Obtén más información sobre las actualizaciones admitidas del esquema y el rendimiento de los cambios de esquema en Cómo realizar actualizaciones de esquema.
Agrega una columna
Puedes agregar una columna en la línea de comandos con la CLI de Google Cloud o de manera programática con la biblioteca cliente de Spanner para Go.
En la línea de comandos
Usa el siguiente comando ALTER TABLE
para agregar la columna nueva a la tabla:
GoogleSQL
gcloud spanner databases ddl update example-db --instance=test-instance \
--ddl='ALTER TABLE Albums ADD COLUMN MarketingBudget INT64'
PostgreSQL
gcloud spanner databases ddl update example-db --instance=test-instance \
--ddl='ALTER TABLE Albums ADD COLUMN MarketingBudget BIGINT'
Deberías ver lo siguiente:
Schema updating...done.
Usa la biblioteca cliente de Spanner para Go
UsaDatabaseAdminClient.UpdateDatabaseDdl()
para modificar el esquema:
GoogleSQL
PostgreSQL
Ejecuta la muestra con los argumentos addnewcolumn
para Google SQL y pgaddnewcolumn
para PostgreSQL.
GoogleSQL
go run snippet.go addnewcolumn projects/$GCLOUD_PROJECT/instances/test-instance/databases/example-db
PostgreSQL
go run snippet.go pgaddnewcolumn projects/$GCLOUD_PROJECT/instances/test-instance/databases/example-db
Deberías ver lo siguiente:
Added MarketingBudget column.
Escribe datos en la columna nueva
Con el siguiente código, se escriben datos en la columna nueva. Establece MarketingBudget
en 100000
para la fila marcada por Albums(1, 1)
y en 500000
para la fila marcada por Albums(2, 2)
.
Ejecuta la muestra con el argumento update
.
go run snippet.go update projects/$GCLOUD_PROJECT/instances/test-instance/databases/example-db
También puedes ejecutar una consulta de SQL o una llamada de lectura para recuperar los valores que acabas de escribir.
Este es el código para ejecutar la consulta:
GoogleSQL
PostgreSQL
Para ejecutar esta consulta, ejecuta la muestra con el argumento querynewcolumn
para Google SQL y el argumento pgquerynewcolumn
para PostgreSQL.
GoogleSQL
go run snippet.go querynewcolumn projects/$GCLOUD_PROJECT/instances/test-instance/databases/example-db
PostgreSQL
go run snippet.go pgquerynewcolumn projects/$GCLOUD_PROJECT/instances/test-instance/databases/example-db
Deberías ver lo siguiente:
1 1 100000
1 2 NULL
2 1 NULL
2 2 500000
2 3 NULL
Actualiza datos
Puedes actualizar los datos mediante DML en una transacción de lectura y escritura.
Usa el método Update()
para ejecutar una declaración DML.
GoogleSQL
PostgreSQL
Ejecuta la muestra con el argumento dmlwritetxn
.
go run snippet.go dmlwritetxn projects/$GCLOUD_PROJECT/instances/test-instance/databases/example-db
Deberías ver lo siguiente:
Moved 200000 from Album2's MarketingBudget to Album1's.
Usa un índice secundario
Supongamos que deseas recuperar todas las filas de Albums
que tienen valores AlbumTitle
en un rango determinado. Puedes leer todos los valores de la columna AlbumTitle
con una instrucción de SQL o una llamada de lectura y, luego, descartar las filas que no cumplan con los criterios. Sin embargo, analizar tablas enteras es costoso, especialmente si tienen muchas filas. En su lugar, crea un índice secundario en la tabla para acelerar la recuperación de filas cuando realizas búsquedas por columnas sin claves primarias.
Para agregar un índice secundario a una tabla existente, es necesario actualizar el esquema. Me gusta otras actualizaciones de esquema, Spanner admite agregar un índice, mientras que base de datos siga entregando tráfico. Spanner reabastece de manera automática el índice con tus datos existentes. Los reabastecimientos pueden tardar unos minutos en completarse, pero no es necesario que uses la base de datos sin conexión ni que evites escribir en la tabla indexada durante este proceso. Para obtener más detalles, consulta Agrega un índice secundario.
Después de agregar un índice secundario, Spanner lo usa de forma automática en las consultas de SQL que probablemente se ejecuten más rápido con el índice. Si usas la interfaz de lectura, debes especificar el índice que deseas usar.
Agrega un índice secundario
Puedes agregar un índice en la línea de comandos con gcloud CLI o de forma programática con la biblioteca cliente de Spanner para Go.
En la línea de comandos
Usa el siguiente comando CREATE INDEX
para agregar un índice a la base de datos:
gcloud spanner databases ddl update example-db --instance=test-instance \
--ddl='CREATE INDEX AlbumsByAlbumTitle ON Albums(AlbumTitle)'
Deberías ver lo siguiente:
Schema updating...done.
Usa la biblioteca cliente de Spanner para Go
UsaUpdateDatabaseDdl()
para agregar un índice:
Agregar un índice puede tardar unos minutos. Después de agregar el índice, deberías ver lo siguiente:
Added index
Leer con el índice
Para las consultas en SQL, Spanner usa automáticamente un índice adecuado. En la interfaz de lectura, debes especificar el índice en tu solicitud.
Para usar el índice en la interfaz de lectura, usa ReadOnlyTransaction.ReadUsingIndex()
, que lee cero o más filas de una base de datos mediante un índice.
Con el siguiente código, se recuperan todas las columnas AlbumId
y AlbumTitle
del índice AlbumsByAlbumTitle
.
Ejecuta la muestra con el argumento readindex
.
go run snippet.go readindex projects/$GCLOUD_PROJECT/instances/test-instance/databases/example-db
Deberías ver lo siguiente:
2 Forever Hold Your Peace
2 Go, Go, Go
1 Green
3 Terrified
1 Total Junk
Agrega un índice para lecturas de solo índice
Quizás hayas notado que el ejemplo de lectura anterior no incluye la lectura
la columna MarketingBudget
Esto se debe a que la interfaz de lectura de Spanner no admite la posibilidad de unir un índice con una tabla de datos para buscar valores que no están almacenados en el índice.
Crea una definición alternativa de AlbumsByAlbumTitle
que almacene una copia de MarketingBudget
en el índice.
En la línea de comandos
GoogleSQL
gcloud spanner databases ddl update example-db --instance=test-instance \
--ddl='CREATE INDEX AlbumsByAlbumTitle2 ON Albums(AlbumTitle) STORING (MarketingBudget)
PostgreSQL
gcloud spanner databases ddl update example-db --instance=test-instance \
--ddl='CREATE INDEX AlbumsByAlbumTitle2 ON Albums(AlbumTitle) INCLUDE (MarketingBudget)
Agregar un índice puede tardar unos minutos. Después de agregar el índice, deberías ver lo siguiente:
Schema updating...done.
Usa la biblioteca cliente de Spanner para Go
UsaUpdateDatabaseDdl()
para agregar un índice con una cláusula STORING
para GoogleSQL y una cláusula INCLUDE
para PostgreSQL:
GoogleSQL
PostgreSQL
Ejecuta la muestra con el argumento addstoringindex
.
GoogleSQL
go run snippet.go addstoringindex projects/$GCLOUD_PROJECT/instances/test-instance/databases/example-db
PostgreSQL
go run snippet.go pgaddstoringindex projects/$GCLOUD_PROJECT/instances/test-instance/databases/example-db
Agregar un índice puede tardar unos minutos. Después de agregar el índice, deberías ver lo siguiente:
Added storing index
Ahora puedes ejecutar una operación de lectura que recupere todas las columnas AlbumId
, AlbumTitle
y MarketingBudget
del índice AlbumsByAlbumTitle2
:
Ejecuta la muestra con el argumento readstoringindex
.
go run snippet.go readstoringindex projects/$GCLOUD_PROJECT/instances/test-instance/databases/example-db
Deberías ver un resultado similar a este:
2 Forever Hold Your Peace 300000
2 Go, Go, Go NULL
1 Green NULL
3 Terrified NULL
1 Total Junk 300000
Recupera datos mediante transacciones de solo lectura
Supongamos que quieres ejecutar más de una lectura en la misma marca de tiempo. En las transacciones de solo lectura, se observa un prefijo coherente del historial de confirmaciones de transacciones, por lo que la aplicación siempre obtiene datos coherentes.
Usa el tipo ReadOnlyTransaction
para ejecutar transacciones de solo lectura. Usa Client.ReadOnlyTransaction()
para obtener una ReadOnlyTransaction
.
A continuación, se muestra cómo ejecutar una consulta y cómo realizar una lectura en la misma transacción de solo lectura:
Ejecuta la muestra con el argumento readonlytransaction
.
go run snippet.go readonlytransaction projects/$GCLOUD_PROJECT/instances/test-instance/databases/example-db
Deberías ver un resultado similar a este:
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
Limpieza
Para evitar que se apliquen cargos adicionales a tu cuenta de Google Cloud por los recursos que se usaron en este instructivo, descarta la base de datos y borra la instancia que creaste.
Borra la base de datos
Si borras una instancia, se borrarán de forma automática todas las bases de datos que contiene. En este paso, se muestra cómo borrar una base de datos sin borrar una instancia (ten en cuenta que se seguirán generando cargos por la instancia).
En la línea de comandos
gcloud spanner databases delete example-db --instance=test-instance
Usa la consola de Google Cloud
Ve a la página Instancias de Spanner en la consola de Google Cloud.
Haz clic en la instancia.
Haz clic en la base de datos que deseas borrar.
En la página Detalles de la base de datos, haz clic en Borrar.
Confirma que deseas borrar la base de datos y haz clic en Borrar.
Borra la instancia
Si borras una instancia, se descartarán de forma automática todas las bases de datos creadas en ella.
En la línea de comandos
gcloud spanner instances delete test-instance
Usa la consola de Google Cloud
Ve a la página Instancias de Spanner en la consola de Google Cloud.
Haz clic en tu instancia.
Haz clic en Borrar.
Confirma que deseas borrar la instancia y haz clic en Borrar.
¿Qué sigue?
Obtén información para acceder a Spanner con una instancia de máquina virtual.
Obtén más información sobre las credenciales de autorización y autenticación en Autentícate en servicios de Cloud con bibliotecas cliente.
Obtén más información sobre las prácticas recomendadas de diseño de esquemas de Spanner.