Objetivos
En este instructivo, se explican los siguientes pasos a fin de usar la biblioteca cliente de Spanner para C#:
- Crear una instancia y una base de datos 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 de 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 el entorno local de C#
Establece la variable de entorno
GOOGLE_PROJECT_ID
en tu ID del proyecto de Google Cloud.Primero, configura
GOOGLE_PROJECT_ID
para la sesión actual de PowerShell:$env:GOOGLE_PROJECT_ID = "MY_PROJECT_ID"
Luego, ejecuta lo siguiente a fin de configurar
GOOGLE_PROJECT_ID
para todos los procesos creados después de este comando:[Environment]::SetEnvironmentVariable("GOOGLE_PROJECT_ID", "MY_PROJECT_ID", "User")
Descarga credenciales.
Ve a la página Credenciales en la consola de Google Cloud.
Haz clic en Crear credenciales y selecciona Clave de cuenta de servicio.
En "Cuenta de servicio", selecciona Cuenta de servicio predeterminada de Compute Engine y deja JSON seleccionado en "Tipo de clave". Haz clic en Crear. Tu computadora descarga un archivo JSON.
Configura las credenciales. Para un archivo llamado
FILENAME.json
en el directorio Descargas deCURRENT_USER
, ubicado en la unidadC
, ejecuta los siguientes comandos para configurarGOOGLE_APPLICATION_CREDENTIALS
a fin de que apunte a la clave JSON:En primer lugar, a fin de configurar
GOOGLE_APPLICATION_CREDENTIALS
para esta sesión de PowerShell, ejecuta este comando:$env:GOOGLE_APPLICATION_CREDENTIALS = "C:\Users\CURRENT_USER\Downloads\FILENAME.json"
Luego, ejecuta lo siguiente a fin de configurar
GOOGLE_APPLICATION_CREDENTIALS
para todos los procesos creados después de este comando:[Environment]::SetEnvironmentVariable("GOOGLE_APPLICATION_CREDENTIALS", "C:\Users\CURRENT_USER\Downloads\FILENAME.json", "User")
Clona el repositorio de la app de muestra en tu máquina local:
git clone https://github.com/GoogleCloudPlatform/dotnet-docs-samples
De manera opcional, puedes descargar la muestra como un archivo zip y extraerla.
Abre
Spanner.sln
, que se encuentra en el directoriodotnet-docs-samples\spanner\api
del repositorio descargado, con Visual Studio 2017 o una versión posterior y, luego, compílala.Ve al directorio dentro del repositorio descargado que contiene la aplicación compilada. Por ejemplo:
cd dotnet-docs-samples\spanner\api\Spanner
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 que indica cómo usar Spanner con C#.
Consulta el repositorio de .NET de Spanner en GitHub. que muestra cómo crear una base de datos y modificar un esquema de base de datos. Los datos utilizan el esquema de ejemplo que se muestra en el Página Esquema y modelo de datos
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:
dotnet run createSampleDatabase $env:GOOGLE_PROJECT_ID test-instance example-db
Deberías ver lo siguiente:
Created sample database example-db on instance test-instance
El siguiente paso consiste en escribir datos en tu base de datos.
Crea un cliente de base de datos
Para poder realizar operaciones de lectura o escritura, debes crear un SpannerConnection
:
Puedes pensar en un SpannerConnection
como una conexión de base de datos: todas tus interacciones.
con Spanner deben pasar por un SpannerConnection
.
Obtén más información en la referencia SpannerConnection
.
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 ExecuteNonQueryAsync()
para ejecutar una declaración DML.
Ejecuta la muestra con el argumento writeUsingDml
.
dotnet run writeUsingDml $env:GOOGLE_PROJECT_ID test-instance example-db
Deberías ver lo siguiente:
4 row(s) inserted...
Escribe datos con mutaciones
También puedes insertar datos mediante mutaciones.
Puedes insertar datos con el método connection.CreateInsertCommand()
, que crea un SpannerCommand
nuevo para insertar filas en una tabla. El método SpannerCommand.ExecuteNonQueryAsync()
agrega filas nuevas a la tabla.
En este código, se muestra cómo insertar datos mediante mutaciones:
Ejecuta la muestra con el argumento insertSampleData
.
dotnet run insertSampleData $env:GOOGLE_PROJECT_ID test-instance example-db
Deberías ver lo siguiente:
Inserted data.
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 C#.
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 C#
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 C#
Usa ExecuteReaderAsync()
para ejecutar la consulta de SQL.
Aquí se muestra cómo enviar la consulta y acceder a los datos:
dotnet run querySampleData $env:GOOGLE_PROJECT_ID test-instance example-db
Deberías ver el siguiente resultado:
SingerId: 1 AlbumId: 1 AlbumTitle: Total Junk
SingerId: 1 AlbumId: 2 AlbumTitle: Go, Go, Go
SingerId: 2 AlbumId: 1 AlbumTitle: Green
SingerId: 2 AlbumId: 2 AlbumTitle: Forever Hold your Peace
SingerId: 2 AlbumId: 3 AlbumTitle: 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 contengan un valor específico para LastName
.
A continuación, se muestra cómo enviar la consulta con un parámetro y acceder a los datos:
dotnet run queryWithParameter $env:GOOGLE_PROJECT_ID test-instance example-db
Deberías ver el siguiente resultado:
SingerId : 12 FirstName : Melissa LastName : Garcia
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. Más información sobre las
las actualizaciones y el rendimiento
de los cambios de esquema
Realiza actualizaciones del 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 C#.
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 C#
UsaCreateDdlCommand()
para modificar el esquema:
Ejecuta la muestra mediante el comando addColumn
.
dotnet run addColumn $env:GOOGLE_PROJECT_ID test-instance example-db
Debería ver lo siguiente:
Added the 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 mediante el comando writeDataToNewColumn
.
dotnet run writeDataToNewColumn $env:GOOGLE_PROJECT_ID test-instance example-db
Deberías ver lo siguiente:
Updated data.
También puedes ejecutar una consulta de SQL para obtener los valores que acabas de escribir.
Este es el código para ejecutar la consulta:
Para ejecutar esta consulta, ejecuta la muestra con el argumento queryNewColumn
.
dotnet run queryNewColumn $env:GOOGLE_PROJECT_ID test-instance example-db
Debería ver lo siguiente:
SingerId : 1 AlbumId : 1 MarketingBudget : 100000
SingerId : 1 AlbumId : 2 MarketingBudget :
SingerId : 2 AlbumId : 1 MarketingBudget :
SingerId : 2 AlbumId : 2 MarketingBudget : 500000
SingerId : 2 AlbumId : 3 MarketingBudget :
Actualiza datos
Puedes actualizar los datos mediante DML en una transacción de lectura y escritura.
Usa el método ExecuteNonQueryAsync()
para ejecutar una declaración DML.
Ejecuta la muestra con el argumento writeWithTransactionUsingDml
.
dotnet run writeWithTransactionUsingDml $env:GOOGLE_PROJECT_ID test-instance example-db
Deberías ver lo siguiente:
Transaction complete.
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 automáticamente el indexar 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 automáticamente para lo siguiente: Consultas de SQL que tienen probabilidades de ejecutarse 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 C#.
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 C#
Usa CreateDdlCommand()
para agregar un índice:
Ejecuta la muestra mediante el comando addIndex
.
dotnet run addIndex $env:GOOGLE_PROJECT_ID 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.
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 C#
UsaCreateDdlCommand()
para agregar un índice con una cláusula STORING
:
Ejecuta la muestra mediante el comando addStoringIndex
.
dotnet run addStoringIndex $env:GOOGLE_PROJECT_ID test-instance example-db
Debería ver lo siguiente:
Added the AlbumsByAlbumTitle2 index.
Ahora puedes ejecutar una operación de lectura que recupere todas las columnas AlbumId
, AlbumTitle
y MarketingBudget
del índice AlbumsByAlbumTitle2
:
Para leer los datos con el índice de almacenamiento que creaste, ejecuta una consulta que especifique explícitamente el índice:
Ejecuta la muestra mediante el comando queryDataWithStoringIndex
.
dotnet run queryDataWithStoringIndex $env:GOOGLE_PROJECT_ID test-instance example-db
Deberías ver un resultado similar a este:
AlbumId : 2 AlbumTitle : Forever Hold your Peace MarketingBudget : 300000
AlbumId : 2 AlbumTitle : Go, Go, Go MarketingBudget : 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 TransactionScope()
de .NET framework junto con OpenAsReadOnlyAsync()
para ejecutar transacciones de solo lectura.
A continuación, se muestra cómo ejecutar una consulta y realizar una operación de lectura en la misma transacción de solo lectura:
.NET Standard 2.0
.NET Standard 1.5
Ejecuta la muestra mediante el comando queryDataWithTransaction
.
dotnet run queryDataWithTransaction $env:GOOGLE_PROJECT_ID test-instance example-db
Deberías ver un resultado similar a este:
SingerId : 2 AlbumId : 2 AlbumTitle : Forever Hold your Peace
SingerId : 1 AlbumId : 2 AlbumTitle : Go, Go, Go
SingerId : 2 AlbumId : 1 AlbumTitle : Green
SingerId : 2 AlbumId : 3 AlbumTitle : Terrified
SingerId : 1 AlbumId : 1 AlbumTitle : Total Junk
SingerId : 2 AlbumId : 2 AlbumTitle : Forever Hold your Peace
SingerId : 1 AlbumId : 2 AlbumTitle : Go, Go, Go
SingerId : 2 AlbumId : 1 AlbumTitle : Green
SingerId : 2 AlbumId : 3 AlbumTitle : Terrified
SingerId : 1 AlbumId : 1 AlbumTitle : Total Junk
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 la versión preliminar del proveedor de bases de datos de Spanner para Entity Framework Core.
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 Autenticar en de Google Cloud con bibliotecas cliente.
Obtén más información sobre las prácticas recomendadas para el diseño de esquemas de Spanner.