Package com.google.cloud.spanner.spi.v1

Class GapicSpannerRpc

java.lang.Object

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

All Implemented Interfaces:

ServiceRpc, SpannerRpc

@InternalApi
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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_USER_AGENT
static boolean	DIRECTPATH_CHANNEL_CREATED
static final String	EXPERIMENTAL_LOCATION_API_ENV_VAR

Constructor Summary

Constructors

Constructor	Description
GapicSpannerRpc(SpannerOptions options)

Method Summary

Modifier and Type	Method	Description
ApiFuture<com.google.protobuf.Empty>	asyncDeleteSession(String sessionName, Map<SpannerRpc.Option,?> options)
List<Session>	batchCreateSessions(String databaseName, int sessionCount, String databaseRole, Map<String,String> labels, Map<SpannerRpc.Option,?> options)
ServerStream<BatchWriteResponse>	batchWriteAtLeastOnce(BatchWriteRequest request, Map<SpannerRpc.Option,?> options)
Transaction	beginTransaction(BeginTransactionRequest request, Map<SpannerRpc.Option,?> options, boolean routeToLeader)	Begins a transaction.
ApiFuture<Transaction>	beginTransactionAsync(BeginTransactionRequest request, Map<SpannerRpc.Option,?> options, boolean routeToLeader)	Begins a transaction asynchronously.
void	cancelOperation(String name)	Cancels the specified long-running operation.
void	clearTransactionAffinity(com.google.protobuf.ByteString transactionId)	Clears any client-side affinity associated with the given transaction id.
void	clearTransactionAndChannelAffinity(com.google.protobuf.ByteString transactionId, Long channelHint)	Clears any client-side transaction affinity and transport-level channel affinity associated with the given transaction.
CommitResponse	commit(CommitRequest commitRequest, Map<SpannerRpc.Option,?> options)
ApiFuture<CommitResponse>	commitAsync(CommitRequest request, Map<SpannerRpc.Option,?> options)
OperationFuture<Backup,CopyBackupMetadata>	copyBackup(BackupId sourceBackupId, Backup destinationBackup)	Creates a copy backup from the source backup specified.
static GapicSpannerRpc	create(SpannerOptions options)
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 databaseInfo)
OperationFuture<Instance,CreateInstanceMetadata>	createInstance(String parent, String instanceId, Instance instance)
OperationFuture<InstanceConfig,CreateInstanceConfigMetadata>	createInstanceConfig(String parent, String instanceConfigId, InstanceConfig instanceConfig, Boolean validateOnly)
Session	createSession(String databaseName, String databaseRole, Map<String,String> labels, Map<SpannerRpc.Option,?> options)
Session	createSession(String databaseName, String databaseRole, Map<String,String> labels, Map<SpannerRpc.Option,?> options, boolean isMultiplexed)
void	deleteBackup(String backupName)	Deletes a pending or completed backup.
void	deleteInstance(String instanceName)
void	deleteInstanceConfig(String instanceConfigName, String etag, Boolean validateOnly)
void	deleteSession(String sessionName, Map<SpannerRpc.Option,?> options)
void	dropDatabase(String databaseName)
ExecuteBatchDmlResponse	executeBatchDml(ExecuteBatchDmlRequest request, Map<SpannerRpc.Option,?> options)
ApiFuture<ExecuteBatchDmlResponse>	executeBatchDmlAsync(ExecuteBatchDmlRequest request, Map<SpannerRpc.Option,?> options)
ResultSet	executePartitionedDml(ExecuteSqlRequest request, Map<SpannerRpc.Option,?> options)
SpannerRpc.StreamingCall	executeQuery(ExecuteSqlRequest request, SpannerRpc.ResultStreamConsumer consumer, Map<SpannerRpc.Option,?> options, XGoogSpannerRequestId requestId, boolean routeToLeader)	Executes a query with streaming result.
ResultSet	executeQuery(ExecuteSqlRequest request, Map<SpannerRpc.Option,?> options, boolean routeToLeader)	Executes a query.
ApiFuture<ResultSet>	executeQueryAsync(ExecuteSqlRequest request, Map<SpannerRpc.Option,?> options, boolean routeToLeader)	Executes a query asynchronously.
ServerStream<PartialResultSet>	executeStreamingPartitionedDml(ExecuteSqlRequest request, Map<SpannerRpc.Option,?> options, XGoogSpannerRequestId requestId, Duration timeout)
Backup	getBackup(String backupName)	Gets the backup with the specified name.
RetrySettings	getCommitRetrySettings()
Database	getDatabase(String databaseName)
Policy	getDatabaseAdminIAMPolicy(String resource, GetPolicyOptions options)	Gets the IAM policy for the given resource using the DatabaseAdminStub.
DatabaseAdminStubSettings	getDatabaseAdminStubSettings()	Getter method to obtain the auto-generated database admin client stub settings.
GetDatabaseDdlResponse	getDatabaseDdl(String databaseName)
Set<StatusCode.Code>	getExecuteQueryRetryableCodes()	Returns the retryable codes for streaming query operations.
RetrySettings	getExecuteQueryRetrySettings()	Returns the retry settings for streaming query operations.
Instance	getInstance(String instanceName)
Policy	getInstanceAdminIAMPolicy(String resource)	Gets the IAM policy for the given resource using the InstanceAdminStub.
InstanceAdminStubSettings	getInstanceAdminStubSettings()	Getter method to obtain the auto-generated instance admin client stub settings.
InstanceConfig	getInstanceConfig(String instanceConfigName)
int	getNumActiveResponseObservers()
Operation	getOperation(String name)	Retrieves a long running operation.
RetrySettings	getPartitionedDmlRetrySettings()
Set<StatusCode.Code>	getReadRetryableCodes()	Returns the retryable codes for streaming read operations.
RetrySettings	getReadRetrySettings()	Returns the retry settings for streaming read operations.
XGoogSpannerRequestId.RequestIdCreator	getRequestIdCreator()
boolean	isClosed()
static boolean	isEnableAFEServerTiming()
static boolean	isEnableDirectPathBoundToken()
static boolean	isEnableDirectPathXdsEnv()
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<DatabaseRole>	listDatabaseRoles(String databaseName, int pageSize, String pageToken)
SpannerRpc.Paginated<Database>	listDatabases(String instanceName, int pageSize, String pageToken)
SpannerRpc.Paginated<Operation>	listInstanceConfigOperations(int pageSize, String filter, String pageToken)	List all long-running instance config operations on the given project.
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, XGoogSpannerRequestId requestId, boolean routeToLeader)	Performs a streaming read.
OperationFuture<Database,RestoreDatabaseMetadata>	restoreDatabase(Restore restore)	Restore a backup into the given database.
void	rollback(RollbackRequest request, Map<SpannerRpc.Option,?> options)
ApiFuture<com.google.protobuf.Empty>	rollbackAsync(RollbackRequest request, Map<SpannerRpc.Option,?> options)
Policy	setDatabaseAdminIAMPolicy(String resource, Policy policy)	Updates the IAM policy for the given resource using the DatabaseAdminStub.
Policy	setInstanceAdminIAMPolicy(String resource, Policy policy)	Updates the IAM policy for the given resource using the InstanceAdminStub.
void	shutdown()
void	shutdownNow()
TestIamPermissionsResponse	testDatabaseAdminIAMPermissions(String resource, Iterable<String> permissions)	Tests the IAM permissions for the given resource using the DatabaseAdminStub.
TestIamPermissionsResponse	testInstanceAdminIAMPermissions(String resource, Iterable<String> permissions)	Tests the IAM permissions for the given resource using the InstanceAdminStub.
Backup	updateBackup(Backup backup, com.google.protobuf.FieldMask updateMask)	Updates the specified backup.
OperationFuture<Database,UpdateDatabaseMetadata>	updateDatabase(Database database, com.google.protobuf.FieldMask updateMask)	Updates the specified fields of a Cloud Spanner database.
OperationFuture<com.google.protobuf.Empty,UpdateDatabaseDdlMetadata>	updateDatabaseDdl(Database databaseInfo, Iterable<String> updateDatabaseStatements, String updateId)	If the update database ddl operation returns an ALREADY_EXISTS error, meaning the operation id used is already in flight, this method will simply resume the original operation.
OperationFuture<Instance,UpdateInstanceMetadata>	updateInstance(Instance instance, com.google.protobuf.FieldMask fieldMask)
OperationFuture<InstanceConfig,UpdateInstanceConfigMetadata>	updateInstanceConfig(InstanceConfig instanceConfig, Boolean validateOnly, com.google.protobuf.FieldMask fieldMask)

