com.google.cloud.spanner.spi.v1

Interface SpannerRpc

All Superinterfaces:

com.google.cloud.ServiceRpc

All Known Implementing Classes:

GapicSpannerRpc

@InternalApi
public interface SpannerRpc
extends com.google.cloud.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.api.core.ApiFuture<Empty>	asyncDeleteSession(String sessionName, Map<SpannerRpc.Option,?> options)
List<Session>	batchCreateSessions(String databaseName, int sessionCount, Map<String,String> labels, Map<SpannerRpc.Option,?> options)
Transaction	beginTransaction(BeginTransactionRequest request, Map<SpannerRpc.Option,?> options)
com.google.api.core.ApiFuture<Transaction>	beginTransactionAsync(BeginTransactionRequest request, Map<SpannerRpc.Option,?> options)
void	cancelOperation(String name) Cancels the specified long-running operation.
CommitResponse	commit(CommitRequest commitRequest, Map<SpannerRpc.Option,?> options)
com.google.api.core.ApiFuture<CommitResponse>	commitAsync(CommitRequest commitRequest, Map<SpannerRpc.Option,?> options)
default OperationFuture<Backup,CopyBackupMetadata>	copyBackup(BackupId sourceBackupId, Backup destinationBackup) Creates a copy backup from the source backup specified.
OperationFuture<Backup,CreateBackupMetadata>	createBackup(Backup backupInfo) Creates a new backup from the source database specified in the Backup instance.
OperationFuture<Database,CreateDatabaseMetadata>	createDatabase(String instanceName, String createDatabaseStatement, Iterable<String> additionalStatements, Database database)
OperationFuture<Instance,CreateInstanceMetadata>	createInstance(String parent, String instanceId, Instance instance)
Session	createSession(String databaseName, Map<String,String> labels, Map<SpannerRpc.Option,?> options)
void	deleteBackup(String backupName) Deletes a pending or completed backup.
void	deleteInstance(String instanceName)
void	deleteSession(String sessionName, Map<SpannerRpc.Option,?> options)
void	dropDatabase(String databaseName)
ExecuteBatchDmlResponse	executeBatchDml(ExecuteBatchDmlRequest build, Map<SpannerRpc.Option,?> options)
com.google.api.core.ApiFuture<ExecuteBatchDmlResponse>	executeBatchDmlAsync(ExecuteBatchDmlRequest build, Map<SpannerRpc.Option,?> options)
ResultSet	executePartitionedDml(ExecuteSqlRequest request, Map<SpannerRpc.Option,?> options)
ResultSet	executeQuery(ExecuteSqlRequest request, Map<SpannerRpc.Option,?> options)
SpannerRpc.StreamingCall	executeQuery(ExecuteSqlRequest request, SpannerRpc.ResultStreamConsumer consumer, Map<SpannerRpc.Option,?> options)
com.google.api.core.ApiFuture<ResultSet>	executeQueryAsync(ExecuteSqlRequest request, Map<SpannerRpc.Option,?> options)
ServerStream<PartialResultSet>	executeStreamingPartitionedDml(ExecuteSqlRequest request, Map<SpannerRpc.Option,?> options, org.threeten.bp.Duration timeout)
Backup	getBackup(String backupName) Gets the backup with the specified name.
Database	getDatabase(String databaseName)
com.google.iam.v1.Policy	getDatabaseAdminIAMPolicy(String resource) Gets the IAM policy for the given resource using the DatabaseAdminStub.
List<String>	getDatabaseDdl(String databaseName)
Instance	getInstance(String instanceName)
com.google.iam.v1.Policy	getInstanceAdminIAMPolicy(String resource) Gets the IAM policy for the given resource using the InstanceAdminStub.
InstanceConfig	getInstanceConfig(String instanceConfigName)
Operation	getOperation(String name) Retrieves a long running operation.
RetrySettings	getPartitionedDmlRetrySettings()
boolean	isClosed()
SpannerRpc.Paginated<Operation>	listBackupOperations(String instanceName, int pageSize, String filter, String pageToken) List all long-running backup operations on the given instance.
SpannerRpc.Paginated<Backup>	listBackups(String instanceName, int pageSize, String filter, String pageToken) Lists the backups in the specified instance.
SpannerRpc.Paginated<Operation>	listDatabaseOperations(String instanceName, int pageSize, String filter, String pageToken)
SpannerRpc.Paginated<Database>	listDatabases(String instanceName, int pageSize, String pageToken)
SpannerRpc.Paginated<InstanceConfig>	listInstanceConfigs(int pageSize, String pageToken)
SpannerRpc.Paginated<Instance>	listInstances(int pageSize, String pageToken, String filter)
PartitionResponse	partitionQuery(PartitionQueryRequest request, Map<SpannerRpc.Option,?> options)
PartitionResponse	partitionRead(PartitionReadRequest request, Map<SpannerRpc.Option,?> options)
SpannerRpc.StreamingCall	read(ReadRequest request, SpannerRpc.ResultStreamConsumer consumer, Map<SpannerRpc.Option,?> options)
OperationFuture<Database,RestoreDatabaseMetadata>	restoreDatabase(Restore restore) Restore a backup into the given database.
void	rollback(RollbackRequest request, Map<SpannerRpc.Option,?> options)
com.google.api.core.ApiFuture<Empty>	rollbackAsync(RollbackRequest request, Map<SpannerRpc.Option,?> options)
com.google.iam.v1.Policy	setDatabaseAdminIAMPolicy(String resource, com.google.iam.v1.Policy policy) Updates the IAM policy for the given resource using the DatabaseAdminStub.
com.google.iam.v1.Policy	setInstanceAdminIAMPolicy(String resource, com.google.iam.v1.Policy policy) Updates the IAM policy for the given resource using the InstanceAdminStub.
void	shutdown()
com.google.iam.v1.TestIamPermissionsResponse	testDatabaseAdminIAMPermissions(String resource, Iterable<String> permissions) Tests the IAM permissions for the given resource using the DatabaseAdminStub.
com.google.iam.v1.TestIamPermissionsResponse	testInstanceAdminIAMPermissions(String resource, Iterable<String> permissions) Tests the IAM permissions for the given resource using the InstanceAdminStub.
Backup	updateBackup(Backup backup, FieldMask updateMask) Updates the specified backup.
OperationFuture<Empty,UpdateDatabaseDdlMetadata>	updateDatabaseDdl(String databaseName, Iterable<String> updateDatabaseStatements, String updateId)
OperationFuture<Instance,UpdateInstanceMetadata>	updateInstance(Instance instance, FieldMask fieldMask)

