google-cloud-spanner overview (6.60.0)

A client for Cloud Spanner - A no-compromise relational database service. See Also: Cloud Spanner

A client to Cloud Spanner API

The interfaces provided are listed below, along with usage samples.

DatabaseAdminClient

Service Description: Cloud Spanner Database Admin API

The Cloud Spanner Database Admin API can be used to: * create, drop, and list databases * update the schema of pre-existing databases * create, delete and list backups for a database * restore a database from an existing backup

Sample for DatabaseAdminClient:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
   DatabaseName name = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]");
   Database response = databaseAdminClient.getDatabase(name);
 }
 

com.google.cloud.spanner.admin.database.v1.stub

com.google.cloud.spanner.admin.instance.v1

A client to Cloud Spanner Instance Admin API

The interfaces provided are listed below, along with usage samples.

InstanceAdminClient

Service Description: Cloud Spanner Instance Admin API

The Cloud Spanner Instance Admin API can be used to create, delete, modify and list instances. Instances are dedicated Cloud Spanner serving and storage resources to be used by Cloud Spanner databases.

Each instance has a "configuration", which dictates where the serving resources for the Cloud Spanner instance are located (e.g., US-central, Europe). Configurations are created by Google based on resource availability.

Cloud Spanner billing is based on the instances that exist and their sizes. After an instance exists, there are no additional per-database or per-operation charges for use of the instance (though there may be additional network bandwidth charges). Instances offer isolation: problems with databases in one instance will not affect other instances. However, within an instance databases can affect each other. For example, if one database in an instance receives a lot of requests and consumes most of the instance resources, fewer resources are available for other databases in that instance, and their performance may suffer.

Sample for InstanceAdminClient:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
   InstanceConfigName name = InstanceConfigName.of("[PROJECT]", "[INSTANCE_CONFIG]");
   InstanceConfig response = instanceAdminClient.getInstanceConfig(name);
 }
 

com.google.cloud.spanner.admin.instance.v1.stub

com.google.cloud.spanner.connection

Internal API for Google Cloud Spanner. This API may introduce breaking changes without prior notice.

com.google.cloud.spanner.encryption

com.google.cloud.spanner.executor.v1

A client to Cloud Spanner Executor test API

The interfaces provided are listed below, along with usage samples.

SpannerExecutorProxyClient

Service Description: Service that executes SpannerActions asynchronously.

Sample for SpannerExecutorProxyClient:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SpannerExecutorProxyClient spannerExecutorProxyClient =
     SpannerExecutorProxyClient.create()) {
   BidiStream<SpannerAsyncActionRequest, SpannerAsyncActionResponse> bidiStream =
       spannerExecutorProxyClient.executeActionAsyncCallable().call();
   SpannerAsyncActionRequest request =
       SpannerAsyncActionRequest.newBuilder()
           .setActionId(198295492)
           .setAction(SpannerAction.newBuilder().build())
           .build();
   bidiStream.send(request);
   for (SpannerAsyncActionResponse response : bidiStream) {
     // Do something when a response is received.
   }
 }
 

com.google.cloud.spanner.executor.v1.stub

com.google.cloud.spanner.spi

com.google.cloud.spanner.spi.v1

com.google.cloud.spanner.testing

com.google.cloud.spanner.v1

A client to Cloud Spanner API

The interfaces provided are listed below, along with usage samples.

SpannerClient

Service Description: Cloud Spanner API

The Cloud Spanner API can be used to manage sessions and execute transactions on data stored in Cloud Spanner databases.

Sample for SpannerClient:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SpannerClient spannerClient = SpannerClient.create()) {
   DatabaseName database = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]");
   Session response = spannerClient.createSession(database);
 }
 

com.google.cloud.spanner.v1.stub

com.google.spanner.admin.database.v1

com.google.spanner.admin.instance.v1

com.google.spanner.executor.v1

com.google.spanner.v1