Methods inherited from class java.lang.Object

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

Field Details

EXPERIMENTAL_LOCATION_API_ENV_VAR

public static final String EXPERIMENTAL_LOCATION_API_ENV_VAR

See Also:

• Constant Field Values

DEFAULT_USER_AGENT

public static final String DEFAULT_USER_AGENT

DIRECTPATH_CHANNEL_CREATED

public static boolean DIRECTPATH_CHANNEL_CREATED

Constructor Details

GapicSpannerRpc

public GapicSpannerRpc(SpannerOptions options)

Method Details

create

public static GapicSpannerRpc create(SpannerOptions options)

clearTransactionAffinity

public void clearTransactionAffinity(com.google.protobuf.ByteString transactionId)

Description copied from interface: SpannerRpc

Clears any client-side affinity associated with the given transaction id.

Specified by:

clearTransactionAffinity in interface SpannerRpc

clearTransactionAndChannelAffinity

public void clearTransactionAndChannelAffinity(com.google.protobuf.ByteString transactionId,
 @Nullable
 Long channelHint)

Description copied from interface: SpannerRpc

Clears any client-side transaction affinity and transport-level channel affinity associated with the given transaction.

Specified by:

clearTransactionAndChannelAffinity in interface SpannerRpc

isEnableAFEServerTiming

