com.google.cloud.spanner.spi.v1

Interface SpannerRpc

All Superinterfaces:

ServiceRpc

All Known Implementing Classes:

GapicSpannerRpc

public interface SpannerRpc
extends ServiceRpc

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)
OperationFuture<com.google.spanner.admin.database.v1.Database,com.google.spanner.admin.database.v1.CreateDatabaseMetadata>	createDatabase(String instanceName, String createDatabaseStatement, Iterable<String> additionalStatements)
OperationFuture<com.google.spanner.admin.instance.v1.Instance,com.google.spanner.admin.instance.v1.CreateInstanceMetadata>	createInstance(String parent, String instanceId, com.google.spanner.admin.instance.v1.Instance instance)
com.google.spanner.v1.Session	createSession(String databaseName, Map<String,String> labels, Map<SpannerRpc.Option,?> options)
void	deleteInstance(String instanceName)
void	deleteSession(String sessionName, Map<SpannerRpc.Option,?> options)
void	dropDatabase(String databaseName)
com.google.spanner.v1.ExecuteBatchDmlResponse	executeBatchDml(com.google.spanner.v1.ExecuteBatchDmlRequest build, Map<SpannerRpc.Option,?> options)
com.google.spanner.v1.ResultSet	executeQuery(com.google.spanner.v1.ExecuteSqlRequest request, Map<SpannerRpc.Option,?> options)
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)
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)
com.google.spanner.v1.PartitionResponse	partitionQuery(com.google.spanner.v1.PartitionQueryRequest request, Map<SpannerRpc.Option,?> options)
com.google.spanner.v1.PartitionResponse	partitionRead(com.google.spanner.v1.PartitionReadRequest request, Map<SpannerRpc.Option,?> options)
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)
void	shutdown()
OperationFuture<Empty,com.google.spanner.admin.database.v1.UpdateDatabaseDdlMetadata>	updateDatabaseDdl(String databaseName, Iterable<String> updateDatabaseStatements, String updateId)
OperationFuture<com.google.spanner.admin.instance.v1.Instance,com.google.spanner.admin.instance.v1.UpdateInstanceMetadata>	updateInstance(com.google.spanner.admin.instance.v1.Instance instance, 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

OperationFuture<com.google.spanner.admin.instance.v1.Instance,com.google.spanner.admin.instance.v1.CreateInstanceMetadata> createInstance(String parent,
                                                                                                                                          String instanceId,
                                                                                                                                          com.google.spanner.admin.instance.v1.Instance instance)
                                                                                                                                   throws SpannerException

Throws:

SpannerException

updateInstance

OperationFuture<com.google.spanner.admin.instance.v1.Instance,com.google.spanner.admin.instance.v1.UpdateInstanceMetadata> updateInstance(com.google.spanner.admin.instance.v1.Instance instance,
                                                                                                                                          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

OperationFuture<com.google.spanner.admin.database.v1.Database,com.google.spanner.admin.database.v1.CreateDatabaseMetadata> createDatabase(String instanceName,
                                                                                                                                          String createDatabaseStatement,
                                                                                                                                          Iterable<String> additionalStatements)
                                                                                                                                   throws SpannerException

Throws:

SpannerException

updateDatabaseDdl

OperationFuture<Empty,com.google.spanner.admin.database.v1.UpdateDatabaseDdlMetadata> 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

Operation getOperation(String name)
                throws SpannerException

Retrieves a long running operation.

Throws:

SpannerException

createSession

com.google.spanner.v1.Session createSession(String databaseName,
                                            @Nullable
                                            Map<String,String> labels,
                                            @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

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

executeQuery

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

executeBatchDml

com.google.spanner.v1.ExecuteBatchDmlResponse executeBatchDml(com.google.spanner.v1.ExecuteBatchDmlRequest build,
                                                              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

partitionQuery

com.google.spanner.v1.PartitionResponse partitionQuery(com.google.spanner.v1.PartitionQueryRequest request,
                                                       @Nullable
                                                       Map<SpannerRpc.Option,?> options)
                                                throws SpannerException

Throws:

SpannerException

partitionRead

com.google.spanner.v1.PartitionResponse partitionRead(com.google.spanner.v1.PartitionReadRequest request,
                                                      @Nullable
                                                      Map<SpannerRpc.Option,?> options)
                                               throws SpannerException

Throws:

SpannerException

shutdown

void shutdown()