Method Detail

listInstanceConfigs

SpannerRpc.Paginated<InstanceConfig> listInstanceConfigs(int pageSize,
                                                         @Nullable
                                                         String pageToken)
                                                  throws SpannerException

Throws:

SpannerException

getInstanceConfig

InstanceConfig getInstanceConfig(String instanceConfigName)
                          throws SpannerException

Throws:

SpannerException

listInstances

SpannerRpc.Paginated<Instance> listInstances(int pageSize,
                                             @Nullable
                                             String pageToken,
                                             @Nullable
                                             String filter)
                                      throws SpannerException

Throws:

SpannerException

createInstance

OperationFuture<Instance,CreateInstanceMetadata> createInstance(String parent,
                                                                String instanceId,
                                                                Instance instance)
                                                         throws SpannerException

Throws:

SpannerException

updateInstance

OperationFuture<Instance,UpdateInstanceMetadata> updateInstance(Instance instance,
                                                                FieldMask fieldMask)
                                                         throws SpannerException

Throws:

SpannerException

getInstance

Instance getInstance(String instanceName)
              throws SpannerException

Throws:

SpannerException

deleteInstance

void deleteInstance(String instanceName)
             throws SpannerException

Throws:

SpannerException

listDatabases

SpannerRpc.Paginated<Database> listDatabases(String instanceName,
                                             int pageSize,
                                             @Nullable
                                             String pageToken)
                                      throws SpannerException