public static boolean isEnableAFEServerTiming()

isEnableDirectPathXdsEnv

public static boolean isEnableDirectPathXdsEnv()

isEnableDirectPathBoundToken

public static boolean isEnableDirectPathBoundToken()

listInstanceConfigs

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

Specified by:

listInstanceConfigs in interface SpannerRpc

Throws:

SpannerException

createInstanceConfig

public OperationFuture<InstanceConfig,CreateInstanceConfigMetadata> createInstanceConfig(String parent,
 String instanceConfigId,
 InstanceConfig instanceConfig,
 @Nullable
 Boolean validateOnly)
                                                                                  throws SpannerException

Specified by:

createInstanceConfig in interface SpannerRpc

Throws:

SpannerException

updateInstanceConfig

public OperationFuture<InstanceConfig,UpdateInstanceConfigMetadata> updateInstanceConfig(InstanceConfig instanceConfig,
 @Nullable
 Boolean validateOnly,
 com.google.protobuf.FieldMask fieldMask)
                                                                                  throws SpannerException

Specified by:

updateInstanceConfig in interface SpannerRpc

Throws:

SpannerException

getInstanceConfig

public InstanceConfig getInstanceConfig(String instanceConfigName)
                                 throws SpannerException

Specified by:

getInstanceConfig in interface SpannerRpc

Throws:

SpannerException

deleteInstanceConfig

public void deleteInstanceConfig(String instanceConfigName,
 @Nullable
 String etag,
 @Nullable
 Boolean validateOnly)
                          throws SpannerException

Specified by:

deleteInstanceConfig in interface SpannerRpc

Throws:

SpannerException

listInstanceConfigOperations

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

Description copied from interface: SpannerRpc

List all long-running instance config operations on the given project.

Specified by:

listInstanceConfigOperations in interface SpannerRpc

listInstances

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

Specified by:

listInstances in interface SpannerRpc

Throws:

SpannerException

createInstance

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

Specified by:

createInstance in interface SpannerRpc

Throws:

SpannerException

updateInstance

public OperationFuture<Instance,UpdateInstanceMetadata> updateInstance(Instance instance,
 com.google.protobuf.FieldMask fieldMask)
                                                                throws SpannerException

Specified by:

updateInstance in interface SpannerRpc

Throws:

SpannerException

getInstance

public 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

listBackupOperations

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

Description copied from interface: SpannerRpc

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

Specified by:

listBackupOperations in interface SpannerRpc

listDatabaseOperations

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

Specified by:

listDatabaseOperations in interface SpannerRpc

listDatabaseRoles

public SpannerRpc.Paginated<DatabaseRole> listDatabaseRoles(String databaseName,
 int pageSize,
 @Nullable
 String pageToken)

Specified by:

listDatabaseRoles in interface SpannerRpc

listBackups

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

Description copied from interface: SpannerRpc

Lists the backups in the specified instance.

Specified by:

listBackups in interface SpannerRpc

Throws:

SpannerException

listDatabases

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

Specified by:

listDatabases in interface SpannerRpc

Throws:

SpannerException

createDatabase

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

Specified by:

createDatabase in interface SpannerRpc

Throws:

SpannerException

updateDatabaseDdl

