Class SpannerClient

public class SpannerClient implements BackgroundResource

Service Description: Cloud Spanner API

The Cloud Spanner API can be used to manage sessions and execute transactions on data stored in Cloud Spanner databases.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 try (SpannerClient spannerClient = SpannerClient.create()) {
   DatabaseName database = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]");
   Session response = spannerClient.createSession(database);
 }

Note: close() needs to be called on the SpannerClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of SpannerSettings to create(). For example:

To customize credentials:


 SpannerSettings spannerSettings =
     SpannerSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 SpannerClient spannerClient = SpannerClient.create(spannerSettings);

To customize the endpoint:


 SpannerSettings spannerSettings = SpannerSettings.newBuilder().setEndpoint(myEndpoint).build();
 SpannerClient spannerClient = SpannerClient.create(spannerSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

Inheritance

java.lang.Object > SpannerClient

Implements

BackgroundResource

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Constructors

SpannerClient(SpannerSettings settings)

protected SpannerClient(SpannerSettings settings)

Constructs an instance of SpannerClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Parameter

Name	Description
settings	`SpannerSettings`

SpannerClient(SpannerStub stub)

protected SpannerClient(SpannerStub stub)

Parameter

Name	Description
stub	`SpannerStub`

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)

Parameters

Name	Description
duration	`long`
unit	`TimeUnit`

Returns

Type	Description
boolean

Exceptions

Type	Description
InterruptedException

batchCreateSessions(BatchCreateSessionsRequest request)

public final BatchCreateSessionsResponse batchCreateSessions(BatchCreateSessionsRequest request)

Creates multiple new sessions.

This API can be used to initialize a session cache on the clients. See https://goo.gl/TgSFN2 for best practices on session cache management.

Sample code:


 try (SpannerClient spannerClient = SpannerClient.create()) {
   BatchCreateSessionsRequest request =
       BatchCreateSessionsRequest.newBuilder()
           .setDatabase(DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString())
           .setSessionTemplate(Session.newBuilder().build())
           .setSessionCount(185691686)
           .build();
   BatchCreateSessionsResponse response = spannerClient.batchCreateSessions(request);
 }

Parameter

Name	Description
request	`BatchCreateSessionsRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
BatchCreateSessionsResponse

batchCreateSessions(DatabaseName database, int sessionCount)

public final BatchCreateSessionsResponse batchCreateSessions(DatabaseName database, int sessionCount)

Creates multiple new sessions.

This API can be used to initialize a session cache on the clients. See https://goo.gl/TgSFN2 for best practices on session cache management.

Sample code:


 try (SpannerClient spannerClient = SpannerClient.create()) {
   DatabaseName database = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]");
   int sessionCount = 185691686;
   BatchCreateSessionsResponse response =
       spannerClient.batchCreateSessions(database, sessionCount);
 }

Parameters

Name	Description
database	`DatabaseName` Required. The database in which the new sessions are created.
sessionCount	`int` Required. The number of sessions to be created in this batch call. The API may return fewer than the requested number of sessions. If a specific number of sessions are desired, the client can make additional calls to BatchCreateSessions (adjusting session_count as necessary).

Returns

Type	Description
BatchCreateSessionsResponse

batchCreateSessions(String database, int sessionCount)

public final BatchCreateSessionsResponse batchCreateSessions(String database, int sessionCount)

Creates multiple new sessions.

This API can be used to initialize a session cache on the clients. See https://goo.gl/TgSFN2 for best practices on session cache management.

Sample code:


 try (SpannerClient spannerClient = SpannerClient.create()) {
   String database = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString();
   int sessionCount = 185691686;
   BatchCreateSessionsResponse response =
       spannerClient.batchCreateSessions(database, sessionCount);
 }

Parameters

Name	Description
database	`String` Required. The database in which the new sessions are created.
sessionCount	`int` Required. The number of sessions to be created in this batch call. The API may return fewer than the requested number of sessions. If a specific number of sessions are desired, the client can make additional calls to BatchCreateSessions (adjusting session_count as necessary).

Returns

Type	Description
BatchCreateSessionsResponse

batchCreateSessionsCallable()

public final UnaryCallable<BatchCreateSessionsRequest,BatchCreateSessionsResponse> batchCreateSessionsCallable()

Creates multiple new sessions.

This API can be used to initialize a session cache on the clients. See https://goo.gl/TgSFN2 for best practices on session cache management.

Sample code:


 try (SpannerClient spannerClient = SpannerClient.create()) {
   BatchCreateSessionsRequest request =
       BatchCreateSessionsRequest.newBuilder()
           .setDatabase(DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString())
           .setSessionTemplate(Session.newBuilder().build())
           .setSessionCount(185691686)
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<BatchCreateSessionsRequest,BatchCreateSessionsResponse>

beginTransaction(BeginTransactionRequest request)

public final Transaction beginTransaction(BeginTransactionRequest request)

Begins a new transaction. This step can often be skipped: Read, ExecuteSql and Commit can begin a new transaction as a side-effect.

Sample code:


 try (SpannerClient spannerClient = SpannerClient.create()) {
   BeginTransactionRequest request =
       BeginTransactionRequest.newBuilder()
           .setSession(
               SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString())
           .setOptions(TransactionOptions.newBuilder().build())
           .setRequestOptions(RequestOptions.newBuilder().build())
           .build();
   Transaction response = spannerClient.beginTransaction(request);
 }

Parameter

Name	Description
request	`BeginTransactionRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
Transaction

