com.google.cloud.spanner.spi

Interface SpannerRpc

All Known Implementing Classes:

DefaultSpannerRpc

public interface SpannerRpc

Abstracts remote calls to the Cloud Spanner service. Typically end-consumer code will never use this interface; it's main purpose is to abstract the implementation of the public Cloud Spanner API from the underlying transport mechanism.

Each SpannerRPC instance is bound to a particular project and set of authorization credentials.

The interface is currently defined in terms of the generated HTTP client model classes. This is purely for expedience; a future version of this interface is likely to be independent of transport to allow switching between gRPC and HTTP.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SpannerRpc.Option Options passed in SpannerRpc methods to control how an RPC is issued.
static class	SpannerRpc.Paginated<T> Represents results from paginated RPCs, i.e., those where up to a maximum number of items is returned from each call and a followup call must be made to fetch more.
static interface	SpannerRpc.ResultStreamConsumer Consumer for the results produced by a streaming read or query call.
static interface	SpannerRpc.StreamingCall Handle for cancellation of a streaming read or query call.

Method Summary

Modifier and Type	Method and Description
com.google.spanner.v1.Transaction	beginTransaction(com.google.spanner.v1.BeginTransactionRequest request, Map<SpannerRpc.Option,?> options)
com.google.spanner.v1.CommitResponse	commit(com.google.spanner.v1.CommitRequest commitRequest, Map<SpannerRpc.Option,?> options)
com.google.longrunning.Operation	createDatabase(String instanceName, String createDatabaseStatement, Iterable<String> additionalStatements)
com.google.longrunning.Operation	createInstance(String parent, String instanceId, com.google.spanner.admin.instance.v1.Instance instance)
com.google.spanner.v1.Session	createSession(String databaseName, Map<SpannerRpc.Option,?> options)
void	deleteInstance(String instanceName)
void	deleteSession(String sessionName, Map<SpannerRpc.Option,?> options)
void	dropDatabase(String databaseName)
SpannerRpc.StreamingCall	executeQuery(com.google.spanner.v1.ExecuteSqlRequest request, SpannerRpc.ResultStreamConsumer consumer, Map<SpannerRpc.Option,?> options)
com.google.spanner.admin.database.v1.Database	getDatabase(String databaseName)
List<String>	getDatabaseDdl(String databaseName)
com.google.spanner.admin.instance.v1.Instance	getInstance(String instanceName)
com.google.spanner.admin.instance.v1.InstanceConfig	getInstanceConfig(String instanceConfigName)
com.google.longrunning.Operation	getOperation(String name) Retrieves a long running operation.
SpannerRpc.Paginated<com.google.spanner.admin.database.v1.Database>	listDatabases(String instanceName, int pageSize, String pageToken)
SpannerRpc.Paginated<com.google.spanner.admin.instance.v1.InstanceConfig>	listInstanceConfigs(int pageSize, String pageToken)
SpannerRpc.Paginated<com.google.spanner.admin.instance.v1.Instance>	listInstances(int pageSize, String pageToken, String filter)
SpannerRpc.StreamingCall	read(com.google.spanner.v1.ReadRequest request, SpannerRpc.ResultStreamConsumer consumer, Map<SpannerRpc.Option,?> options)
void	rollback(com.google.spanner.v1.RollbackRequest request, Map<SpannerRpc.Option,?> options)
com.google.longrunning.Operation	updateDatabaseDdl(String databaseName, Iterable<String> updateDatabaseStatements, String updateId)
com.google.longrunning.Operation	updateInstance(com.google.spanner.admin.instance.v1.Instance instance, com.google.protobuf.FieldMask fieldMask)

Method Detail

listInstanceConfigs

SpannerRpc.Paginated<com.google.spanner.admin.instance.v1.InstanceConfig> listInstanceConfigs(int pageSize,
                                                                                              @Nullable
                                                                                              String pageToken)
                                                                                       throws SpannerException

Throws:

SpannerException

getInstanceConfig

