This page shows how to get started with the Cloud Client Libraries for the Cloud Spanner API. Read more about the client libraries for Cloud APIs, including the older Google APIs Client Libraries, in Client Libraries Explained.
The Cloud Spanner client libraries mentioned on this page are supported on Compute Engine, App Engine flexible environment, Google Kubernetes Engine, and Cloud Functions. The Cloud Spanner client library for Java is supported on App Engine standard environment with Java 8.
If you are using the App Engine standard environment with Go, PHP, or Python, use the REST interface to access Cloud Spanner.
Installing the client library
C++
See the GitHub quickstart documents for details about this client library's requirements and install dependencies.C#
For more information, see Setting Up a C# Development Environment.
To install theGoogle.Cloud.Spanner.Data
client library in Visual Studio,
do the following:
Right-click your solution in Visual Studio and select Manage Nuget packages for solution.
Select the Include prerelease checkbox.
Search for and install the package named
Google.Cloud.Spanner.Data
.
Go
For more information, see Setting Up a Go Development Environment.
go get -u cloud.google.com/go/spanner/...
Java
For more information, see Setting Up a Java Development Environment.
Si usas Maven, agrega lo siguiente al archivo pom.xml
. Para obtener más información sobre las BOM, consulta Las bibliotecas de BOM de Google Cloud Platform.
Si usas Gradle, agrega lo siguiente a las dependencias:
Si usas sbt, agrega lo siguiente a las dependencias:
Si usas IntelliJ o Eclipse, puedes agregar bibliotecas cliente a tu proyecto mediante los siguientes complementos de IDE:
Los complementos brindan funcionalidades adicionales, como administración de claves para las cuentas de servicio. Consulta la documentación de cada complemento para obtener más detalles.
Node.js
For more information, see Setting Up a Node.js Development Environment.
npm install --save @google-cloud/spanner
PHP
For more information, see Using PHP on Google Cloud.
composer require google/cloud-spanner
Python
For more information, see Setting Up a Python Development Environment.
pip install --upgrade google-cloud-spanner
Ruby
For more information, see Setting Up a Ruby Development Environment.
gem install google-cloud-spanner
Setting up authentication
To run the client library, you must first set up authentication by creating a service account and setting an environment variable. Complete the following steps to set up authentication. For other ways to authenticate, see the GCP authentication documentation.
Cloud Console
-
En Cloud Console, ve a la página Crea una clave de cuenta de servicio.
Ir a la página Crea una clave de la cuenta de servicio - En la lista Cuenta de servicio, selecciona Cuenta de servicio nueva.
- Ingresa un nombre en el campo Nombre de cuenta de servicio.
En la lista Función, selecciona Proyecto > Propietario.
- Haz clic en Crear. Se descargará un archivo JSON que contiene tus claves a tu computadora.
Línea de comandos
Puedes ejecutar los siguientes comandos con el SDK de Cloud en tu máquina local o en Cloud Shell.
-
Crea la cuenta de servicio. Reemplaza NAME por un nombre para la cuenta de servicio.
gcloud iam service-accounts create NAME
-
Otorga permisos a la cuenta de servicio. Reemplaza PROJECT_ID por el ID del proyecto.
gcloud projects add-iam-policy-binding PROJECT_ID --member="serviceAccount:NAME@PROJECT_ID.iam.gserviceaccount.com" --role="roles/owner"
-
Genera el archivo de claves. Reemplaza FILE_NAME por un nombre para el archivo de claves.
gcloud iam service-accounts keys create FILE_NAME.json --iam-account=NAME@PROJECT_ID.iam.gserviceaccount.com
Configura la variable de entorno GOOGLE_APPLICATION_CREDENTIALS
para proporcionar credenciales de autenticación al código de la aplicación.
Reemplaza [PATH] por la ruta de acceso del archivo JSON que contiene la clave de tu cuenta de servicio. Esta variable solo se aplica a la sesión actual de shell. Por lo tanto, si abres una sesión nueva, deberás volver a configurar la variable.
Linux o macOS
export GOOGLE_APPLICATION_CREDENTIALS="[PATH]"
Por ejemplo:
export GOOGLE_APPLICATION_CREDENTIALS="/home/user/Downloads/my-key.json"
Windows
Con PowerShell:
$env:GOOGLE_APPLICATION_CREDENTIALS="[PATH]"
Por ejemplo:
$env:GOOGLE_APPLICATION_CREDENTIALS="C:\Users\username\Downloads\my-key.json"
Con el símbolo del sistema:
set GOOGLE_APPLICATION_CREDENTIALS=[PATH]
Using the client library
The following example shows how to use the client library.
C++
C#
Go
Java
Node.js
PHP
Python
Ruby
Additional resources
C++
C#
Go
Java
Node.js
PHP
Python
Ruby
Additional client libraries
In addition to the libraries shown above, a Spring Data module is available for Java applications. Spring Data Cloud Spanner helps you use Cloud Spanner in any application that's built with the Spring Framework.
To get started, learn how to add Spring Data Cloud Spanner to your application.