beginTransaction(SessionName session, TransactionOptions options)

public final Transaction beginTransaction(SessionName session, TransactionOptions options)

Begins a new transaction. This step can often be skipped: Read, ExecuteSql and Commit can begin a new transaction as a side-effect.

Sample code:


 try (SpannerClient spannerClient = SpannerClient.create()) {
   SessionName session = SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]");
   TransactionOptions options = TransactionOptions.newBuilder().build();
   Transaction response = spannerClient.beginTransaction(session, options);
 }

Parameters

Name	Description
session	`SessionName` Required. The session in which the transaction runs.
options	`TransactionOptions` Required. Options for the new transaction.

Returns

Type	Description
Transaction

beginTransaction(String session, TransactionOptions options)

public final Transaction beginTransaction(String session, TransactionOptions options)

Begins a new transaction. This step can often be skipped: Read, ExecuteSql and Commit can begin a new transaction as a side-effect.

Sample code:


 try (SpannerClient spannerClient = SpannerClient.create()) {
   String session =
       SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString();
   TransactionOptions options = TransactionOptions.newBuilder().build();
   Transaction response = spannerClient.beginTransaction(session, options);
 }

Parameters

Name	Description
session	`String` Required. The session in which the transaction runs.
options	`TransactionOptions` Required. Options for the new transaction.

Returns

Type	Description
Transaction

beginTransactionCallable()

public final UnaryCallable<BeginTransactionRequest,Transaction> beginTransactionCallable()

Begins a new transaction. This step can often be skipped: Read, ExecuteSql and Commit can begin a new transaction as a side-effect.

