Objetivos
En este instructivo, se explican los siguientes pasos para usar la biblioteca cliente de Spanner para Java:
- 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 Java local
Instala los siguientes componentes en tu máquina de desarrollo si aún no se instalaron:
Clona el repositorio de la app de muestra en tu máquina local:
git clone https://github.com/googleapis/java-spanner.git
Ve al directorio que contiene el código de muestra de Spanner:
cd java-spanner/samples/snippets
Crea una instancia
Cuando usas Spanner por primera vez, debes crear una instancia, que es una asignación de 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).
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 Java.
Crea una base de datos
Para crear una base de datos llamada example-db
en la instancia test-instance
, ejecuta lo siguiente en la línea de comandos:
GoogleSQL
java -jar target/spanner-snippets/spanner-google-cloud-samples.jar \
createdatabase test-instance example-db
PostgreSQL
java -jar target/spanner-snippets/spanner-google-cloud-samples.jar \
createpgdatabase test-instance 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
Para realizar operaciones de lectura o escritura, debes crear unDatabaseClient
.
Un DatabaseClient
es como una conexión de base de datos: todas tus interacciones con Spanner deben pasar por un DatabaseClient
. Normalmente, cuando se inicia la aplicación, se crea un DatabaseClient
y se vuelve a usar ese DatabaseClient
para leer, escribir y ejecutar transacciones.
GoogleSQL
PostgreSQL
Cada cliente usa recursos en Spanner, por lo que se recomienda llamar a close()
para cerrar los clientes innecesarios.
Obtén más información en el DatabaseClient
Referencia de Javadoc.
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 executeUpdate()
para ejecutar una declaración DML.
Ejecuta la muestra con el argumento writeusingdml
.
java -jar target/spanner-snippets/spanner-google-cloud-samples.jar \
writeusingdml test-instance example-db
Deberías ver lo siguiente:
4 records inserted.
Escribe datos con mutaciones
También puedes insertar datos mediante mutaciones.
Puedes escribir datos usando
Un objeto Mutation
Este objeto Mutation
es un contenedor de operaciones de mutación. Una Mutation
representa una secuencia de inserciones, actualizaciones y eliminaciones que Spanner aplica de manera atómica a diferentes filas y tablas en una base de datos de Spanner.
El método newInsertBuilder()
en la clase Mutation
genera una mutación INSERT
, que inserta una fila nueva en una tabla. Si la fila ya existe, la escritura falla. Por otro lado,
puedes usar el newInsertOrUpdateBuilder
método para construir una mutación INSERT_OR_UPDATE
, que actualiza los valores de la columna
si la fila ya existe.
write()
en la clase DatabaseClient
escribe las mutaciones. Todas las mutaciones en un solo lote se aplican de forma atómica.
En este código, se muestra cómo escribir los datos mediante mutaciones:
Ejecuta la muestra con el argumento write
.
java -jar target/spanner-snippets/spanner-google-cloud-samples.jar \
write test-instance 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, que puedes en la línea de comandos con Google Cloud CLI programáticamente con la biblioteca cliente de Spanner para Java.
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 Java
Además de ejecutar una instrucción de SQL en la línea de comandos, puedes emitir el misma instrucción de SQL de manera programática con la biblioteca cliente de Spanner para Java
Los siguientes métodos y clases se usan para ejecutar la consulta de SQL:- Método
singleUse()
en la claseDatabaseClient
: usa esto para leer el valor de una o más columnas de una o más filas en una tabla de Spanner. Devoluciones porsingleUse()
Un objetoReadContext
, que se usa para ejecutar una instrucción de lectura o de SQL - Método
executeQuery()
de la claseReadContext
: usa este método para ejecutar una consulta en una base de datos. - Clase
Statement
: úsala para crear una string de SQL. - Clase
ResultSet
: úsala para acceder a los datos que muestra 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
.
java -jar target/spanner-snippets/spanner-google-cloud-samples.jar \
query test-instance 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 que se ejecuta con frecuencia, puedes mejorar su rendimiento parametrizándola. La consulta paramétrica resultante puede almacenarse en caché y volverse a usar, lo que reduce los costos de compilación. Para obtener más información, consulta Usa parámetros de consulta para acelerar 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 contienen un valor específico de LastName
.
GoogleSQL
PostgreSQL
Ejecuta la muestra con el argumento queryWithParameter.
java -jar target/spanner-snippets/spanner-google-cloud-samples.jar \
querywithparameter test-instance example-db
Deberías ver el siguiente resultado:
12 Melissa Garcia
Lee datos con la API de lectura
Además de la interfaz de SQL de Spanner, Spanner también admite una interfaz de lectura.
Usa el métodoread()
de la clase ReadContext
para leer las filas de la base de datos. Usa un objeto KeySet
para definir un conjunto de claves y rangos de claves que se leerán.
Aquí te indicamos cómo leer los datos:
Ejecuta la muestra con el argumento read
.
java -jar target/spanner-snippets/spanner-google-cloud-samples.jar \
read test-instance 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 Google Cloud CLI o programáticamente con la biblioteca cliente de Spanner para Java.
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 Java
Usa el métodoupdateDatabaseDdl()
de la clase DatabaseAdminClient
para modificar el esquema:
GoogleSQL
PostgreSQL
Ejecuta la muestra con el argumento addmarketingbudget
.
java -jar target/spanner-snippets/spanner-google-cloud-samples.jar \
addmarketingbudget test-instance 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
.
java -jar target/spanner-snippets/spanner-google-cloud-samples.jar \
update test-instance 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 querymarketingbudget
.
java -jar target/spanner-snippets/spanner-google-cloud-samples.jar \
querymarketingbudget test-instance example-db
Debería 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.
Usas executeUpdate()
método para ejecutar una declaración DML.
GoogleSQL
PostgreSQL
Ejecuta la muestra con el argumento writewithtransactionusingdml
.
java -jar target/spanner-snippets/spanner-google-cloud-samples.jar \
writewithtransactionusingdml test-instance example-db
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. Al igual que otras actualizaciones de esquema, Spanner admite que se agregue un índice mientras la base de datos continúa 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 la CLI de gcloud o de manera programática con la biblioteca cliente de Spanner para Java.
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 Java
Usa laupdateDatabaseDdl()
.
de la clase DatabaseAdminClient
para agregar un índice:
Ejecuta la muestra con el argumento addindex
.
java -jar target/spanner-snippets/spanner-google-cloud-samples.jar \
addindex test-instance example-db
Agregar un índice puede tardar unos minutos. Después de agregar el índice, deberías ver lo siguiente:
Added the AlbumsByAlbumTitle 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 el método readUsingIndex()
de la clase ReadContext
.
El siguiente código recupera todas las columnas AlbumId
y AlbumTitle
del índice AlbumsByAlbumTitle
.
Ejecuta la muestra con el argumento readindex
.
java -jar target/spanner-snippets/spanner-google-cloud-samples.jar \
readindex test-instance 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 las operaciones de lectura de solo índice
Quizás notaste que, en el ejemplo de lectura anterior, no se incluye la lectura de 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 Java
Usa el método updateDatabaseDdl()
de la clase DatabaseAdminClient
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
.
java -jar target/spanner-snippets/spanner-google-cloud-samples.jar \
addstoringindex test-instance example-db
Agregar un índice puede tardar unos minutos. Después de agregar el índice, deberías ver lo siguiente:
Added AlbumsByAlbumTitle2 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
.
java -jar target/spanner-snippets/spanner-google-cloud-samples.jar \
readstoringindex test-instance 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. Las transacciones de solo lectura utilizan un prefijo coherente del historial de confirmaciones de transacciones, por lo que la aplicación siempre obtiene datos coherentes.
Usa un objeto ReadOnlyTransaction
para ejecutar transacciones de solo lectura. Usa el método readOnlyTransaction()
de la clase DatabaseClient
para obtener un objeto 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
.
java -jar target/spanner-snippets/spanner-google-cloud-samples.jar \
readonlytransaction test-instance 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?
- Prueba el módulo de datos de Spring para Spanner.
Aprende a 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.