com.google.cloud.spanner.spi.v1

Class GapicSpannerRpc

java.lang.Object

com.google.cloud.spanner.spi.v1.GapicSpannerRpc

All Implemented Interfaces:

ServiceRpc, SpannerRpc

public class GapicSpannerRpc
extends Object
implements SpannerRpc

Implementation of Cloud Spanner remote calls using Gapic libraries.

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.cloud.spanner.spi.v1.SpannerRpc

SpannerRpc.Option, SpannerRpc.Paginated<T>, SpannerRpc.ResultStreamConsumer, SpannerRpc.StreamingCall

Constructor Summary

Constructors

Constructor and Description
GapicSpannerRpc(SpannerOptions options)

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)
static GapicSpannerRpc	create(SpannerOptions 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 request, 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)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GapicSpannerRpc

public GapicSpannerRpc(SpannerOptions options)

Method Detail

create

public static GapicSpannerRpc create(SpannerOptions options)

listInstanceConfigs

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

Specified by:

listInstanceConfigs in interface SpannerRpc

Throws:

SpannerException

getInstanceConfig

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

Specified by:

getInstanceConfig in interface SpannerRpc

Throws:

SpannerException

listInstances

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

Specified by:

listInstances in interface SpannerRpc

Throws:

SpannerException

createInstance

public 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

Specified by:

createInstance in interface SpannerRpc

Throws:

SpannerException

updateInstance

public 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

Specified by:

updateInstance in interface SpannerRpc

Throws:

SpannerException

getInstance

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

Specified by:

getInstance in interface SpannerRpc

Throws:

SpannerException

deleteInstance

public void deleteInstance(String instanceName)
                    throws SpannerException

Specified by:

deleteInstance in interface SpannerRpc

Throws:

SpannerException

listDatabases

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

Specified by:

listDatabases in interface SpannerRpc

Throws:

SpannerException

createDatabase

public 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

Specified by:

createDatabase in interface SpannerRpc

Throws:

SpannerException

updateDatabaseDdl

public OperationFuture<Empty,com.google.spanner.admin.database.v1.UpdateDatabaseDdlMetadata> updateDatabaseDdl(String databaseName,
                                                                                                               Iterable<String> updateDatabaseStatements,
                                                                                                               @Nullable
                                                                                                               String updateId)
                                                                                                        throws SpannerException

Specified by:

updateDatabaseDdl in interface SpannerRpc

Throws:

SpannerException

dropDatabase

public void dropDatabase(String databaseName)
                  throws SpannerException

Specified by:

dropDatabase in interface SpannerRpc

Throws:

SpannerException

getDatabase

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

Specified by:

getDatabase in interface SpannerRpc

Throws:

SpannerException

getDatabaseDdl

public List<String> getDatabaseDdl(String databaseName)
                            throws SpannerException

Specified by:

getDatabaseDdl in interface SpannerRpc

Throws:

SpannerException

getOperation

public Operation getOperation(String name)
                       throws SpannerException

Description copied from interface: SpannerRpc

Retrieves a long running operation.

Specified by:

getOperation in interface SpannerRpc

Throws:

SpannerException

createSession

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

Specified by:

createSession in interface SpannerRpc

Throws:

SpannerException

deleteSession

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

Specified by:

deleteSession in interface SpannerRpc

Throws:

SpannerException

read

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

Specified by:

read in interface SpannerRpc

executeQuery

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

Specified by:

executeQuery in interface SpannerRpc

executeQuery

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

Specified by:

executeQuery in interface SpannerRpc

executeBatchDml

public com.google.spanner.v1.ExecuteBatchDmlResponse executeBatchDml(com.google.spanner.v1.ExecuteBatchDmlRequest request,
                                                                     @Nullable
                                                                     Map<SpannerRpc.Option,?> options)

Specified by:

executeBatchDml in interface SpannerRpc

beginTransaction

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

Specified by:

beginTransaction in interface SpannerRpc

Throws:

SpannerException

commit

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

Specified by:

commit in interface SpannerRpc

Throws:

SpannerException

rollback

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

Specified by:

rollback in interface SpannerRpc

Throws:

SpannerException

partitionQuery

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

Specified by:

partitionQuery in interface SpannerRpc

Throws:

SpannerException

partitionRead

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

Specified by:

partitionRead in interface SpannerRpc

Throws:

SpannerException

shutdown

public void shutdown()

Specified by:

shutdown in interface SpannerRpc