Throws:

SpannerException

createDatabase

OperationFuture<Database,CreateDatabaseMetadata> createDatabase(String instanceName,
                                                                String createDatabaseStatement,
                                                                Iterable<String> additionalStatements,
                                                                Database database)
                                                         throws SpannerException

Throws:

SpannerException

updateDatabaseDdl

OperationFuture<Empty,UpdateDatabaseDdlMetadata> updateDatabaseDdl(String databaseName,
                                                                   Iterable<String> updateDatabaseStatements,
                                                                   @Nullable
                                                                   String updateId)
                                                            throws SpannerException

Throws:

SpannerException

dropDatabase

void dropDatabase(String databaseName)
           throws SpannerException

Throws:

SpannerException

getDatabase

Database getDatabase(String databaseName)
              throws SpannerException

Throws:

SpannerException

getDatabaseDdl

List<String> getDatabaseDdl(String databaseName)
                     throws SpannerException

Throws:

SpannerException

listBackups

SpannerRpc.Paginated<Backup> listBackups(String instanceName,
                                         int pageSize,
                                         @Nullable
                                         String filter,
                                         @Nullable
                                         String pageToken)
                                  throws SpannerException

Lists the backups in the specified instance.

Throws:

SpannerException

createBackup

OperationFuture<Backup,CreateBackupMetadata> createBackup(Backup backupInfo)
                                                   throws SpannerException

Creates a new backup from the source database specified in the Backup instance.

Parameters:

backupInfo - the backup to create. The instance, database and expireTime fields of the backup must be filled.

Returns:

the operation that monitors the backup creation.

Throws:

SpannerException

copyBackup

default OperationFuture<Backup,CopyBackupMetadata> copyBackup(BackupId sourceBackupId,
                                                              Backup destinationBackup)

Creates a copy backup from the source backup specified.

Parameters:

destinationBackup - the backup to create. The instance, database, and expireTime fields of the backup must be filled. It may also optionally have an encryption config set. If no encryption config has been set, the new backup will use the same encryption config as the source backup.

Returns:

the operation that monitors the backup creation.

restoreDatabase

OperationFuture<Database,RestoreDatabaseMetadata> restoreDatabase(Restore restore)

Restore a backup into the given database.

Parameters:

restore - a Restore instance with the backup source and destination database

getBackup

Backup getBackup(String backupName)
          throws SpannerException

Gets the backup with the specified name.

Throws:

SpannerException

updateBackup

Backup updateBackup(Backup backup,
                    FieldMask updateMask)

Updates the specified backup. The only supported field for updates is expireTime.

listBackupOperations

SpannerRpc.Paginated<Operation> listBackupOperations(String instanceName,
                                                     int pageSize,
                                                     @Nullable
                                                     String filter,
                                                     @Nullable
                                                     String pageToken)

List all long-running backup operations on the given instance.

deleteBackup

void deleteBackup(String backupName)

Deletes a pending or completed backup.

Parameters:

backupName - Required. The fully qualified name of the backup to delete.

listDatabaseOperations

SpannerRpc.Paginated<Operation> listDatabaseOperations(String instanceName,
                                                       int pageSize,
                                                       @Nullable
                                                       String filter,
                                                       @Nullable
                                                       String pageToken)

getOperation

Operation getOperation(String name)
                throws SpannerException

Retrieves a long running operation.

Throws:

SpannerException

cancelOperation

void cancelOperation(String name)
              throws SpannerException

Cancels the specified long-running operation.

Throws:

SpannerException

batchCreateSessions

List<Session> batchCreateSessions(String databaseName,
                                  int sessionCount,
                                  @Nullable
                                  Map<String,String> labels,
                                  @Nullable
                                  Map<SpannerRpc.Option,?> options)
                           throws SpannerException

Throws:

SpannerException

createSession

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

asyncDeleteSession

com.google.api.core.ApiFuture<Empty> asyncDeleteSession(String sessionName,
                                                        @Nullable
                                                        Map<SpannerRpc.Option,?> options)
                                                 throws SpannerException

