This page shows how to get started with the Cloud Client Libraries for the Cloud Spanner API. Client libraries make it easier to access Google Cloud APIs from a supported language. Although you can use Google Cloud APIs directly by making raw requests to the server, client libraries provide simplifications that significantly reduce the amount of code you need to write. Read more about the Cloud Client Libraries and the older Google API Client Libraries in [Client libraries explained](https://docs.cloud.google.com/apis/docs/client-libraries-explained.md.txt). Spanner provides client libraries for popular programming languages, including C++, C#, Go, Java, Node.js, PHP, Python, Ruby, and Rust. The client libraries connect to the Spanner service using gRPC over a TLS-encrypted HTTP/2 connection, so you don't need to manually configure SSL or TLS. The Spanner client libraries are supported on Compute Engine, App Engine flexible environment, Google Kubernetes Engine, and Cloud Run functions. The Spanner client library for Java is also 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](https://docs.cloud.google.com/spanner/docs/reference/rest.md.txt) to access Spanner. > [!NOTE] > **Note:** [Additional client libraries](https://docs.cloud.google.com/spanner/docs/reference/libraries.md.txt#more-libraries) are available for Java applications. ## Install the client library ### C++ For more information about installing the C++ library, see the [Setting up a C++ development environment](https://docs.cloud.google.com/cpp/docs/setup.md.txt) guide. ### C# To install the `Google.Cloud.Spanner.Data` client library in Visual Studio, do the following:
1. Right-click your solution in Visual Studio and select **Manage Nuget packages for solution**. 2. Select the **Include prerelease** checkbox. 3. Search for and install the package named `Google.Cloud.Spanner.Data`. For more information, see [Setting Up a C# Development Environment](https://docs.cloud.google.com/dotnet/docs/setup.md.txt). ### Go ``` go get cloud.google.com/go/spanner/... ``` For more information, see [Setting Up a Go Development Environment](https://docs.cloud.google.com/go/docs/setup.md.txt). ### Java > [!NOTE] > **Note:** If your application uses the Spring Framework, a [Spring Data module](https://docs.cloud.google.com/spanner/docs/adding-spring.md.txt) is also available. If you are using [Maven](https://maven.apache.org/), add the following to your `pom.xml` file. For more information about BOMs, see [The Google Cloud Platform Libraries BOM](https://cloud.google.com/java/docs/bom). ```java com.google.cloud libraries-bom 26.90.0 pom import com.google.cloud google-cloud-spanner ``` If you are using [Gradle](https://gradle.org/), add the following to your dependencies: ```java implementation platform('com.google.cloud:libraries-bom:26.90.0') implementation 'com.google.cloud:google-cloud-spanner' ``` If you are using [sbt](https://www.scala-sbt.org/), add the following to your dependencies: ```java libraryDependencies += "com.google.cloud" % "google-cloud-spanner" % "6.127.0" ``` If you're using Visual Studio Code or IntelliJ, you can add client libraries to your project using the following IDE plugins: - [Cloud Code for VS Code](https://docs.cloud.google.com/code/docs/vscode/client-libraries.md.txt) - [Cloud Code for IntelliJ](https://docs.cloud.google.com/code/docs/intellij/client-libraries.md.txt) The plugins provide additional functionality, such as key management for service accounts. Refer to each plugin's documentation for details. > [!NOTE] > **Note:** Cloud Java client libraries do not currently support Android. For more information, see [Setting Up a Java Development Environment](https://docs.cloud.google.com/java/docs/setup.md.txt). ### Node.js ``` npm install @google-cloud/spanner ``` For more information, see [Setting Up a Node.js Development Environment](https://docs.cloud.google.com/nodejs/docs/setup.md.txt). ### PHP ``` composer require google/cloud-spanner ```
> [!NOTE] > **Note:** The Spanner Client Library requires that you install and enable the [gRPC extension](https://docs.cloud.google.com/php/grpc) for PHP. For more information, see [Using PHP on Google Cloud](https://docs.cloud.google.com/php/docs.md.txt). ### Python ``` pip install --upgrade google-cloud-spanner ``` For more information, see [Setting Up a Python Development Environment](https://docs.cloud.google.com/python/docs/setup.md.txt). ### Ruby ``` gem install google-cloud-spanner ``` For more information, see [Setting Up a Ruby Development Environment](https://docs.cloud.google.com/ruby/docs/setup.md.txt). ### Rust ``` cargo add google-cloud-spanner cargo add tokio --features full ``` For more information, see [Get started with Rust](https://docs.cloud.google.com/rust/docs/quickstart.md.txt).
## Set up authentication To authenticate calls to Google Cloud APIs, client libraries support [Application Default Credentials (ADC)](https://docs.cloud.google.com/docs/authentication/application-default-credentials.md.txt); the libraries look for credentials in a set of defined locations and use those credentials to authenticate requests to the API. With ADC, you can make credentials available to your application in a variety of environments, such as local development or production, without needing to modify your application code. For production environments, the way you set up ADC depends on the service and context. For more information, see [Set up Application Default Credentials](https://docs.cloud.google.com/docs/authentication/provide-credentials-adc.md.txt). For a local development environment, you can set up ADC with the credentials that are associated with your Google Account: 1. [Install](https://docs.cloud.google.com/sdk/docs/install) the Google Cloud CLI. After installation, [initialize](https://docs.cloud.google.com/sdk/docs/initializing) the Google Cloud CLI by running the following command: ```bash gcloud init ``` If you're using an external identity provider (IdP), you must first [sign in to the gcloud CLI with your federated identity](https://docs.cloud.google.com/iam/docs/workforce-log-in-gcloud.md.txt). 2. If you're using a local shell, then create local authentication credentials for your user account: ```bash gcloud auth application-default login ``` You don't need to do this if you're using Cloud Shell. If an authentication error is returned, and you are using an external identity provider (IdP), confirm that you have [signed in to the gcloud CLI with your federated identity](https://docs.cloud.google.com/iam/docs/workforce-log-in-gcloud.md.txt). A sign-in screen appears. After you sign in, your credentials are stored in the [local credential file used by ADC](https://docs.cloud.google.com/docs/authentication/application-default-credentials.md.txt#personal). ## Use the client library The following example shows how to use the client library. ### C++ ```c++ #include "google/cloud/spanner/client.h" void Quickstart(std::string const& project_id, std::string const& instance_id, std::string const& database_id) { namespace spanner = ::google::cloud::spanner; auto database = spanner::Database(project_id, instance_id, database_id); auto connection = spanner::MakeConnection(database); auto client = spanner::Client(connection); auto rows = client.ExecuteQuery(spanner::SqlStatement("SELECT 'Hello World'")); using RowType = std::tuple; for (auto& row : spanner::StreamOf(rows)) { if (!row) throw std::move(row).status(); std::cout << std::get<0>(*row) << "\n"; } } ``` ### C# ```c# using Google.Cloud.Spanner.Data; using System; using System.Threading.Tasks; namespace GoogleCloudSamples.Spanner { public class QuickStart { static async Task MainAsync() { string projectId = "YOUR-PROJECT-ID"; string instanceId = "my-instance"; string databaseId = "my-database"; string connectionString = $"Data Source=projects/{projectId}/instances/{instanceId}/" + $"databases/{databaseId}"; // Create connection to Cloud Spanner. using (var connection = new SpannerConnection(connectionString)) { // Execute a simple SQL statement. var cmd = connection.CreateSelectCommand( @"SELECT ""Hello World"" as test"); using (var reader = await cmd.ExecuteReaderAsync()) { while (await reader.ReadAsync()) { Console.WriteLine( reader.GetFieldValue("test")); } } } } public static void Main(string[] args) { MainAsync().Wait(); } } } ``` ### Go ```go // Sample spanner_quickstart is a basic program that uses Cloud Spanner. package main import ( "context" "fmt" "log" "cloud.google.com/go/spanner" "google.golang.org/api/iterator" ) func main() { ctx := context.Background() // This database must exist. databaseName := "projects/your-project-id/instances/your-instance-id/databases/your-database-id" client, err := spanner.NewClient(ctx, databaseName) if err != nil { log.Fatalf("Failed to create client %v", err) } defer client.Close() stmt := spanner.Statement{SQL: "SELECT 1"} iter := client.Single().Query(ctx, stmt) defer iter.Stop() for { row, err := iter.Next() if err == iterator.Done { fmt.Println("Done") return } if err != nil { log.Fatalf("Query failed with %v", err) } var i int64 if row.Columns(&i) != nil { log.Fatalf("Failed to parse row %v", err) } fmt.Printf("Got value %v\n", i) } } ``` ### Java ```java // Imports the Google Cloud client library import com.google.cloud.spanner.DatabaseClient; import com.google.cloud.spanner.DatabaseId; import com.google.cloud.spanner.ResultSet; import com.google.cloud.spanner.Spanner; import com.google.cloud.spanner.SpannerOptions; import com.google.cloud.spanner.Statement; /** * A quick start code for Cloud Spanner. It demonstrates how to setup the Cloud Spanner client and * execute a simple query using it against an existing database. */ public class QuickstartSample { public static void main(String... args) throws Exception { if (args.length != 2) { System.err.println("Usage: QuickStartSample "); return; } // Instantiates a client SpannerOptions options = SpannerOptions.newBuilder().build(); Spanner spanner = options.getService(); // Name of your instance & database. String instanceId = args[0]; String databaseId = args[1]; try { // Creates a database client DatabaseClient dbClient = spanner.getDatabaseClient(DatabaseId.of(options.getProjectId(), instanceId, databaseId)); // Queries the database ResultSet resultSet = dbClient.singleUse().executeQuery(Statement.of("SELECT 1")); System.out.println("\n\nResults:"); // Prints the results while (resultSet.next()) { System.out.printf("%d\n\n", resultSet.getLong(0)); } } finally { // Closes the client which will free up the resources used spanner.close(); } } } ``` ### Node.js ```javascript // Imports the Google Cloud client library const {Spanner} = require('@google-cloud/spanner'); // Creates a client const spanner = new Spanner({projectId}); // Gets a reference to a Cloud Spanner instance and database const instance = spanner.instance(instanceId); const database = instance.database(databaseId); // The query to execute const query = { sql: 'SELECT 1', }; // Execute a simple SQL statement const [rows] = await database.run(query); console.log(`Query: ${rows.length} found.`); rows.forEach(row => console.log(row)); ``` ### PHP ```php # Includes the autoloader for libraries installed with composer require __DIR__ . '/vendor/autoload.php'; # Imports the Google Cloud client library use Google\Cloud\Spanner\SpannerClient; # Your Google Cloud Platform project ID $projectId = 'YOUR_PROJECT_ID'; # Instantiates a client $spanner = new SpannerClient([ 'projectId' => $projectId ]); # Your Cloud Spanner instance ID. $instanceId = 'your-instance-id'; # Get a Cloud Spanner instance by ID. $instance = $spanner->instance($instanceId); # Your Cloud Spanner database ID. $databaseId = 'your-database-id'; # Get a Cloud Spanner database by ID. $database = $instance->database($databaseId); # Execute a simple SQL statement. $results = $database->execute('SELECT "Hello World" as test'); foreach ($results as $row) { print($row['test'] . PHP_EOL); } ``` ### Python ```python # Imports the Google Cloud Client Library. from google.cloud import spanner # Your Cloud Spanner instance ID. # instance_id = "my-instance-id" # # Your Cloud Spanner database ID. # database_id = "my-database-id" # Instantiate a client. spanner_client = spanner.Client() # Get a Cloud Spanner instance by ID. instance = spanner_client.instance(instance_id) # Get a Cloud Spanner database by ID. database = instance.database(database_id) # Execute a simple SQL statement. with database.snapshot() as snapshot: results = snapshot.execute_sql("SELECT 1") for row in results: print(row) ``` ### Ruby ```ruby # Imports the Google Cloud client library require "google/cloud/spanner" # Your Google Cloud Platform project ID project_id = "YOUR_PROJECT_ID" # Instantiates a client spanner = Google::Cloud::Spanner.new project: project_id # Your Cloud Spanner instance ID instance_id = "my-instance" # Your Cloud Spanner database ID database_id = "my-database" # Gets a reference to a Cloud Spanner instance database database_client = spanner.client instance_id, database_id # Execute a simple SQL statement results = database_client.execute_query "SELECT 1" results.rows.each do |row| puts row end ``` ### Rust ```rust use google_cloud_spanner::client::{DatabaseClient, Spanner}; use google_cloud_spanner_admin_database_v1::client::DatabaseAdmin; pub async fn sample(database_name: &str) -> anyhow::Result<(DatabaseClient, DatabaseAdmin)> { // The builder automatically handles SPANNER_EMULATOR_HOST if set in the environment. let client = Spanner::builder().build().await?; // Creates a client that can be used to execute queries and transactions on a specific database. let database_client = client.database_client(database_name).build().await?; // Creates a client that can be used to execute DDL and other administrative operations on databases. let admin_client = client.database_admin_builder().build().await?; Ok((database_client, admin_client)) } ```
## Use the client library for administrator operations The following list contains links to all the administrator operations you can use in the Spanner client library: - [Create and manage instance configuration](https://docs.cloud.google.com/spanner/docs/create-manage-configurations.md.txt) - [Create and manage instances](https://docs.cloud.google.com/spanner/docs/create-manage-instances.md.txt) - [Create and manage databases](https://docs.cloud.google.com/spanner/docs/create-manage-databases.md.txt) - [Secure a database with customer-managed encryption keys (CMEK)](https://docs.cloud.google.com/spanner/docs/use-cmek.md.txt) - [Configure fine-grained access control](https://docs.cloud.google.com/spanner/docs/configure-fgac.md.txt) - [Backup and restore databases using client libraries](https://docs.cloud.google.com/spanner/docs/backup/libraries) - [Recover data using point-in-time recovery (PITR)](https://docs.cloud.google.com/spanner/docs/use-pitr.md.txt#client-libraries) - [Prevent accidental database deletion](https://docs.cloud.google.com/spanner/docs/prevent-database-deletion.md.txt#client-libraries) - [Create and manage sequences](https://docs.cloud.google.com/spanner/docs/sequence-tasks.md.txt) - [Modify the leader region of a database](https://docs.cloud.google.com/spanner/docs/modifying-leader-region.md.txt#client-libraries) - Work with [NUMERIC](https://docs.cloud.google.com/spanner/docs/working-with-numerics.md.txt), [JSON](https://docs.cloud.google.com/spanner/docs/working-with-json.md.txt), and [JSONB](https://docs.cloud.google.com/spanner/docs/working-with-jsonb.md.txt) data types ## Use Spanner Graph with client libraries You can use client libraries to setup, modify, and query property graphs in Spanner Graph. The following list contains links to learn about and get started with Spanner Graph using client libraries: - [Learn about Spanner Graph](https://docs.cloud.google.com/spanner/docs/graph/overview.md.txt) - [Set up and query Spanner Graph](https://docs.cloud.google.com/spanner/docs/graph/set-up.md.txt) - [Insert, update, or delete Spanner Graph data](https://docs.cloud.google.com/spanner/docs/graph/insert-update-delete-data.md.txt)
## Additional resources ### C++ The following list contains links to more resources related to the client library for C++: - [API reference](https://docs.cloud.google.com/cpp/docs/reference/spanner/latests) - [Client libraries best practices](https://docs.cloud.google.com/apis/docs/client-libraries-best-practices.md.txt) - [Issue tracker](https://github.com/googleapis/google-cloud-cpp/issues) - [`google-cloud-spanner` on Stack Overflow](https://stackoverflow.com/search?q=%5Bgoogle-cloud-spanner%5D%5Bc%2B%2B%5D) - [Source code](https://github.com/googleapis/google-cloud-cpp) - [Getting started in C++](https://docs.cloud.google.com/spanner/docs/getting-started/cpp.md.txt) ### C# The following list contains links to more resources related to the client library for C#: - [API reference](https://docs.cloud.google.com/dotnet/docs/reference.md.txt) - [Client libraries best practices](https://docs.cloud.google.com/apis/docs/client-libraries-best-practices.md.txt) - [Issue tracker](https://github.com/googleapis/google-cloud-dotnet/issues) - [`google-cloud-spanner` on Stack Overflow](https://stackoverflow.com/search?q=%5Bgoogle-cloud-spanner%5D+%5Bc%23%5D) - [Source code](https://github.com/googleapis/google-cloud-dotnet) - [Getting started in C#](https://docs.cloud.google.com/spanner/docs/getting-started/csharp.md.txt) ### Go The following list contains links to more resources related to the client library for Go: - [API reference](https://pkg.go.dev/cloud.google.com/go/spanner/) - [Client libraries best practices](https://docs.cloud.google.com/apis/docs/client-libraries-best-practices.md.txt) - [Issue tracker](https://github.com/googleapis/google-cloud-go/issues) - [`google-cloud-spanner` on Stack Overflow](https://stackoverflow.com/search?q=%5Bgoogle-cloud-spanner%5D+%5Bgo%5D) - [Source code](https://github.com/googleapis/google-cloud-go) - [Getting started in Go](https://docs.cloud.google.com/spanner/docs/getting-started/go.md.txt) ### Java The following list contains links to more resources related to the client library for Java: - [API reference](https://cloud.google.com/java/docs/reference/google-cloud-spanner/latest/overview) - [Client libraries best practices](https://docs.cloud.google.com/apis/docs/client-libraries-best-practices.md.txt) - [Issue tracker](https://github.com/googleapis/google-cloud-java/tree/main/java-spanner/issues) - [`google-cloud-spanner` on Stack Overflow](https://stackoverflow.com/search?q=%5Bgoogle-cloud-spanner%5D+%5Bjava%5D) - [Source code](https://github.com/googleapis/google-cloud-java/tree/main/java-spanner) - [Getting started in Java](https://docs.cloud.google.com/spanner/docs/getting-started/java.md.txt) ### Node.js The following list contains links to more resources related to the client library for Node.js: - [API reference](https://googleapis.dev/nodejs/spanner/latest) - [Client libraries best practices](https://docs.cloud.google.com/apis/docs/client-libraries-best-practices.md.txt) - [Issue tracker](https://github.com/googleapis/google-cloud-node/tree/main/packages/spanner/issues) - [`google-cloud-spanner` on Stack Overflow](https://stackoverflow.com/search?q=%5Bgoogle-cloud-spanner%5D+%5Bnode.js%5D) - [Source code](https://github.com/googleapis/google-cloud-node/tree/main/packages/spanner) - [Getting started in Node.js](https://docs.cloud.google.com/spanner/docs/getting-started/nodejs.md.txt) ### PHP The following list contains links to more resources related to the client library for PHP: - [API reference](https://docs.cloud.google.com/php/docs/reference/cloud-spanner/latest/readme) - [Client libraries best practices](https://docs.cloud.google.com/apis/docs/client-libraries-best-practices.md.txt) - [Issue tracker](https://github.com/googleapis/google-cloud-php/issues) - [`google-cloud-spanner` on Stack Overflow](https://stackoverflow.com/search?q=%5Bgoogle-cloud-spanner%5D+%5Bphp%5D) - [Source code](https://github.com/googleapis/google-cloud-php) - [Getting started in PHP](https://docs.cloud.google.com/spanner/docs/getting-started/php.md.txt) ### Python The following list contains links to more resources related to the client library for Python: - [API reference](https://docs.cloud.google.com/python/docs/reference/spanner/latest.md.txt) - [Client libraries best practices](https://docs.cloud.google.com/apis/docs/client-libraries-best-practices.md.txt) - [Issue tracker](https://github.com/googleapis/google-cloud-python/tree/main/packages/google-cloud-spanner/issues) - [`google-cloud-spanner` on Stack Overflow](https://stackoverflow.com/search?q=%5Bgoogle-cloud-spanner%5D+%5Bpython%5D) - [Source code](https://github.com/googleapis/google-cloud-python/tree/main/packages/google-cloud-spanner) - [Getting started in Python](https://docs.cloud.google.com/spanner/docs/getting-started/python.md.txt) ### Ruby The following list contains links to more resources related to the client library for Ruby: - [API reference](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-spanner/latest.md.txt) - [Client libraries best practices](https://docs.cloud.google.com/apis/docs/client-libraries-best-practices.md.txt) - [Issue tracker](https://github.com/googleapis/google-cloud-ruby/issues) - [`google-cloud-spanner` on Stack Overflow](https://stackoverflow.com/search?q=%5Bgoogle-cloud-spanner%5D+%5Bruby%5D) - [Source code](https://github.com/googleapis/google-cloud-ruby) - [Getting started in Ruby](https://docs.cloud.google.com/spanner/docs/getting-started/ruby.md.txt) ### Rust The following list contains links to more resources related to the client library for Rust: - [API reference](https://docs.rs/google-cloud-spanner/latest/google_cloud_spanner/) - [Client libraries best practices](https://docs.cloud.google.com/apis/docs/client-libraries-best-practices.md.txt) - [Issue tracker](https://github.com/googleapis/google-cloud-rust/issues) - [`google-cloud-spanner` on Stack Overflow](https://stackoverflow.com/search?q=%5Bgoogle-cloud-spanner%5D+%5Brust%5D) - [Source code](https://github.com/googleapis/google-cloud-rust) - [Getting started in Rust](https://docs.cloud.google.com/spanner/docs/getting-started/rust)
## Additional client libraries In addition to the libraries shown above, a [Spring Data](https://spring.io/projects/spring-data) module is available for Java applications. Spring Data Spanner helps you use Spanner in any application that's built with the [Spring Framework](https://spring.io/projects/spring-framework). To get started, learn how to [add Spring Data Spanner to your application](https://docs.cloud.google.com/spanner/docs/adding-spring).