com.google.spanner.admin.instance.v1.InstanceConfig getInstanceConfig(String instanceConfigName)
                                                               throws SpannerException

Throws:

SpannerException

listInstances

SpannerRpc.Paginated<com.google.spanner.admin.instance.v1.Instance> listInstances(int pageSize,
                                                                                  @Nullable
                                                                                  String pageToken,
                                                                                  @Nullable
                                                                                  String filter)
                                                                           throws SpannerException

Throws:

SpannerException

createInstance

com.google.longrunning.Operation createInstance(String parent,
                                                String instanceId,
                                                com.google.spanner.admin.instance.v1.Instance instance)
                                         throws SpannerException

Throws:

SpannerException

updateInstance

com.google.longrunning.Operation updateInstance(com.google.spanner.admin.instance.v1.Instance instance,
                                                com.google.protobuf.FieldMask fieldMask)
                                         throws SpannerException

Throws:

SpannerException

getInstance

com.google.spanner.admin.instance.v1.Instance getInstance(String instanceName)
                                                   throws SpannerException

Throws:

SpannerException

deleteInstance

void deleteInstance(String instanceName)
             throws SpannerException

Throws:

SpannerException

listDatabases

SpannerRpc.Paginated<com.google.spanner.admin.database.v1.Database> listDatabases(String instanceName,
                                                                                  int pageSize,
                                                                                  @Nullable
                                                                                  String pageToken)
                                                                           throws SpannerException

Throws:

SpannerException

createDatabase

com.google.longrunning.Operation createDatabase(String instanceName,
                                                String createDatabaseStatement,
                                                Iterable<String> additionalStatements)
                                         throws SpannerException

Throws:

SpannerException

updateDatabaseDdl

com.google.longrunning.Operation updateDatabaseDdl(String databaseName,
                                                   Iterable<String> updateDatabaseStatements,
                                                   @Nullable
                                                   String updateId)
                                            throws SpannerException

Throws:

SpannerException

dropDatabase

void dropDatabase(String databaseName)
           throws SpannerException

Throws:

SpannerException

getDatabase

com.google.spanner.admin.database.v1.Database getDatabase(String databaseName)
                                                   throws SpannerException

Throws:

SpannerException

getDatabaseDdl

List<String> getDatabaseDdl(String databaseName)
                     throws SpannerException

Throws:

SpannerException

getOperation

com.google.longrunning.Operation getOperation(String name)
                                       throws SpannerException

Retrieves a long running operation.

Throws:

SpannerException

createSession

com.google.spanner.v1.Session createSession(String databaseName,
                                            @Nullable
                                            Map<SpannerRpc.Option,?> options)
                                     throws SpannerException

Throws:

SpannerException

deleteSession

void deleteSession(String sessionName,
                   @Nullable
                   Map<SpannerRpc.Option,?> options)
            throws SpannerException

Throws:

SpannerException

read

SpannerRpc.StreamingCall read(com.google.spanner.v1.ReadRequest request,
                              SpannerRpc.ResultStreamConsumer consumer,
                              @Nullable
                              Map<SpannerRpc.Option,?> options)

executeQuery

SpannerRpc.StreamingCall executeQuery(com.google.spanner.v1.ExecuteSqlRequest request,
                                      SpannerRpc.ResultStreamConsumer consumer,
                                      @Nullable
                                      Map<SpannerRpc.Option,?> options)

beginTransaction

com.google.spanner.v1.Transaction beginTransaction(com.google.spanner.v1.BeginTransactionRequest request,
                                                   @Nullable
                                                   Map<SpannerRpc.Option,?> options)
                                            throws SpannerException

Throws:

SpannerException

commit

com.google.spanner.v1.CommitResponse commit(com.google.spanner.v1.CommitRequest commitRequest,
                                            @Nullable
                                            Map<SpannerRpc.Option,?> options)
                                     throws SpannerException

Throws:

SpannerException

rollback

void rollback(com.google.spanner.v1.RollbackRequest request,
              @Nullable
              Map<SpannerRpc.Option,?> options)
       throws SpannerException

Throws:

SpannerException