SpannerClient (Google Cloud Spanner Parent 6.25.1 API)

java.lang.Object
- com.google.cloud.spanner.v1.SpannerClient

All Implemented Interfaces:

BackgroundResource, AutoCloseable
```
@Generated(value="by gapic-generator-java")
public class SpannerClient
extends Object
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:
```
 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 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:
1. 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.
2. 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.
3. 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:
```
 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 SpannerSettings spannerSettings =
     SpannerSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 SpannerClient spannerClient = SpannerClient.create(spannerSettings);
 
```
To customize the endpoint:
```
 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 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.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`SpannerClient.ListSessionsFixedSizeCollection`
`static class`	`SpannerClient.ListSessionsPage`
`static class`	`SpannerClient.ListSessionsPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`SpannerClient(SpannerSettings settings)` Constructs an instance of SpannerClient, using the given settings.
`protected`	`SpannerClient(SpannerStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`BatchCreateSessionsResponse`	`batchCreateSessions(BatchCreateSessionsRequest request)` Creates multiple new sessions.
`BatchCreateSessionsResponse`	`batchCreateSessions(DatabaseName database, int sessionCount)` Creates multiple new sessions.
`BatchCreateSessionsResponse`	`batchCreateSessions(String database, int sessionCount)` Creates multiple new sessions.
`UnaryCallable<BatchCreateSessionsRequest,BatchCreateSessionsResponse>`	`batchCreateSessionsCallable()` Creates multiple new sessions.
`Transaction`	`beginTransaction(BeginTransactionRequest request)` Begins a new transaction.
`Transaction`	`beginTransaction(SessionName session, TransactionOptions options)` Begins a new transaction.
`Transaction`	`beginTransaction(String session, TransactionOptions options)` Begins a new transaction.
`UnaryCallable<BeginTransactionRequest,Transaction>`	`beginTransactionCallable()` Begins a new transaction.
`void`	`close()`
`CommitResponse`	`commit(CommitRequest request)` Commits a transaction.
`CommitResponse`	`commit(SessionName session, ByteString transactionId, List<Mutation> mutations)` Commits a transaction.
`CommitResponse`	`commit(SessionName session, TransactionOptions singleUseTransaction, List<Mutation> mutations)` Commits a transaction.
`CommitResponse`	`commit(String session, ByteString transactionId, List<Mutation> mutations)` Commits a transaction.
`CommitResponse`	`commit(String session, TransactionOptions singleUseTransaction, List<Mutation> mutations)` Commits a transaction.
`UnaryCallable<CommitRequest,CommitResponse>`	`commitCallable()` Commits a transaction.
`static SpannerClient`	`create()` Constructs an instance of SpannerClient with default settings.
`static SpannerClient`	`create(SpannerSettings settings)` Constructs an instance of SpannerClient, using the given settings.
`static SpannerClient`	`create(SpannerStub stub)` Constructs an instance of SpannerClient, using the given stub for making calls.
`Session`	`createSession(CreateSessionRequest request)` Creates a new session.
`Session`	`createSession(DatabaseName database)` Creates a new session.
`Session`	`createSession(String database)` Creates a new session.
`UnaryCallable<CreateSessionRequest,Session>`	`createSessionCallable()` Creates a new session.
`void`	`deleteSession(DeleteSessionRequest request)` Ends a session, releasing server resources associated with it.
`void`	`deleteSession(SessionName name)` Ends a session, releasing server resources associated with it.
`void`	`deleteSession(String name)` Ends a session, releasing server resources associated with it.
`UnaryCallable<DeleteSessionRequest,Empty>`	`deleteSessionCallable()` Ends a session, releasing server resources associated with it.
`ExecuteBatchDmlResponse`	`executeBatchDml(ExecuteBatchDmlRequest request)` Executes a batch of SQL DML statements.
`UnaryCallable<ExecuteBatchDmlRequest,ExecuteBatchDmlResponse>`	`executeBatchDmlCallable()` Executes a batch of SQL DML statements.
`ResultSet`	`executeSql(ExecuteSqlRequest request)` Executes an SQL statement, returning all results in a single reply.
`UnaryCallable<ExecuteSqlRequest,ResultSet>`	`executeSqlCallable()` Executes an SQL statement, returning all results in a single reply.
`ServerStreamingCallable<ExecuteSqlRequest,PartialResultSet>`	`executeStreamingSqlCallable()` Like [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql], except returns the result set as a stream.
`Session`	`getSession(GetSessionRequest request)` Gets a session.
`Session`	`getSession(SessionName name)` Gets a session.
`Session`	`getSession(String name)` Gets a session.
`UnaryCallable<GetSessionRequest,Session>`	`getSessionCallable()` Gets a session.
`SpannerSettings`	`getSettings()`
`SpannerStub`	`getStub()`
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`SpannerClient.ListSessionsPagedResponse`	`listSessions(DatabaseName database)` Lists all sessions in a given database.
`SpannerClient.ListSessionsPagedResponse`	`listSessions(ListSessionsRequest request)` Lists all sessions in a given database.
`SpannerClient.ListSessionsPagedResponse`	`listSessions(String database)` Lists all sessions in a given database.
`UnaryCallable<ListSessionsRequest,ListSessionsResponse>`	`listSessionsCallable()` Lists all sessions in a given database.
`UnaryCallable<ListSessionsRequest,SpannerClient.ListSessionsPagedResponse>`	`listSessionsPagedCallable()` Lists all sessions in a given database.
`PartitionResponse`	`partitionQuery(PartitionQueryRequest request)` Creates a set of partition tokens that can be used to execute a query operation in parallel.
`UnaryCallable<PartitionQueryRequest,PartitionResponse>`	`partitionQueryCallable()` Creates a set of partition tokens that can be used to execute a query operation in parallel.
`PartitionResponse`	`partitionRead(PartitionReadRequest request)` Creates a set of partition tokens that can be used to execute a read operation in parallel.
`UnaryCallable<PartitionReadRequest,PartitionResponse>`	`partitionReadCallable()` Creates a set of partition tokens that can be used to execute a read operation in parallel.
`ResultSet`	`read(ReadRequest request)` Reads rows from the database using key lookups and scans, as a simple key/value style alternative to [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql].
`UnaryCallable<ReadRequest,ResultSet>`	`readCallable()` Reads rows from the database using key lookups and scans, as a simple key/value style alternative to [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql].
`void`	`rollback(RollbackRequest request)` Rolls back a transaction, releasing any locks it holds.
`void`	`rollback(SessionName session, ByteString transactionId)` Rolls back a transaction, releasing any locks it holds.
`void`	`rollback(String session, ByteString transactionId)` Rolls back a transaction, releasing any locks it holds.
`UnaryCallable<RollbackRequest,Empty>`	`rollbackCallable()` Rolls back a transaction, releasing any locks it holds.
`void`	`shutdown()`
`void`	`shutdownNow()`
`ServerStreamingCallable<ReadRequest,PartialResultSet>`	`streamingReadCallable()` Like [Read][google.spanner.v1.Spanner.Read], except returns the result set as a stream.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- SpannerClient
```
protected SpannerClient(SpannerSettings settings)
                 throws IOException
