Objetivos
En este tutorial se explican los siguientes pasos con la biblioteca de cliente de Spanner para Ruby:
- Crea una instancia y una base de datos de Spanner.
- Escribir, leer y ejecutar consultas SQL sobre datos en la base de datos.
- Actualizar el esquema de la base de datos.
- Actualizar datos mediante una transacción de lectura y escritura.
- Agregar un índice secundario a la base de datos.
- Usar el índice para leer los datos y ejecutar consultas SQL sobre ellos.
- Recuperar datos mediante una transacción de solo lectura.
Costes
En este tutorial se usa Spanner, que es un componente facturable deGoogle Cloud. Para obtener información sobre el coste de usar Spanner, consulta la página Precios.
Antes de empezar
Sigue los pasos que se describen en la sección Configuración, donde se explica cómo crear y definir un proyecto predeterminado Google Cloud , habilitar la facturación y la API Cloud Spanner, y configurar OAuth 2.0 para obtener las credenciales de autenticación que se usarán con la API Cloud Spanner.
En concreto, asegúrate de ejecutar gcloud auth
application-default login
para configurar tu entorno de desarrollo local con credenciales de autenticación.
Preparar el entorno de Ruby local
Instala los elementos indicados a continuación en la máquina de desarrollo si aún no están instalados:
Clona el repositorio de aplicaciones de muestra en la máquina local:
git clone https://github.com/GoogleCloudPlatform/ruby-docs-samples
También puedes descargar la muestra como un archivo ZIP y extraerla.
Cambia al directorio que contiene el código de ejemplo de Spanner:
cd ruby-docs-samples/spanner/
Instala las dependencias:
bundle install
Defina la variable de entorno GOOGLE_CLOUD_PROJECT con el ID de su proyecto: Google Cloud
export GOOGLE_CLOUD_PROJECT=[MY_PROJECT_ID]
Crear una instancia
La primera vez que uses Spanner, debes crear una instancia, que es una asignación de recursos que utilizan las bases de datos de Spanner. Cuando creas una instancia, tienes que elegir una configuración de instancia, que determina dónde se almacenan tus datos y la cantidad de nodos que se van a usar, lo que permite conocer la cantidad de recursos de almacenamiento y publicación de la instancia.
Consulta Crear una instancia para saber cómo crear una instancia de Spanner con cualquiera de los siguientes métodos. Puedes llamar a tu instancia test-instance
para usarla con otros temas de este documento que hagan referencia a una instancia llamada test-instance
.
- Google Cloud CLI
- La Google Cloud consola
- Una biblioteca de cliente (C++, C#, Go, Java, Node.js, PHP, Python o Ruby)
Consultar los archivos de muestra
El repositorio de ejemplos contiene un ejemplo que muestra cómo usar Spanner con Ruby.
Consulta el archivospanner_samples.rb
, que muestra cómo usar Spanner. El código muestra cómo crear y usar una nueva base de datos. Los datos
usan el esquema de ejemplo que se muestra en la página Esquema y modelo de datos.
Crear una base de datos
GoogleSQL
bundle exec ruby spanner_samples.rb create_database test-instance example-db
PostgreSQL
bundle exec ruby spanner_postgresql_create_database.rb postgresql_create_database MY_PROJECT_ID test-instance example-db
Deberías ver lo siguiente:
Created database example-db on instance test-instance
GoogleSQL
PostgreSQL
El siguiente paso consiste en escribir datos en la base de datos.
Crear un cliente de base de datos
Para poder leer o escribir datos, debes crear unClient
. Puedes considerar un Client
como una conexión de base de datos: todas tus interacciones con Spanner deben pasar por un Client
. Normalmente, se crea un Client
cuando se inicia la aplicación y, después, se reutiliza para leer, escribir y ejecutar transacciones.Client
El siguiente código muestra cómo crear un cliente.
Consulta más información en la Client
referencia.
Escribir datos con DML
Puedes insertar datos mediante el lenguaje de manipulación de datos (DML) en una transacción de lectura y escritura.
Utilizas el método execute_update()
para ejecutar una instrucción DML.
Ejecuta la muestra con el argumento write_using_dml
.
bundle exec ruby spanner_samples.rb write_using_dml test-instance example-db
Deberías ver lo siguiente:
4 records inserted.
Escribir datos con mutaciones
También puedes insertar datos mediante mutaciones.
Para escribir datos, se usa un objeto Client
. El método
Client#commit
crea y confirma una transacción para las escrituras que se ejecutan de forma atómica
en un único punto lógico en el tiempo en columnas, filas y tablas de una
base de datos.
En este código se muestra cómo escribir los datos mediante mutaciones:
Ejecuta la muestra con el argumento insert_data
.
bundle exec ruby spanner_samples.rb insert_data test-instance example-db
Deberías ver lo siguiente:
Inserted data
Consultar datos mediante SQL
Spanner admite una interfaz SQL para leer datos, a la que puedes acceder desde la línea de comandos mediante la CLI de Google Cloud o de forma programática con la biblioteca de cliente de Spanner para Ruby.
En la línea de comandos
Ejecuta la siguiente instrucción 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 muestra lo siguiente:
SingerId AlbumId AlbumTitle
1 1 Total Junk
1 2 Go, Go, Go
2 1 Green
2 2 Forever Hold Your Peace
2 3 Terrified
Usar la biblioteca de cliente de Spanner para Ruby
Además de ejecutar una instrucción SQL en la línea de comandos, puedes emitir la misma instrucción SQL de forma programática mediante la biblioteca de cliente de Spanner para Ruby.
Usa el método
Client#execute
para ejecutar la consulta SQL. Usa un símbolo de Ruby :ColumnName
para acceder a los datos de una columna específica de una fila.
A continuación, se indica cómo emitir la consulta y acceder a los datos:
Ejecuta la muestra con el argumento query_data
.
bundle exec ruby spanner_samples.rb query_data test-instance example-db
El resultado debe ser el siguiente:
1 1 Total Junk
1 2 Go, Go, Go
2 1 Green
2 2 Forever Hold Your Peace
2 3 Terrified
Consultar usando 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 se puede almacenar en caché y reutilizar, lo que reduce los costes de compilación. Para obtener más información, consulta Usar parámetros de consulta para acelerar las consultas que se ejecutan con frecuencia.
Aquí tienes un ejemplo de cómo usar un parámetro en la cláusula WHERE
para consultar registros que contengan un valor específico de LastName
.
Ejecuta el ejemplo con el argumento query_with_parameter.
bundle exec ruby spanner_samples.rb query_with_parameter test-instance example-db
El resultado debe ser el siguiente:
12 Melissa Garcia
Leer datos mediante la API de lectura
Además de la interfaz SQL de Spanner, Spanner también admite una interfaz de lectura.
Usa el método Client#read
de la clase Client
para leer filas de la base de datos.
A continuación, mostramos cómo leer los datos:
Ejecuta la muestra con el argumento read_data
.
bundle exec ruby spanner_samples.rb read_data test-instance example-db
El resultado que verás debe parecerse al siguiente:
1 1 Total Junk
1 2 Go, Go, Go
2 1 Green
2 2 Forever Hold Your Peace
2 3 Terrified
Actualizar el esquema de la base de datos
Supongamos que quiere añadir una nueva columna llamada MarketingBudget
a la tabla Albums
. Para agregar una nueva columna a una tabla existente, es preciso actualizar el esquema de base de datos. Spanner admite actualizaciones de esquemas en una base de datos mientras esta sigue atendiendo tráfico. Para actualizar el esquema, no es necesario desconectar la base de datos y no se bloquean tablas ni columnas completas. Puedes seguir escribiendo datos en la base de datos durante la actualización del esquema. Consulta más información sobre las actualizaciones de esquemas y el rendimiento de los cambios de esquemas admitidos en el artículo Hacer actualizaciones de esquemas.
Añadir una columna
Puedes añadir una columna en la línea de comandos con la CLI de Google Cloud o mediante programación con la biblioteca de cliente de Spanner para Ruby.
En la línea de comandos
Usa el siguiente comando ALTER TABLE
para añadir la nueva columna 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.
Usar la biblioteca de cliente de Spanner para Ruby
Usa el métodoDatabase#update
de la clase Database
para modificar el esquema:
Ejecuta la muestra con el argumento add_column
.
bundle exec ruby spanner_samples.rb add_column test-instance example-db
Deberías ver lo siguiente:
Added the MarketingBudget column
Escribir datos en la nueva columna
El siguiente código sirve para escribir datos en la nueva columna. Define MarketingBudget
como 100000
en la fila con la clave Albums(1, 1)
y como 500000
en la fila con la clave Albums(2, 2)
.
Ejecuta la muestra con el argumento update_data
.
bundle exec ruby spanner_samples.rb update_data test-instance example-db
Deberías ver lo siguiente:
Updated data
También puedes ejecutar una consulta SQL o una llamada de lectura para recuperar los valores que acabas de escribir.
Aquí está el código para ejecutar la consulta:
Para ejecutar esta consulta, ejecuta la muestra con el argumento query_data_with_new_column
.
bundle exec ruby spanner_samples.rb query_data_with_new_column test-instance example-db
Deberías ver lo siguiente:
1 1 100000
1 2
2 1
2 2 500000
2 3
Actualizar datos
Puedes actualizar datos mediante DML en una transacción de lectura y escritura.
Utilizas el método execute_update()
para ejecutar una instrucción DML.
Ejecuta la muestra con el argumento write_with_transaction_using_dml
.
bundle exec ruby spanner_samples.rb write_with_transaction_using_dml test-instance example-db
Deberías ver lo siguiente:
Transaction complete
Usar un índice secundario
Supongamos que quieres obtener todas las filas de Albums
que tengan valores de AlbumTitle
en un intervalo determinado. Podría leer todos los valores de la columna AlbumTitle
con una instrucción SQL o una llamada de lectura y, a continuación, descartar las filas que no cumplan los criterios, pero hacer este análisis de toda la tabla es caro, sobre todo en el caso de las tablas con muchas filas. En su lugar, puedes acelerar la recuperación de filas al buscar por columnas que no sean de clave principal creando un índice secundario en la tabla.
Para añadir un índice secundario a una tabla existente, es preciso actualizar el esquema. Al igual que otras actualizaciones de esquema, Spanner permite añadir un índice mientras la base de datos sigue sirviendo tráfico. Spanner rellena automáticamente el índice con los datos que ya tengas. Los rellenos pueden tardar unos minutos en completarse, pero no es necesario que pongas la base de datos sin conexión ni que evites escribir en la tabla indexada durante este proceso. Para obtener más información, consulta Añadir un índice secundario.
Después de añadir un índice secundario, Spanner lo usa automáticamente 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 quieras usar.
Añadir un índice secundario
Puedes añadir un índice en la línea de comandos con la CLI de gcloud o de forma programática con la biblioteca cliente de Spanner para Ruby.
En la línea de comandos
Usa el siguiente comando CREATE INDEX
para añadir 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.
Usar la biblioteca de cliente de Spanner para Ruby
Usa el método Database#update
de la clase Database
para añadir un índice:
Ejecuta la muestra con el argumento create_index
.
bundle exec ruby spanner_samples.rb create_index test-instance example-db
Añadir un índice es un proceso que puede llevar unos minutos. Esto es lo que debes ver después de añadir el índice:
Added the AlbumsByAlbumTitle index
Leer datos mediante el índice
En el caso de las consultas de SQL, Spanner usa automáticamente un índice adecuado. En la interfaz de lectura, debe especificar el índice en su solicitud.
Para usar el índice en la interfaz de lectura, proporciona un parámetro index
al método read
de la clase Client
.
Ejecuta la muestra con el argumento read_data_with_index
.
bundle exec ruby spanner_samples.rb read_data_with_index 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
Añadir un índice para lecturas solo de índice
Puede que hayas observado 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 combinar 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)
Añadir un índice es un proceso que puede llevar unos minutos. Esto es lo que debes ver después de añadir el índice:
Schema updating...done.
Usar la biblioteca de cliente de Spanner para Ruby
Usa el métodoDatabase#update
de la clase Database
para añadir un índice con una cláusula STORING
:
Ejecuta la muestra con el argumento create_storing_index
.
bundle exec ruby spanner_samples.rb create_storing_index test-instance example-db
Deberías ver lo siguiente:
Added the AlbumsByAlbumTitle2 index
Ahora puedes ejecutar una lectura que obtenga todas las columnas AlbumId
, AlbumTitle
y MarketingBudget
del índice AlbumsByAlbumTitle2
:
Ejecuta la muestra con el argumento read_data_with_storing_index
.
bundle exec ruby spanner_samples.rb read_data_with_storing_index test-instance example-db
El resultado que verás debe parecerse al siguiente:
2 Forever Hold Your Peace 300000
2 Go, Go, Go
1 Green
3 Terrified
1 Total Junk 300000
Recuperar datos mediante transacciones de solo lectura
Supongamos que deseas ejecutar más de una lectura en la misma marca de tiempo. En las transacciones de solo lectura se observa un prefijo uniforme del historial de confirmación de transacción, por lo que la aplicación siempre obtiene datos uniformes.
Usa un objeto Snapshot
para ejecutar transacciones de solo lectura. Usa el método snapshot
de la clase Client
para obtener un objeto Snapshot
.
A continuación, se muestra cómo ejecutar una consulta y realizar una lectura en la misma transacción de solo lectura:
Ejecuta la muestra con el argumento read_only_transaction
.
bundle exec ruby spanner_samples.rb read_only_transaction test-instance example-db
El resultado que verás debe parecerse al siguiente:
2 Forever Hold Your Peace 2
2 Go, Go, Go 1
1 Green 2
3 Terrified 2
1 Total Junk 1
1 Total Junk 1
2 Go, Go, Go 1
1 Green 2
2 Forever Hold Your Peace 2
3 Terrified 2
Limpieza
Para evitar que se apliquen cargos adicionales en tu cuenta de Facturación de Cloud por los recursos utilizados en este tutorial, elimina la base de datos y la instancia que has creado.
Eliminar la base de datos
Al eliminar una instancia, se eliminan automáticamente todas sus bases de datos. En este paso se muestra cómo eliminar una base de datos sin eliminar una instancia (se seguirían generando costes por la instancia).
En la línea de comandos
gcloud spanner databases delete example-db --instance=test-instance
Usar la Google Cloud consola
Ve a la página Instancias de Spanner de la Google Cloud consola.
Haz clic en la instancia.
Haz clic en la base de datos que quieras eliminar.
En la página sobre detalles de la base de datos, haz clic en Eliminar.
Confirma que deseas eliminar la base de datos y haz clic en Eliminar.
Eliminar la instancia
Al eliminar una instancia, se borran todas las bases de datos creadas en dicha instancia.
En la línea de comandos
gcloud spanner instances delete test-instance
Usar la Google Cloud consola
Ve a la página Instancias de Spanner de la Google Cloud consola.
Haz clic en tu instancia.
Haz clic en Eliminar.
Confirma que deseas eliminar la instancia y haz clic en Eliminar.
Siguientes pasos
Consulta cómo acceder a Spanner con una instancia de máquina virtual.
Consulta información sobre las credenciales de autorización y autenticación en el artículo Autenticarse en servicios de Cloud mediante bibliotecas de cliente.
Consulta más información sobre las prácticas recomendadas para el diseño de esquemas de Spanner.