Sample code:


 try (SpannerClient spannerClient = SpannerClient.create()) {
   BeginTransactionRequest request =
       BeginTransactionRequest.newBuilder()
           .setSession(
               SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString())
           .setOptions(TransactionOptions.newBuilder().build())
           .setRequestOptions(RequestOptions.newBuilder().build())
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<BeginTransactionRequest,Transaction>

close()

public final void close()

commit(CommitRequest request)

public final CommitResponse commit(CommitRequest request)

Commits a transaction. The request includes the mutations to be applied to rows in the database.

Commit might return an ABORTED error. This can occur at any time; commonly, the cause is conflicts with concurrent transactions. However, it can also happen for a variety of other reasons. If Commit returns ABORTED, the caller should re-attempt the transaction from the beginning, re-using the same session.

On very rare occasions, Commit might return UNKNOWN. This can happen, for example, if the client job experiences a 1+ hour networking failure. At that point, Cloud Spanner has lost track of the transaction outcome and we recommend that you perform another read from the database to see the state of things as they are now.

Sample code:


 try (SpannerClient spannerClient = SpannerClient.create()) {
   CommitRequest request =
       CommitRequest.newBuilder()
           .setSession(
               SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString())
           .addAllMutations(new ArrayList

Parameter

Name	Description
request	`CommitRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
CommitResponse

commit(SessionName session, ByteString transactionId, List<Mutation> mutations)

public final CommitResponse commit(SessionName session, ByteString transactionId, List<Mutation> mutations)

Commits a transaction. The request includes the mutations to be applied to rows in the database.

Sample code:


 try (SpannerClient spannerClient = SpannerClient.create()) {
   SessionName session = SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]");
   ByteString transactionId = ByteString.EMPTY;
   List

Parameters

Name	Description
session	`SessionName` Required. The session in which the transaction to be committed is running.
transactionId	`ByteString` Commit a previously-started transaction.
mutations	`List<Mutation>` The mutations to be executed when this transaction commits. All mutations are applied atomically, in the order they appear in this list.

Returns

Type	Description
CommitResponse

commit(SessionName session, TransactionOptions singleUseTransaction, List<Mutation> mutations)

public final CommitResponse commit(SessionName session, TransactionOptions singleUseTransaction, List<Mutation> mutations)

Commits a transaction. The request includes the mutations to be applied to rows in the database.

Sample code:


 try (SpannerClient spannerClient = SpannerClient.create()) {
   SessionName session = SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]");
   TransactionOptions singleUseTransaction = TransactionOptions.newBuilder().build();
   List

Parameters

Name	Description
session	`SessionName` Required. The session in which the transaction to be committed is running.
singleUseTransaction	`TransactionOptions` Execute mutations in a temporary transaction. Note that unlike commit of a previously-started transaction, commit with a temporary transaction is non-idempotent. That is, if the `CommitRequest` is sent to Cloud Spanner more than once (for instance, due to retries in the application, or in the transport library), it is possible that the mutations are executed more than once. If this is undesirable, use BeginTransaction and Commit instead.
mutations	`List<Mutation>` The mutations to be executed when this transaction commits. All mutations are applied atomically, in the order they appear in this list.

Returns

Type	Description
CommitResponse

commit(String session, ByteString transactionId, List<Mutation> mutations)

public final CommitResponse commit(String session, ByteString transactionId, List<Mutation> mutations)

Commits a transaction. The request includes the mutations to be applied to rows in the database.

Sample code:


 try (SpannerClient spannerClient = SpannerClient.create()) {
   String session =
       SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString();
   ByteString transactionId = ByteString.EMPTY;
   List

Parameters

Name	Description
session	`String` Required. The session in which the transaction to be committed is running.
transactionId	`ByteString` Commit a previously-started transaction.
mutations	`List<Mutation>` The mutations to be executed when this transaction commits. All mutations are applied atomically, in the order they appear in this list.

Returns

Type	Description
CommitResponse

commit(String session, TransactionOptions singleUseTransaction, List<Mutation> mutations)

public final CommitResponse commit(String session, TransactionOptions singleUseTransaction, List<Mutation> mutations)

Commits a transaction. The request includes the mutations to be applied to rows in the database.

Sample code:


 try (SpannerClient spannerClient = SpannerClient.create()) {
   String session =
       SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString();
   TransactionOptions singleUseTransaction = TransactionOptions.newBuilder().build();
   List

Parameters

Name	Description
session	`String` Required. The session in which the transaction to be committed is running.
singleUseTransaction	`TransactionOptions` Execute mutations in a temporary transaction. Note that unlike commit of a previously-started transaction, commit with a temporary transaction is non-idempotent. That is, if the `CommitRequest` is sent to Cloud Spanner more than once (for instance, due to retries in the application, or in the transport library), it is possible that the mutations are executed more than once. If this is undesirable, use BeginTransaction and Commit instead.
mutations	`List<Mutation>` The mutations to be executed when this transaction commits. All mutations are applied atomically, in the order they appear in this list.

Returns

Type	Description
CommitResponse

commitCallable()

public final UnaryCallable<CommitRequest,CommitResponse> commitCallable()

Commits a transaction. The request includes the mutations to be applied to rows in the database.

Sample code:


 try (SpannerClient spannerClient = SpannerClient.create()) {
   CommitRequest request =
       CommitRequest.newBuilder()
           .setSession(
               SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString())
           .addAllMutations(new ArrayList

Returns

Type	Description
UnaryCallable<CommitRequest,CommitResponse>

create()

public static final SpannerClient create()

Constructs an instance of SpannerClient with default settings.

Returns

Type	Description
SpannerClient

Exceptions

Type	Description
IOException

create(SpannerSettings settings)

public static final SpannerClient create(SpannerSettings settings)

Constructs an instance of SpannerClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Parameter

Name	Description
settings	`SpannerSettings`

Returns

Type	Description
SpannerClient

Exceptions

Type	Description
IOException

create(SpannerStub stub)

public static final SpannerClient create(SpannerStub stub)

Constructs an instance of SpannerClient, using the given stub for making calls. This is for advanced usage - prefer using create(SpannerSettings).

Parameter

Name	Description
stub	`SpannerStub`

Returns

Type	Description
SpannerClient

createSession(CreateSessionRequest request)

public final Session createSession(CreateSessionRequest request)

Creates a new session. A session can be used to perform transactions that read and/or modify data in a Cloud Spanner database. Sessions are meant to be reused for many consecutive transactions.

Sessions can only execute one transaction at a time. To execute multiple concurrent read-write/write-only transactions, create multiple sessions. Note that standalone reads and queries use a transaction internally, and count toward the one transaction limit.

Active sessions use additional server resources, so it is a good idea to delete idle and unneeded sessions. Aside from explicit deletes, Cloud Spanner may delete sessions for which no operations are sent for more than an hour. If a session is deleted, requests to it return NOT_FOUND.

Idle sessions can be kept alive by sending a trivial SQL query periodically, e.g., "SELECT 1".

Sample code:


 try (SpannerClient spannerClient = SpannerClient.create()) {
   CreateSessionRequest request =
       CreateSessionRequest.newBuilder()
           .setDatabase(DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString())
           .setSession(Session.newBuilder().build())
           .build();
   Session response = spannerClient.createSession(request);
 }

Parameter

Name	Description
request	`CreateSessionRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
Session

createSession(DatabaseName database)

public final Session createSession(DatabaseName database)

Creates a new session. A session can be used to perform transactions that read and/or modify data in a Cloud Spanner database. Sessions are meant to be reused for many consecutive transactions.

Idle sessions can be kept alive by sending a trivial SQL query periodically, e.g., "SELECT 1".

Sample code:


 try (SpannerClient spannerClient = SpannerClient.create()) {
   DatabaseName database = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]");
   Session response = spannerClient.createSession(database);
 }

Parameter

Name	Description
database	`DatabaseName` Required. The database in which the new session is created.

Returns

Type	Description
Session

createSession(String database)

public final Session createSession(String database)

Creates a new session. A session can be used to perform transactions that read and/or modify data in a Cloud Spanner database. Sessions are meant to be reused for many consecutive transactions.

Idle sessions can be kept alive by sending a trivial SQL query periodically, e.g., "SELECT 1".

Sample code:


 try (SpannerClient spannerClient = SpannerClient.create()) {
   String database = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString();
   Session response = spannerClient.createSession(database);
 }

Parameter

Name	Description
database	`String` Required. The database in which the new session is created.

Returns

Type	Description
Session

createSessionCallable()

public final UnaryCallable<CreateSessionRequest,Session> createSessionCallable()

Creates a new session. A session can be used to perform transactions that read and/or modify data in a Cloud Spanner database. Sessions are meant to be reused for many consecutive transactions.

Idle sessions can be kept alive by sending a trivial SQL query periodically, e.g., "SELECT 1".

Sample code:


 try (SpannerClient spannerClient = SpannerClient.create()) {
   CreateSessionRequest request =
       CreateSessionRequest.newBuilder()
           .setDatabase(DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString())
           .setSession(Session.newBuilder().build())
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<CreateSessionRequest,Session>

deleteSession(DeleteSessionRequest request)

public final void deleteSession(DeleteSessionRequest request)

Ends a session, releasing server resources associated with it. This will asynchronously trigger cancellation of any operations that are running with this session.

Sample code:


 try (SpannerClient spannerClient = SpannerClient.create()) {
   DeleteSessionRequest request =
       DeleteSessionRequest.newBuilder()
           .setName(
               SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString())
           .build();
   spannerClient.deleteSession(request);
 }

Parameter

Name	Description
request	`DeleteSessionRequest` The request object containing all of the parameters for the API call.

deleteSession(SessionName name)

public final void deleteSession(SessionName name)

Ends a session, releasing server resources associated with it. This will asynchronously trigger cancellation of any operations that are running with this session.

Sample code:


 try (SpannerClient spannerClient = SpannerClient.create()) {
   SessionName name = SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]");
   spannerClient.deleteSession(name);
 }

Parameter

Name	Description
name	`SessionName` Required. The name of the session to delete.

deleteSession(String name)

public final void deleteSession(String name)

Ends a session, releasing server resources associated with it. This will asynchronously trigger cancellation of any operations that are running with this session.

Sample code:


 try (SpannerClient spannerClient = SpannerClient.create()) {
   String name = SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString();
   spannerClient.deleteSession(name);
 }

Parameter

Name	Description
name	`String` Required. The name of the session to delete.

deleteSessionCallable()

public final UnaryCallable<DeleteSessionRequest,Empty> deleteSessionCallable()

Ends a session, releasing server resources associated with it. This will asynchronously trigger cancellation of any operations that are running with this session.

Sample code:


 try (SpannerClient spannerClient = SpannerClient.create()) {
   DeleteSessionRequest request =
       DeleteSessionRequest.newBuilder()
           .setName(
               SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString())
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<DeleteSessionRequest,Empty>

executeBatchDml(ExecuteBatchDmlRequest request)

public final ExecuteBatchDmlResponse executeBatchDml(ExecuteBatchDmlRequest request)

Executes a batch of SQL DML statements. This method allows many statements to be run with lower latency than submitting them sequentially with ExecuteSql.

Statements are executed in sequential order. A request can succeed even if a statement fails. The ExecuteBatchDmlResponse.status field in the response provides information about the statement that failed. Clients must inspect this field to determine whether an error occurred.

Execution stops after the first failed statement; the remaining statements are not executed.

Sample code:


 try (SpannerClient spannerClient = SpannerClient.create()) {
   ExecuteBatchDmlRequest request =
       ExecuteBatchDmlRequest.newBuilder()
           .setSession(
               SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString())
           .setTransaction(TransactionSelector.newBuilder().build())
           .addAllStatements(new ArrayList

Parameter

Name	Description
request	`ExecuteBatchDmlRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
ExecuteBatchDmlResponse

executeBatchDmlCallable()

public final UnaryCallable<ExecuteBatchDmlRequest,ExecuteBatchDmlResponse> executeBatchDmlCallable()

Executes a batch of SQL DML statements. This method allows many statements to be run with lower latency than submitting them sequentially with ExecuteSql.

Execution stops after the first failed statement; the remaining statements are not executed.

Sample code:


 try (SpannerClient spannerClient = SpannerClient.create()) {
   ExecuteBatchDmlRequest request =
       ExecuteBatchDmlRequest.newBuilder()
           .setSession(
               SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString())
           .setTransaction(TransactionSelector.newBuilder().build())
           .addAllStatements(new ArrayList

Returns

Type	Description
UnaryCallable<ExecuteBatchDmlRequest,ExecuteBatchDmlResponse>

executeSql(ExecuteSqlRequest request)

public final ResultSet executeSql(ExecuteSqlRequest request)

Executes an SQL statement, returning all results in a single reply. This method cannot be used to return a result set larger than 10 MiB; if the query yields more data than that, the query fails with a FAILED_PRECONDITION error.

Operations inside read-write transactions might return ABORTED. If this occurs, the application should restart the transaction from the beginning. See Transaction for more details.

Larger result sets can be fetched in streaming fashion by calling ExecuteStreamingSql instead.

Sample code:


 try (SpannerClient spannerClient = SpannerClient.create()) {
   ExecuteSqlRequest request =
       ExecuteSqlRequest.newBuilder()
           .setSession(
               SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString())
           .setTransaction(TransactionSelector.newBuilder().build())
           .setSql("sql114126")
           .setParams(Struct.newBuilder().build())
           .putAllParamTypes(new HashMap

Parameter

Name	Description
request	`ExecuteSqlRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
ResultSet

executeSqlCallable()

public final UnaryCallable<ExecuteSqlRequest,ResultSet> executeSqlCallable()

Operations inside read-write transactions might return ABORTED. If this occurs, the application should restart the transaction from the beginning. See Transaction for more details.

Larger result sets can be fetched in streaming fashion by calling ExecuteStreamingSql instead.

Sample code:


 try (SpannerClient spannerClient = SpannerClient.create()) {
   ExecuteSqlRequest request =
       ExecuteSqlRequest.newBuilder()
           .setSession(
               SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString())
           .setTransaction(TransactionSelector.newBuilder().build())
           .setSql("sql114126")
           .setParams(Struct.newBuilder().build())
           .putAllParamTypes(new HashMap

Returns

Type	Description
UnaryCallable<ExecuteSqlRequest,ResultSet>

executeStreamingSqlCallable()

public final ServerStreamingCallable<ExecuteSqlRequest,PartialResultSet> executeStreamingSqlCallable()

Like ExecuteSql, except returns the result set as a stream. Unlike ExecuteSql, there is no limit on the size of the returned result set. However, no individual row in the result set can exceed 100 MiB, and no column value can exceed 10 MiB.

Sample code:


 try (SpannerClient spannerClient = SpannerClient.create()) {
   ExecuteSqlRequest request =
       ExecuteSqlRequest.newBuilder()
           .setSession(
               SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString())
           .setTransaction(TransactionSelector.newBuilder().build())
           .setSql("sql114126")
           .setParams(Struct.newBuilder().build())
           .putAllParamTypes(new HashMap

Returns

Type	Description
ServerStreamingCallable<ExecuteSqlRequest,PartialResultSet>

getSession(GetSessionRequest request)

public final Session getSession(GetSessionRequest request)

Gets a session. Returns NOT_FOUND if the session does not exist. This is mainly useful for determining whether a session is still alive.

Sample code:


 try (SpannerClient spannerClient = SpannerClient.create()) {
   GetSessionRequest request =
       GetSessionRequest.newBuilder()
           .setName(
               SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString())
           .build();
   Session response = spannerClient.getSession(request);
 }

Parameter

Name	Description
request	`GetSessionRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
Session

getSession(SessionName name)

public final Session getSession(SessionName name)

Gets a session. Returns NOT_FOUND if the session does not exist. This is mainly useful for determining whether a session is still alive.

Sample code:


 try (SpannerClient spannerClient = SpannerClient.create()) {
   SessionName name = SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]");
   Session response = spannerClient.getSession(name);
 }

Parameter

Name	Description
name	`SessionName` Required. The name of the session to retrieve.

Returns

Type	Description
Session

getSession(String name)

public final Session getSession(String name)

Gets a session. Returns NOT_FOUND if the session does not exist. This is mainly useful for determining whether a session is still alive.

Sample code:


 try (SpannerClient spannerClient = SpannerClient.create()) {
   String name = SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString();
   Session response = spannerClient.getSession(name);
 }

Parameter

Name	Description
name	`String` Required. The name of the session to retrieve.

Returns

Type	Description
Session

getSessionCallable()

public final UnaryCallable<GetSessionRequest,Session> getSessionCallable()

Gets a session. Returns NOT_FOUND if the session does not exist. This is mainly useful for determining whether a session is still alive.

Sample code:


 try (SpannerClient spannerClient = SpannerClient.create()) {
   GetSessionRequest request =
       GetSessionRequest.newBuilder()
           .setName(
               SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString())
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<GetSessionRequest,Session>

getSettings()

public final SpannerSettings getSettings()

Returns

Type	Description
SpannerSettings

getStub()

public SpannerStub getStub()

Returns

Type	Description
SpannerStub

isShutdown()

public boolean isShutdown()

Returns

Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns

Type	Description
boolean

listSessions(DatabaseName database)

public final SpannerClient.ListSessionsPagedResponse listSessions(DatabaseName database)

Lists all sessions in a given database.

Sample code:


 try (SpannerClient spannerClient = SpannerClient.create()) {
   DatabaseName database = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]");
   for (Session element : spannerClient.listSessions(database).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name	Description
database	`DatabaseName` Required. The database in which to list sessions.

Returns

Type	Description
SpannerClient.ListSessionsPagedResponse

listSessions(ListSessionsRequest request)

public final SpannerClient.ListSessionsPagedResponse listSessions(ListSessionsRequest request)

Lists all sessions in a given database.

Sample code:


 try (SpannerClient spannerClient = SpannerClient.create()) {
   ListSessionsRequest request =
       ListSessionsRequest.newBuilder()
           .setDatabase(DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   for (Session element : spannerClient.listSessions(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name	Description
request	`ListSessionsRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
SpannerClient.ListSessionsPagedResponse

listSessions(String database)

public final SpannerClient.ListSessionsPagedResponse listSessions(String database)

Lists all sessions in a given database.

Sample code:


 try (SpannerClient spannerClient = SpannerClient.create()) {
   String database = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString();
   for (Session element : spannerClient.listSessions(database).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name	Description
database	`String` Required. The database in which to list sessions.

Returns

Type	Description
SpannerClient.ListSessionsPagedResponse

listSessionsCallable()

public final UnaryCallable<ListSessionsRequest,ListSessionsResponse> listSessionsCallable()

Lists all sessions in a given database.

Sample code:


 try (SpannerClient spannerClient = SpannerClient.create()) {
   ListSessionsRequest request =
       ListSessionsRequest.newBuilder()
           .setDatabase(DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   while (true) {
     ListSessionsResponse response = spannerClient.listSessionsCallable().call(request);
     for (Session element : response.getResponsesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns

Type	Description
UnaryCallable<ListSessionsRequest,ListSessionsResponse>

listSessionsPagedCallable()

public final UnaryCallable<ListSessionsRequest,SpannerClient.ListSessionsPagedResponse> listSessionsPagedCallable()

Lists all sessions in a given database.

Sample code:


 try (SpannerClient spannerClient = SpannerClient.create()) {
   ListSessionsRequest request =
       ListSessionsRequest.newBuilder()
           .setDatabase(DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<ListSessionsRequest,ListSessionsPagedResponse>

partitionQuery(PartitionQueryRequest request)

public final PartitionResponse partitionQuery(PartitionQueryRequest request)

Creates a set of partition tokens that can be used to execute a query operation in parallel. Each of the returned partition tokens can be used by ExecuteStreamingSql to specify a subset of the query result to read. The same session and read-only transaction must be used by the PartitionQueryRequest used to create the partition tokens and the ExecuteSqlRequests that use the partition tokens.

Partition tokens become invalid when the session used to create them is deleted, is idle for too long, begins a new transaction, or becomes too old. When any of these happen, it is not possible to resume the query, and the whole operation must be restarted from the beginning.

Sample code:


 try (SpannerClient spannerClient = SpannerClient.create()) {
   PartitionQueryRequest request =
       PartitionQueryRequest.newBuilder()
           .setSession(
               SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString())
           .setTransaction(TransactionSelector.newBuilder().build())
           .setSql("sql114126")
           .setParams(Struct.newBuilder().build())
           .putAllParamTypes(new HashMap

Parameter

Name	Description
request	`PartitionQueryRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
PartitionResponse

partitionQueryCallable()

public final UnaryCallable<PartitionQueryRequest,PartitionResponse> partitionQueryCallable()

Sample code:


 try (SpannerClient spannerClient = SpannerClient.create()) {
   PartitionQueryRequest request =
       PartitionQueryRequest.newBuilder()
           .setSession(
               SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString())
           .setTransaction(TransactionSelector.newBuilder().build())
           .setSql("sql114126")
           .setParams(Struct.newBuilder().build())
           .putAllParamTypes(new HashMap

Returns

Type	Description
UnaryCallable<PartitionQueryRequest,PartitionResponse>

partitionRead(PartitionReadRequest request)

public final PartitionResponse partitionRead(PartitionReadRequest request)

Creates a set of partition tokens that can be used to execute a read operation in parallel. Each of the returned partition tokens can be used by StreamingRead to specify a subset of the read result to read. The same session and read-only transaction must be used by the PartitionReadRequest used to create the partition tokens and the ReadRequests that use the partition tokens. There are no ordering guarantees on rows returned among the returned partition tokens, or even within each individual StreamingRead call issued with a partition_token.

Partition tokens become invalid when the session used to create them is deleted, is idle for too long, begins a new transaction, or becomes too old. When any of these happen, it is not possible to resume the read, and the whole operation must be restarted from the beginning.

Sample code:


 try (SpannerClient spannerClient = SpannerClient.create()) {
   PartitionReadRequest request =
       PartitionReadRequest.newBuilder()
           .setSession(
               SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString())
           .setTransaction(TransactionSelector.newBuilder().build())
           .setTable("table110115790")
           .setIndex("index100346066")
           .addAllColumns(new ArrayList

Parameter

Name	Description
request	`PartitionReadRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
PartitionResponse

partitionReadCallable()

public final UnaryCallable<PartitionReadRequest,PartitionResponse> partitionReadCallable()

Partition tokens become invalid when the session used to create them is deleted, is idle for too long, begins a new transaction, or becomes too old. When any of these happen, it is not possible to resume the read, and the whole operation must be restarted from the beginning.

Sample code:


 try (SpannerClient spannerClient = SpannerClient.create()) {
   PartitionReadRequest request =
       PartitionReadRequest.newBuilder()
           .setSession(
               SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString())
           .setTransaction(TransactionSelector.newBuilder().build())
           .setTable("table110115790")
           .setIndex("index100346066")
           .addAllColumns(new ArrayList

Returns

Type	Description
UnaryCallable<PartitionReadRequest,PartitionResponse>

read(ReadRequest request)

public final ResultSet read(ReadRequest request)

Reads rows from the database using key lookups and scans, as a simple key/value style alternative to ExecuteSql. This method cannot be used to return a result set larger than 10 MiB; if the read matches more data than that, the read fails with a FAILED_PRECONDITION error.

Reads inside read-write transactions might return ABORTED. If this occurs, the application should restart the transaction from the beginning. See Transaction for more details.

Larger result sets can be yielded in streaming fashion by calling StreamingRead instead.

Sample code:


 try (SpannerClient spannerClient = SpannerClient.create()) {
   ReadRequest request =
       ReadRequest.newBuilder()
           .setSession(
               SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString())
           .setTransaction(TransactionSelector.newBuilder().build())
           .setTable("table110115790")
           .setIndex("index100346066")
           .addAllColumns(new ArrayList

Parameter

Name	Description
request	`ReadRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
ResultSet

readCallable()

public final UnaryCallable<ReadRequest,ResultSet> readCallable()

Reads inside read-write transactions might return ABORTED. If this occurs, the application should restart the transaction from the beginning. See Transaction for more details.

Larger result sets can be yielded in streaming fashion by calling StreamingRead instead.

Sample code:


 try (SpannerClient spannerClient = SpannerClient.create()) {
   ReadRequest request =
       ReadRequest.newBuilder()
           .setSession(
               SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString())
           .setTransaction(TransactionSelector.newBuilder().build())
           .setTable("table110115790")
           .setIndex("index100346066")
           .addAllColumns(new ArrayList

Returns

Type	Description
UnaryCallable<ReadRequest,ResultSet>

rollback(RollbackRequest request)

public final void rollback(RollbackRequest request)

Rolls back a transaction, releasing any locks it holds. It is a good idea to call this for any transaction that includes one or more Read or ExecuteSql requests and ultimately decides not to commit.

Rollback returns OK if it successfully aborts the transaction, the transaction was already aborted, or the transaction is not found. Rollback never returns ABORTED.

Sample code:


 try (SpannerClient spannerClient = SpannerClient.create()) {
   RollbackRequest request =
       RollbackRequest.newBuilder()
           .setSession(
               SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString())
           .setTransactionId(ByteString.EMPTY)
           .build();
   spannerClient.rollback(request);
 }

Parameter

Name	Description
request	`RollbackRequest` The request object containing all of the parameters for the API call.

rollback(SessionName session, ByteString transactionId)

public final void rollback(SessionName session, ByteString transactionId)

Rolls back a transaction, releasing any locks it holds. It is a good idea to call this for any transaction that includes one or more Read or ExecuteSql requests and ultimately decides not to commit.

Rollback returns OK if it successfully aborts the transaction, the transaction was already aborted, or the transaction is not found. Rollback never returns ABORTED.

Sample code:


 try (SpannerClient spannerClient = SpannerClient.create()) {
   SessionName session = SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]");
   ByteString transactionId = ByteString.EMPTY;
   spannerClient.rollback(session, transactionId);
 }

Parameters

Name	Description
session	`SessionName` Required. The session in which the transaction to roll back is running.
transactionId	`ByteString` Required. The transaction to roll back.

rollback(String session, ByteString transactionId)

public final void rollback(String session, ByteString transactionId)

Rolls back a transaction, releasing any locks it holds. It is a good idea to call this for any transaction that includes one or more Read or ExecuteSql requests and ultimately decides not to commit.

Rollback returns OK if it successfully aborts the transaction, the transaction was already aborted, or the transaction is not found. Rollback never returns ABORTED.

Sample code:


 try (SpannerClient spannerClient = SpannerClient.create()) {
   String session =
       SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString();
   ByteString transactionId = ByteString.EMPTY;
   spannerClient.rollback(session, transactionId);
 }

Parameters

Name	Description
session	`String` Required. The session in which the transaction to roll back is running.
transactionId	`ByteString` Required. The transaction to roll back.

rollbackCallable()

public final UnaryCallable<RollbackRequest,Empty> rollbackCallable()

Rolls back a transaction, releasing any locks it holds. It is a good idea to call this for any transaction that includes one or more Read or ExecuteSql requests and ultimately decides not to commit.

Rollback returns OK if it successfully aborts the transaction, the transaction was already aborted, or the transaction is not found. Rollback never returns ABORTED.

Sample code:


 try (SpannerClient spannerClient = SpannerClient.create()) {
   RollbackRequest request =
       RollbackRequest.newBuilder()
           .setSession(
               SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString())
           .setTransactionId(ByteString.EMPTY)
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<RollbackRequest,Empty>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

streamingReadCallable()

public final ServerStreamingCallable<ReadRequest,PartialResultSet> streamingReadCallable()

Like Read, except returns the result set as a stream. Unlike Read, there is no limit on the size of the returned result set. However, no individual row in the result set can exceed 100 MiB, and no column value can exceed 10 MiB.

Sample code:


 try (SpannerClient spannerClient = SpannerClient.create()) {
   ReadRequest request =
       ReadRequest.newBuilder()
           .setSession(
               SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString())
           .setTransaction(TransactionSelector.newBuilder().build())
           .setTable("table110115790")
           .setIndex("index100346066")
           .addAllColumns(new ArrayList

Returns

Type	Description
ServerStreamingCallable<ReadRequest,PartialResultSet>