```
  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.
  
  Throws:
  
  IOException
- SpannerClient
```
@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
protected SpannerClient(SpannerStub stub)
```

Method Detail

create

public static final SpannerClient create()
                                  throws IOException

Constructs an instance of SpannerClient with default settings.

Throws:: IOException

create
```
public static final SpannerClient create(SpannerSettings settings)
                                  throws IOException
```
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.

Throws:

IOException

create

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
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).

getSettings

public final SpannerSettings getSettings()

getStub

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public SpannerStub getStub()

createSession
```
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.
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:
```
 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (SpannerClient spannerClient = SpannerClient.create()) {
   DatabaseName database = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]");
   Session response = spannerClient.createSession(database);
 }
 
```
Parameters:

database - Required. The database in which the new session is created.

Throws:

ApiException - if the remote call fails

createSession
```
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.
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:
```
 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (SpannerClient spannerClient = SpannerClient.create()) {
   String database = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString();
   Session response = spannerClient.createSession(database);
 }
 
```
Parameters:

database - Required. The database in which the new session is created.

Throws:

ApiException - if the remote call fails

createSession
```
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:
```
 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 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);
 }
 
```
Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

ApiException - if the remote call fails

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.
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:
```
 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (SpannerClient spannerClient = SpannerClient.create()) {
   CreateSessionRequest request =
       CreateSessionRequest.newBuilder()
           .setDatabase(DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString())
           .setSession(Session.newBuilder().build())
           .build();
   ApiFuture<Session> future = spannerClient.createSessionCallable().futureCall(request);
   // Do something.
   Session response = future.get();
 }
 
```

batchCreateSessions
```
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:
```
 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (SpannerClient spannerClient = SpannerClient.create()) {
   DatabaseName database = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]");
   int sessionCount = 185691686;
   BatchCreateSessionsResponse response =
       spannerClient.batchCreateSessions(database, sessionCount);
 }
 
```
Parameters:

database - Required. The database in which the new sessions are created.

sessionCount - 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][google.spanner.v1.BatchCreateSessionsRequest.session_count] as necessary).

Throws:

ApiException - if the remote call fails

batchCreateSessions
```
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:
```
 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (SpannerClient spannerClient = SpannerClient.create()) {
   String database = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString();
   int sessionCount = 185691686;
   BatchCreateSessionsResponse response =
       spannerClient.batchCreateSessions(database, sessionCount);
 }
 
```
Parameters:

database - Required. The database in which the new sessions are created.

sessionCount - 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][google.spanner.v1.BatchCreateSessionsRequest.session_count] as necessary).

Throws:

ApiException - if the remote call fails

batchCreateSessions

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:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 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);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: ApiException - if the remote call fails

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:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (SpannerClient spannerClient = SpannerClient.create()) {
   BatchCreateSessionsRequest request =
       BatchCreateSessionsRequest.newBuilder()
           .setDatabase(DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString())
           .setSessionTemplate(Session.newBuilder().build())
           .setSessionCount(185691686)
           .build();
   ApiFuture<BatchCreateSessionsResponse> future =
       spannerClient.batchCreateSessionsCallable().futureCall(request);
   // Do something.
   BatchCreateSessionsResponse response = future.get();
 }

getSession

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:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (SpannerClient spannerClient = SpannerClient.create()) {
   SessionName name = SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]");
   Session response = spannerClient.getSession(name);
 }

Parameters:: name - Required. The name of the session to retrieve.
Throws:: ApiException - if the remote call fails

getSession

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:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (SpannerClient spannerClient = SpannerClient.create()) {
   String name = SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString();
   Session response = spannerClient.getSession(name);
 }

Parameters:: name - Required. The name of the session to retrieve.
Throws:: ApiException - if the remote call fails

getSession

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:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (SpannerClient spannerClient = SpannerClient.create()) {
   GetSessionRequest request =
       GetSessionRequest.newBuilder()
           .setName(
               SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString())
           .build();
   Session response = spannerClient.getSession(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: ApiException - if the remote call fails

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:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (SpannerClient spannerClient = SpannerClient.create()) {
   GetSessionRequest request =
       GetSessionRequest.newBuilder()
           .setName(
               SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString())
           .build();
   ApiFuture<Session> future = spannerClient.getSessionCallable().futureCall(request);
   // Do something.
   Session response = future.get();
 }