public OperationFuture<com.google.protobuf.Empty,UpdateDatabaseDdlMetadata> updateDatabaseDdl(Database databaseInfo,
 Iterable<String> updateDatabaseStatements,
 @Nullable
 String updateId)
                                                                                       throws SpannerException

If the update database ddl operation returns an ALREADY_EXISTS error, meaning the operation id used is already in flight, this method will simply resume the original operation. The returned future will be completed when the original operation finishes.

This mechanism is necessary, because the update database ddl can be retried. If a retryable failure occurs, the backend has already started processing the update database ddl operation with the given id and the library issues a retry, an ALREADY_EXISTS error will be returned. If we were to bubble this error up, it would be confusing for the caller, who used originally called the method with a new operation id.

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 Database getDatabase(String databaseName)
                     throws SpannerException

Specified by:

getDatabase in interface SpannerRpc

Throws:

SpannerException

updateDatabase

public OperationFuture<Database,UpdateDatabaseMetadata> updateDatabase(Database database,
 com.google.protobuf.FieldMask updateMask)
                                                                throws SpannerException

Description copied from interface: SpannerRpc

Updates the specified fields of a Cloud Spanner database.

Specified by:

updateDatabase in interface SpannerRpc

Parameters:

database - The database proto whose field values will be used as the new values in the stored database.

updateMask - The fields to update. Currently, only the "enable_drop_protection" field of the database supports updates.

Returns:

an `OperationFuture` that can be used to track the status of the update.

Throws:

SpannerException

getDatabaseDdl

public GetDatabaseDdlResponse getDatabaseDdl(String databaseName)
                                      throws SpannerException

Specified by:

getDatabaseDdl in interface SpannerRpc

Throws:

SpannerException

createBackup

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

Description copied from interface: SpannerRpc

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

Specified by:

createBackup in interface SpannerRpc

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

public OperationFuture<Backup,CopyBackupMetadata> copyBackup(BackupId sourceBackupId,
 Backup destinationBackup)
                                                      throws SpannerException

Description copied from interface: SpannerRpc

Creates a copy backup from the source backup specified.

Specified by:

copyBackup in interface SpannerRpc

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.

Throws:

SpannerException

restoreDatabase

public OperationFuture<Database,RestoreDatabaseMetadata> restoreDatabase(Restore restore)

Description copied from interface: SpannerRpc

Restore a backup into the given database.

Specified by:

restoreDatabase in interface SpannerRpc

Parameters:

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

updateBackup

public Backup updateBackup(Backup backup,
 com.google.protobuf.FieldMask updateMask)

Description copied from interface: SpannerRpc

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

Specified by:

updateBackup in interface SpannerRpc

deleteBackup

public void deleteBackup(String backupName)

Description copied from interface: SpannerRpc

Deletes a pending or completed backup.

Specified by:

deleteBackup in interface SpannerRpc

Parameters:

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

getBackup

public Backup getBackup(String backupName)
                 throws SpannerException

Description copied from interface: SpannerRpc

Gets the backup with the specified name.

Specified by:

getBackup 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

cancelOperation

public void cancelOperation(String name)
                     throws SpannerException

Description copied from interface: SpannerRpc

Cancels the specified long-running operation.

Specified by:

cancelOperation in interface SpannerRpc

Throws:

SpannerException

batchCreateSessions

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

Specified by:

batchCreateSessions in interface SpannerRpc

Throws:

SpannerException

createSession

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

Specified by:

createSession in interface SpannerRpc

Throws:

SpannerException

createSession

public Session createSession(String databaseName,
 @Nullable
 String databaseRole,
 @Nullable
 Map<String,String> labels,
 @Nullable
 Map<SpannerRpc.Option,?> options,
 boolean isMultiplexed)
                      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

asyncDeleteSession

public ApiFuture<com.google.protobuf.Empty> asyncDeleteSession(String sessionName,
 @Nullable
 Map<SpannerRpc.Option,?> options)

Specified by:

asyncDeleteSession in interface SpannerRpc

getReadRetrySettings

public RetrySettings getReadRetrySettings()

Description copied from interface: SpannerRpc

Returns the retry settings for streaming read operations.

Specified by:

getReadRetrySettings in interface SpannerRpc

getReadRetryableCodes

public Set<StatusCode.Code> getReadRetryableCodes()

Description copied from interface: SpannerRpc

Returns the retryable codes for streaming read operations.

Specified by:

getReadRetryableCodes in interface SpannerRpc

read