Throws:

SpannerException

read

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

executeQuery

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

executeQueryAsync

com.google.api.core.ApiFuture<ResultSet> executeQueryAsync(ExecuteSqlRequest request,
                                                           @Nullable
                                                           Map<SpannerRpc.Option,?> options)

executePartitionedDml

ResultSet executePartitionedDml(ExecuteSqlRequest request,
                                @Nullable
                                Map<SpannerRpc.Option,?> options)

getPartitionedDmlRetrySettings

RetrySettings getPartitionedDmlRetrySettings()

executeStreamingPartitionedDml

ServerStream<PartialResultSet> executeStreamingPartitionedDml(ExecuteSqlRequest request,
                                                              @Nullable
                                                              Map<SpannerRpc.Option,?> options,
                                                              org.threeten.bp.Duration timeout)

executeQuery

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

executeBatchDml

ExecuteBatchDmlResponse executeBatchDml(ExecuteBatchDmlRequest build,
                                        Map<SpannerRpc.Option,?> options)

executeBatchDmlAsync

com.google.api.core.ApiFuture<ExecuteBatchDmlResponse> executeBatchDmlAsync(ExecuteBatchDmlRequest build,
                                                                            Map<SpannerRpc.Option,?> options)

beginTransaction

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

Throws:

SpannerException

beginTransactionAsync

com.google.api.core.ApiFuture<Transaction> beginTransactionAsync(BeginTransactionRequest request,
                                                                 @Nullable
                                                                 Map<SpannerRpc.Option,?> options)

commit

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

Throws:

SpannerException

commitAsync

com.google.api.core.ApiFuture<CommitResponse> commitAsync(CommitRequest commitRequest,
                                                          @Nullable
                                                          Map<SpannerRpc.Option,?> options)

rollback

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

Throws:

SpannerException

rollbackAsync

com.google.api.core.ApiFuture<Empty> rollbackAsync(RollbackRequest request,
                                                   @Nullable
                                                   Map<SpannerRpc.Option,?> options)

partitionQuery

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

Throws:

SpannerException

partitionRead

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

Throws:

SpannerException

getDatabaseAdminIAMPolicy

com.google.iam.v1.Policy getDatabaseAdminIAMPolicy(String resource)

Gets the IAM policy for the given resource using the DatabaseAdminStub.

setDatabaseAdminIAMPolicy

com.google.iam.v1.Policy setDatabaseAdminIAMPolicy(String resource,
                                                   com.google.iam.v1.Policy policy)

Updates the IAM policy for the given resource using the DatabaseAdminStub. It is highly recommended to first get the current policy and base the updated policy on the returned policy. See Policy.Builder#setEtag(com.google.protobuf.ByteString) for information on the recommended read-modify-write cycle.

testDatabaseAdminIAMPermissions

com.google.iam.v1.TestIamPermissionsResponse testDatabaseAdminIAMPermissions(String resource,
                                                                             Iterable<String> permissions)

Tests the IAM permissions for the given resource using the DatabaseAdminStub.

getInstanceAdminIAMPolicy

com.google.iam.v1.Policy getInstanceAdminIAMPolicy(String resource)

Gets the IAM policy for the given resource using the InstanceAdminStub.

setInstanceAdminIAMPolicy

com.google.iam.v1.Policy setInstanceAdminIAMPolicy(String resource,
                                                   com.google.iam.v1.Policy policy)

Updates the IAM policy for the given resource using the InstanceAdminStub. It is highly recommended to first get the current policy and base the updated policy on the returned policy. See Policy.Builder#setEtag(com.google.protobuf.ByteString) for information on the recommended read-modify-write cycle.

testInstanceAdminIAMPermissions

com.google.iam.v1.TestIamPermissionsResponse testInstanceAdminIAMPermissions(String resource,
                                                                             Iterable<String> permissions)

Tests the IAM permissions for the given resource using the InstanceAdminStub.

shutdown

void shutdown()

isClosed

boolean isClosed()