public SpannerRpc.StreamingCall read(ReadRequest request,
 SpannerRpc.ResultStreamConsumer consumer,
 @Nullable
 Map<SpannerRpc.Option,?> options,
 XGoogSpannerRequestId requestId,
 boolean routeToLeader)

Description copied from interface: SpannerRpc

Performs a streaming read.

Specified by:

read in interface SpannerRpc

routeToLeader - Set to true to route the request to the leader region, and false to route the request to any region. When leader aware routing is enabled, RW/PDML requests are preferred to be routed to the leader region, and RO requests (except for PartitionRead/PartitionQuery) are preferred to be routed to any region for optimal latency.

getExecuteQueryRetrySettings

public RetrySettings getExecuteQueryRetrySettings()

Description copied from interface: SpannerRpc

Returns the retry settings for streaming query operations.

Specified by:

getExecuteQueryRetrySettings in interface SpannerRpc

getExecuteQueryRetryableCodes

public Set<StatusCode.Code> getExecuteQueryRetryableCodes()

Description copied from interface: SpannerRpc

Returns the retryable codes for streaming query operations.

Specified by:

getExecuteQueryRetryableCodes in interface SpannerRpc

executeQuery

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

Description copied from interface: SpannerRpc

Executes a query.

Specified by:

executeQuery in interface SpannerRpc

routeToLeader - Set to true to route the request to the leader region, and false to route the request to any region. When leader aware routing is enabled, RW/PDML requests are preferred to be routed to the leader region, and RO requests (except for PartitionRead/PartitionQuery) are preferred to be routed to any region for optimal latency.

executeQueryAsync

public ApiFuture<ResultSet> executeQueryAsync(ExecuteSqlRequest request,
 @Nullable
 Map<SpannerRpc.Option,?> options,
 boolean routeToLeader)

Description copied from interface: SpannerRpc

Executes a query asynchronously.

Specified by:

executeQueryAsync in interface SpannerRpc

routeToLeader - Set to true to route the request to the leader region, and false to route the request to any region. When leader aware routing is enabled, RW/PDML requests are preferred to be routed to the leader region, and RO requests (except for PartitionRead/PartitionQuery) are preferred to be routed to any region for optimal latency.

executePartitionedDml

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

Specified by:

executePartitionedDml in interface SpannerRpc

getPartitionedDmlRetrySettings

public RetrySettings getPartitionedDmlRetrySettings()

Specified by:

getPartitionedDmlRetrySettings in interface SpannerRpc

executeStreamingPartitionedDml

public ServerStream<PartialResultSet> executeStreamingPartitionedDml(ExecuteSqlRequest request,
 Map<SpannerRpc.Option,?> options,
 XGoogSpannerRequestId requestId,
 Duration timeout)

Specified by:

executeStreamingPartitionedDml in interface SpannerRpc

batchWriteAtLeastOnce

public ServerStream<BatchWriteResponse> batchWriteAtLeastOnce(BatchWriteRequest request,
 @Nullable
 Map<SpannerRpc.Option,?> options)

Specified by:

batchWriteAtLeastOnce in interface SpannerRpc

executeQuery

public SpannerRpc.StreamingCall executeQuery(ExecuteSqlRequest request,
 SpannerRpc.ResultStreamConsumer consumer,
 @Nullable
 Map<SpannerRpc.Option,?> options,
 XGoogSpannerRequestId requestId,
 boolean routeToLeader)

Description copied from interface: SpannerRpc

Executes a query with streaming result.

Specified by:

executeQuery in interface SpannerRpc

routeToLeader - Set to true to route the request to the leader region, and false to route the request to any region. When leader aware routing is enabled, RW/PDML requests are preferred to be routed to the leader region, and RO requests (except for PartitionRead/PartitionQuery) are preferred to be routed to any region for optimal latency.

executeBatchDml

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

Specified by:

executeBatchDml in interface SpannerRpc

executeBatchDmlAsync

public ApiFuture<ExecuteBatchDmlResponse> executeBatchDmlAsync(ExecuteBatchDmlRequest request,
 @Nullable
 Map<SpannerRpc.Option,?> options)

Specified by:

executeBatchDmlAsync in interface SpannerRpc

beginTransactionAsync

public ApiFuture<Transaction> beginTransactionAsync(BeginTransactionRequest request,
 @Nullable
 Map<SpannerRpc.Option,?> options,
 boolean routeToLeader)

Description copied from interface: SpannerRpc

Begins a transaction asynchronously.

Specified by:

beginTransactionAsync in interface SpannerRpc

routeToLeader - Set to true to route the request to the leader region, and false to route the request to any region. When leader aware routing is enabled, RW/PDML requests are preferred to be routed to the leader region, and RO requests (except for PartitionRead/PartitionQuery) are preferred to be routed to any region for optimal latency.

beginTransaction

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

Description copied from interface: SpannerRpc

Begins a transaction.

Specified by:

beginTransaction in interface SpannerRpc

routeToLeader - Set to true to route the request to the leader region, and false to route the request to any region. When leader aware routing is enabled, RW/PDML requests are preferred to be routed to the leader region, and RO requests (except for PartitionRead/PartitionQuery) are preferred to be routed to any region for optimal latency.

Throws:

SpannerException

commitAsync

public ApiFuture<CommitResponse> commitAsync(CommitRequest request,
 @Nullable
 Map<SpannerRpc.Option,?> options)

Specified by:

commitAsync in interface SpannerRpc

commit

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

Specified by:

commit in interface SpannerRpc

Throws:

SpannerException

getCommitRetrySettings

public RetrySettings getCommitRetrySettings()

Specified by:

getCommitRetrySettings in interface SpannerRpc

rollbackAsync

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

Specified by:

rollbackAsync in interface SpannerRpc

rollback

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

Specified by:

rollback in interface SpannerRpc

Throws:

SpannerException

partitionQuery

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

Specified by:

partitionQuery in interface SpannerRpc

Throws:

SpannerException

partitionRead

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

Specified by:

partitionRead in interface SpannerRpc

Throws:

SpannerException

getDatabaseAdminIAMPolicy

public Policy getDatabaseAdminIAMPolicy(String resource,
 @Nullable
 GetPolicyOptions options)

Description copied from interface: SpannerRpc

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

Specified by:

getDatabaseAdminIAMPolicy in interface SpannerRpc

setDatabaseAdminIAMPolicy

public Policy setDatabaseAdminIAMPolicy(String resource,
 Policy policy)

Description copied from interface: SpannerRpc

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.

Specified by:

setDatabaseAdminIAMPolicy in interface SpannerRpc

testDatabaseAdminIAMPermissions

public TestIamPermissionsResponse testDatabaseAdminIAMPermissions(String resource,
 Iterable<String> permissions)

Description copied from interface: SpannerRpc

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

Specified by:

testDatabaseAdminIAMPermissions in interface SpannerRpc

getInstanceAdminIAMPolicy

public Policy getInstanceAdminIAMPolicy(String resource)

Description copied from interface: SpannerRpc

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

Specified by:

getInstanceAdminIAMPolicy in interface SpannerRpc

setInstanceAdminIAMPolicy

public Policy setInstanceAdminIAMPolicy(String resource,
 Policy policy)

Description copied from interface: SpannerRpc

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.

Specified by:

setInstanceAdminIAMPolicy in interface SpannerRpc

testInstanceAdminIAMPermissions

public TestIamPermissionsResponse testInstanceAdminIAMPermissions(String resource,
 Iterable<String> permissions)

Description copied from interface: SpannerRpc

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

Specified by:

testInstanceAdminIAMPermissions in interface SpannerRpc

getRequestIdCreator

public XGoogSpannerRequestId.RequestIdCreator getRequestIdCreator()

Specified by:

getRequestIdCreator in interface SpannerRpc

getNumActiveResponseObservers

@InternalApi
public int getNumActiveResponseObservers()

shutdown

public void shutdown()

Specified by:

shutdown in interface SpannerRpc

shutdownNow

public void shutdownNow()

isClosed

public boolean isClosed()

Specified by:

isClosed in interface SpannerRpc

getDatabaseAdminStubSettings

public DatabaseAdminStubSettings getDatabaseAdminStubSettings()

Description copied from interface: SpannerRpc

Getter method to obtain the auto-generated database admin client stub settings.

Specified by:

getDatabaseAdminStubSettings in interface SpannerRpc

Returns:

DatabaseAdminStubSettings

getInstanceAdminStubSettings

public InstanceAdminStubSettings getInstanceAdminStubSettings()

Description copied from interface: SpannerRpc

Getter method to obtain the auto-generated instance admin client stub settings.

Specified by:

getInstanceAdminStubSettings in interface SpannerRpc

Returns:

InstanceAdminStubSettings