com.google.cloud.spanner.v1.SpannerClient Maven / Gradle / Ivy
Show all versions of google-cloud-spanner Show documentation
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.cloud.spanner.v1;
import com.google.api.core.ApiFuture;
import com.google.api.core.ApiFutures;
import com.google.api.gax.core.BackgroundResource;
import com.google.api.gax.paging.AbstractFixedSizeCollection;
import com.google.api.gax.paging.AbstractPage;
import com.google.api.gax.paging.AbstractPagedListResponse;
import com.google.api.gax.rpc.PageContext;
import com.google.api.gax.rpc.ServerStreamingCallable;
import com.google.api.gax.rpc.UnaryCallable;
import com.google.cloud.spanner.v1.stub.SpannerStub;
import com.google.cloud.spanner.v1.stub.SpannerStubSettings;
import com.google.common.util.concurrent.MoreExecutors;
import com.google.protobuf.ByteString;
import com.google.protobuf.Empty;
import com.google.spanner.v1.BatchCreateSessionsRequest;
import com.google.spanner.v1.BatchCreateSessionsResponse;
import com.google.spanner.v1.BatchWriteRequest;
import com.google.spanner.v1.BatchWriteResponse;
import com.google.spanner.v1.BeginTransactionRequest;
import com.google.spanner.v1.CommitRequest;
import com.google.spanner.v1.CommitResponse;
import com.google.spanner.v1.CreateSessionRequest;
import com.google.spanner.v1.DatabaseName;
import com.google.spanner.v1.DeleteSessionRequest;
import com.google.spanner.v1.ExecuteBatchDmlRequest;
import com.google.spanner.v1.ExecuteBatchDmlResponse;
import com.google.spanner.v1.ExecuteSqlRequest;
import com.google.spanner.v1.GetSessionRequest;
import com.google.spanner.v1.ListSessionsRequest;
import com.google.spanner.v1.ListSessionsResponse;
import com.google.spanner.v1.Mutation;
import com.google.spanner.v1.PartialResultSet;
import com.google.spanner.v1.PartitionQueryRequest;
import com.google.spanner.v1.PartitionReadRequest;
import com.google.spanner.v1.PartitionResponse;
import com.google.spanner.v1.ReadRequest;
import com.google.spanner.v1.ResultSet;
import com.google.spanner.v1.RollbackRequest;
import com.google.spanner.v1.Session;
import com.google.spanner.v1.SessionName;
import com.google.spanner.v1.Transaction;
import com.google.spanner.v1.TransactionOptions;
import java.io.IOException;
import java.util.List;
import java.util.concurrent.TimeUnit;
import javax.annotation.Generated;
// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
* 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:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* 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().
*
*
* Methods
*
* Method
* Description
* Method Variants
*
*
* CreateSession
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"`.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* createSession(CreateSessionRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* createSession(DatabaseName database)
*
createSession(String database)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* createSessionCallable()
*
*
*
*
* BatchCreateSessions
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.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* batchCreateSessions(BatchCreateSessionsRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* batchCreateSessions(DatabaseName database, int sessionCount)
*
batchCreateSessions(String database, int sessionCount)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* batchCreateSessionsCallable()
*
*
*
*
* GetSession
Gets a session. Returns `NOT_FOUND` if the session does not exist. This is mainly useful for determining whether a session is still alive.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* getSession(GetSessionRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* getSession(SessionName name)
*
getSession(String name)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* getSessionCallable()
*
*
*
*
* ListSessions
Lists all sessions in a given database.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* listSessions(ListSessionsRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* listSessions(DatabaseName database)
*
listSessions(String database)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* listSessionsPagedCallable()
*
listSessionsCallable()
*
*
*
*
* DeleteSession
Ends a session, releasing server resources associated with it. This will asynchronously trigger cancellation of any operations that are running with this session.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* deleteSession(DeleteSessionRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* deleteSession(SessionName name)
*
deleteSession(String name)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* deleteSessionCallable()
*
*
*
*
* ExecuteSql
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][google.spanner.v1.Transaction] for more details.
*
Larger result sets can be fetched in streaming fashion by calling [ExecuteStreamingSql][google.spanner.v1.Spanner.ExecuteStreamingSql] instead.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* executeSql(ExecuteSqlRequest request)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* executeSqlCallable()
*
*
*
*
* ExecuteStreamingSql
Like [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql], except returns the result set as a stream. Unlike [ExecuteSql][google.spanner.v1.Spanner.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.
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* executeStreamingSqlCallable()
*
*
*
*
* ExecuteBatchDml
Executes a batch of SQL DML statements. This method allows many statements to be run with lower latency than submitting them sequentially with [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql].
*
Statements are executed in sequential order. A request can succeed even if a statement fails. The [ExecuteBatchDmlResponse.status][google.spanner.v1.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.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* executeBatchDml(ExecuteBatchDmlRequest request)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* executeBatchDmlCallable()
*
*
*
*
* Read
Reads rows from the database using key lookups and scans, as a simple key/value style alternative to [ExecuteSql][google.spanner.v1.Spanner.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][google.spanner.v1.Transaction] for more details.
*
Larger result sets can be yielded in streaming fashion by calling [StreamingRead][google.spanner.v1.Spanner.StreamingRead] instead.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* read(ReadRequest request)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* readCallable()
*
*
*
*
* StreamingRead
Like [Read][google.spanner.v1.Spanner.Read], except returns the result set as a stream. Unlike [Read][google.spanner.v1.Spanner.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.
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* streamingReadCallable()
*
*
*
*
* BeginTransaction
Begins a new transaction. This step can often be skipped: [Read][google.spanner.v1.Spanner.Read], [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql] and [Commit][google.spanner.v1.Spanner.Commit] can begin a new transaction as a side-effect.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* beginTransaction(BeginTransactionRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* beginTransaction(SessionName session, TransactionOptions options)
*
beginTransaction(String session, TransactionOptions options)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* beginTransactionCallable()
*
*
*
*
* Commit
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.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* commit(CommitRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* commit(SessionName session, ByteString transactionId, List<Mutation> mutations)
*
commit(SessionName session, TransactionOptions singleUseTransaction, List<Mutation> mutations)
*
commit(String session, ByteString transactionId, List<Mutation> mutations)
*
commit(String session, TransactionOptions singleUseTransaction, List<Mutation> mutations)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* commitCallable()
*
*
*
*
* Rollback
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][google.spanner.v1.Spanner.Read] or [ExecuteSql][google.spanner.v1.Spanner.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`.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* rollback(RollbackRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* rollback(SessionName session, ByteString transactionId)
*
rollback(String session, ByteString transactionId)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* rollbackCallable()
*
*
*
*
* PartitionQuery
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][google.spanner.v1.Spanner.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.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* partitionQuery(PartitionQueryRequest request)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* partitionQueryCallable()
*
*
*
*
* PartitionRead
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][google.spanner.v1.Spanner.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.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* partitionRead(PartitionReadRequest request)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* partitionReadCallable()
*
*
*
*
* BatchWrite
Batches the supplied mutation groups in a collection of efficient transactions. All mutations in a group are committed atomically. However, mutations across groups can be committed non-atomically in an unspecified order and thus, they must be independent of each other. Partial failure is possible, i.e., some groups may have been committed successfully, while some may have failed. The results of individual batches are streamed into the response as the batches are applied.
*
BatchWrite requests are not replay protected, meaning that each mutation group may be applied more than once. Replays of non-idempotent mutations may have undesirable effects. For example, replays of an insert mutation may produce an already exists error or if you use generated or commit timestamp-based keys, it may result in additional rows being added to the mutation's table. We recommend structuring your mutation groups to be idempotent to avoid this issue.
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* batchWriteCallable()
*
*
*
*
*
* 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:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* SpannerSettings spannerSettings =
* SpannerSettings.newBuilder()
* .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
* .build();
* SpannerClient spannerClient = SpannerClient.create(spannerSettings);
* }
*
* To customize the endpoint:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* SpannerSettings spannerSettings = SpannerSettings.newBuilder().setEndpoint(myEndpoint).build();
* SpannerClient spannerClient = SpannerClient.create(spannerSettings);
* }
*
* To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over
* the wire:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* SpannerSettings spannerSettings = SpannerSettings.newHttpJsonBuilder().build();
* SpannerClient spannerClient = SpannerClient.create(spannerSettings);
* }
*
* Please refer to the GitHub repository's samples for more quickstart code snippets.
*/
@Generated("by gapic-generator-java")
public class SpannerClient implements BackgroundResource {
private final SpannerSettings settings;
private final SpannerStub stub;
/** Constructs an instance of SpannerClient with default settings. */
public static final SpannerClient create() throws IOException {
return create(SpannerSettings.newBuilder().build());
}
/**
* 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.
*/
public static final SpannerClient create(SpannerSettings settings) throws IOException {
return new SpannerClient(settings);
}
/**
* Constructs an instance of SpannerClient, using the given stub for making calls. This is for
* advanced usage - prefer using create(SpannerSettings).
*/
public static final SpannerClient create(SpannerStub stub) {
return new SpannerClient(stub);
}
/**
* 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.
*/
protected SpannerClient(SpannerSettings settings) throws IOException {
this.settings = settings;
this.stub = ((SpannerStubSettings) settings.getStubSettings()).createStub();
}
protected SpannerClient(SpannerStub stub) {
this.settings = null;
this.stub = stub;
}
public final SpannerSettings getSettings() {
return settings;
}
public SpannerStub getStub() {
return stub;
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* 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:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SpannerClient spannerClient = SpannerClient.create()) {
* DatabaseName database = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]");
* Session response = spannerClient.createSession(database);
* }
* }
*
* @param database Required. The database in which the new session is created.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Session createSession(DatabaseName database) {
CreateSessionRequest request =
CreateSessionRequest.newBuilder()
.setDatabase(database == null ? null : database.toString())
.build();
return createSession(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* 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:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SpannerClient spannerClient = SpannerClient.create()) {
* String database = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString();
* Session response = spannerClient.createSession(database);
* }
* }
*
* @param database Required. The database in which the new session is created.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Session createSession(String database) {
CreateSessionRequest request = CreateSessionRequest.newBuilder().setDatabase(database).build();
return createSession(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* 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:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* 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);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Session createSession(CreateSessionRequest request) {
return createSessionCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* 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:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SpannerClient spannerClient = SpannerClient.create()) {
* CreateSessionRequest request =
* CreateSessionRequest.newBuilder()
* .setDatabase(DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString())
* .setSession(Session.newBuilder().build())
* .build();
* ApiFuture future = spannerClient.createSessionCallable().futureCall(request);
* // Do something.
* Session response = future.get();
* }
* }
*/
public final UnaryCallable createSessionCallable() {
return stub.createSessionCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* 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:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SpannerClient spannerClient = SpannerClient.create()) {
* DatabaseName database = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]");
* int sessionCount = 185691686;
* BatchCreateSessionsResponse response =
* spannerClient.batchCreateSessions(database, sessionCount);
* }
* }
*
* @param database Required. The database in which the new sessions are created.
* @param 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 com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final BatchCreateSessionsResponse batchCreateSessions(
DatabaseName database, int sessionCount) {
BatchCreateSessionsRequest request =
BatchCreateSessionsRequest.newBuilder()
.setDatabase(database == null ? null : database.toString())
.setSessionCount(sessionCount)
.build();
return batchCreateSessions(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* 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:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SpannerClient spannerClient = SpannerClient.create()) {
* String database = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString();
* int sessionCount = 185691686;
* BatchCreateSessionsResponse response =
* spannerClient.batchCreateSessions(database, sessionCount);
* }
* }
*
* @param database Required. The database in which the new sessions are created.
* @param 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 com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final BatchCreateSessionsResponse batchCreateSessions(String database, int sessionCount) {
BatchCreateSessionsRequest request =
BatchCreateSessionsRequest.newBuilder()
.setDatabase(database)
.setSessionCount(sessionCount)
.build();
return batchCreateSessions(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* 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:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* 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);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final BatchCreateSessionsResponse batchCreateSessions(BatchCreateSessionsRequest request) {
return batchCreateSessionsCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* 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:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SpannerClient spannerClient = SpannerClient.create()) {
* BatchCreateSessionsRequest request =
* BatchCreateSessionsRequest.newBuilder()
* .setDatabase(DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString())
* .setSessionTemplate(Session.newBuilder().build())
* .setSessionCount(185691686)
* .build();
* ApiFuture future =
* spannerClient.batchCreateSessionsCallable().futureCall(request);
* // Do something.
* BatchCreateSessionsResponse response = future.get();
* }
* }
*/
public final UnaryCallable
batchCreateSessionsCallable() {
return stub.batchCreateSessionsCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* 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:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SpannerClient spannerClient = SpannerClient.create()) {
* SessionName name = SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]");
* Session response = spannerClient.getSession(name);
* }
* }
*
* @param name Required. The name of the session to retrieve.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Session getSession(SessionName name) {
GetSessionRequest request =
GetSessionRequest.newBuilder().setName(name == null ? null : name.toString()).build();
return getSession(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* 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:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SpannerClient spannerClient = SpannerClient.create()) {
* String name = SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString();
* Session response = spannerClient.getSession(name);
* }
* }
*
* @param name Required. The name of the session to retrieve.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Session getSession(String name) {
GetSessionRequest request = GetSessionRequest.newBuilder().setName(name).build();
return getSession(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* 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:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SpannerClient spannerClient = SpannerClient.create()) {
* GetSessionRequest request =
* GetSessionRequest.newBuilder()
* .setName(
* SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString())
* .build();
* Session response = spannerClient.getSession(request);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Session getSession(GetSessionRequest request) {
return getSessionCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* 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:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SpannerClient spannerClient = SpannerClient.create()) {
* GetSessionRequest request =
* GetSessionRequest.newBuilder()
* .setName(
* SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString())
* .build();
* ApiFuture future = spannerClient.getSessionCallable().futureCall(request);
* // Do something.
* Session response = future.get();
* }
* }
*/
public final UnaryCallable getSessionCallable() {
return stub.getSessionCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists all sessions in a given database.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SpannerClient spannerClient = SpannerClient.create()) {
* DatabaseName database = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]");
* for (Session element : spannerClient.listSessions(database).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* @param database Required. The database in which to list sessions.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListSessionsPagedResponse listSessions(DatabaseName database) {
ListSessionsRequest request =
ListSessionsRequest.newBuilder()
.setDatabase(database == null ? null : database.toString())
.build();
return listSessions(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists all sessions in a given database.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SpannerClient spannerClient = SpannerClient.create()) {
* String database = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString();
* for (Session element : spannerClient.listSessions(database).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* @param database Required. The database in which to list sessions.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListSessionsPagedResponse listSessions(String database) {
ListSessionsRequest request = ListSessionsRequest.newBuilder().setDatabase(database).build();
return listSessions(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists all sessions in a given database.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* 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);
* }
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListSessionsPagedResponse listSessions(ListSessionsRequest request) {
return listSessionsPagedCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists all sessions in a given database.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* 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 future = spannerClient.listSessionsPagedCallable().futureCall(request);
* // Do something.
* for (Session element : future.get().iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*/
public final UnaryCallable
listSessionsPagedCallable() {
return stub.listSessionsPagedCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists all sessions in a given database.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* 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.getSessionsList()) {
* // doThingsWith(element);
* }
* String nextPageToken = response.getNextPageToken();
* if (!Strings.isNullOrEmpty(nextPageToken)) {
* request = request.toBuilder().setPageToken(nextPageToken).build();
* } else {
* break;
* }
* }
* }
* }
*/
public final UnaryCallable listSessionsCallable() {
return stub.listSessionsCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* 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:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SpannerClient spannerClient = SpannerClient.create()) {
* SessionName name = SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]");
* spannerClient.deleteSession(name);
* }
* }
*
* @param name Required. The name of the session to delete.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void deleteSession(SessionName name) {
DeleteSessionRequest request =
DeleteSessionRequest.newBuilder().setName(name == null ? null : name.toString()).build();
deleteSession(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* 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:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SpannerClient spannerClient = SpannerClient.create()) {
* String name = SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString();
* spannerClient.deleteSession(name);
* }
* }
*
* @param name Required. The name of the session to delete.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void deleteSession(String name) {
DeleteSessionRequest request = DeleteSessionRequest.newBuilder().setName(name).build();
deleteSession(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* 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:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SpannerClient spannerClient = SpannerClient.create()) {
* DeleteSessionRequest request =
* DeleteSessionRequest.newBuilder()
* .setName(
* SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString())
* .build();
* spannerClient.deleteSession(request);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void deleteSession(DeleteSessionRequest request) {
deleteSessionCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* 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:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SpannerClient spannerClient = SpannerClient.create()) {
* DeleteSessionRequest request =
* DeleteSessionRequest.newBuilder()
* .setName(
* SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString())
* .build();
* ApiFuture future = spannerClient.deleteSessionCallable().futureCall(request);
* // Do something.
* future.get();
* }
* }
*/
public final UnaryCallable deleteSessionCallable() {
return stub.deleteSessionCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* 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][google.spanner.v1.Transaction] for more details.
*
*
Larger result sets can be fetched in streaming fashion by calling
* [ExecuteStreamingSql][google.spanner.v1.Spanner.ExecuteStreamingSql] instead.
*
*
Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* 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())
* .setResumeToken(ByteString.EMPTY)
* .setPartitionToken(ByteString.EMPTY)
* .setSeqno(109325920)
* .setQueryOptions(ExecuteSqlRequest.QueryOptions.newBuilder().build())
* .setRequestOptions(RequestOptions.newBuilder().build())
* .setDirectedReadOptions(DirectedReadOptions.newBuilder().build())
* .setDataBoostEnabled(true)
* .build();
* ResultSet response = spannerClient.executeSql(request);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ResultSet executeSql(ExecuteSqlRequest request) {
return executeSqlCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* 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][google.spanner.v1.Transaction] for more details.
*
*
Larger result sets can be fetched in streaming fashion by calling
* [ExecuteStreamingSql][google.spanner.v1.Spanner.ExecuteStreamingSql] instead.
*
*
Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* 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())
* .setResumeToken(ByteString.EMPTY)
* .setPartitionToken(ByteString.EMPTY)
* .setSeqno(109325920)
* .setQueryOptions(ExecuteSqlRequest.QueryOptions.newBuilder().build())
* .setRequestOptions(RequestOptions.newBuilder().build())
* .setDirectedReadOptions(DirectedReadOptions.newBuilder().build())
* .setDataBoostEnabled(true)
* .build();
* ApiFuture future = spannerClient.executeSqlCallable().futureCall(request);
* // Do something.
* ResultSet response = future.get();
* }
* }
*/
public final UnaryCallable executeSqlCallable() {
return stub.executeSqlCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Like [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql], except returns the result set as a
* stream. Unlike [ExecuteSql][google.spanner.v1.Spanner.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:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* 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())
* .setResumeToken(ByteString.EMPTY)
* .setPartitionToken(ByteString.EMPTY)
* .setSeqno(109325920)
* .setQueryOptions(ExecuteSqlRequest.QueryOptions.newBuilder().build())
* .setRequestOptions(RequestOptions.newBuilder().build())
* .setDirectedReadOptions(DirectedReadOptions.newBuilder().build())
* .setDataBoostEnabled(true)
* .build();
* ServerStream stream =
* spannerClient.executeStreamingSqlCallable().call(request);
* for (PartialResultSet response : stream) {
* // Do something when a response is received.
* }
* }
* }
*/
public final ServerStreamingCallable
executeStreamingSqlCallable() {
return stub.executeStreamingSqlCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Executes a batch of SQL DML statements. This method allows many statements to be run with lower
* latency than submitting them sequentially with
* [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql].
*
* Statements are executed in sequential order. A request can succeed even if a statement
* fails. The [ExecuteBatchDmlResponse.status][google.spanner.v1.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:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SpannerClient spannerClient = SpannerClient.create()) {
* ExecuteBatchDmlRequest request =
* ExecuteBatchDmlRequest.newBuilder()
* .setSession(
* SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString())
* .setTransaction(TransactionSelector.newBuilder().build())
* .addAllStatements(new ArrayList())
* .setSeqno(109325920)
* .setRequestOptions(RequestOptions.newBuilder().build())
* .build();
* ExecuteBatchDmlResponse response = spannerClient.executeBatchDml(request);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ExecuteBatchDmlResponse executeBatchDml(ExecuteBatchDmlRequest request) {
return executeBatchDmlCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Executes a batch of SQL DML statements. This method allows many statements to be run with lower
* latency than submitting them sequentially with
* [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql].
*
* Statements are executed in sequential order. A request can succeed even if a statement
* fails. The [ExecuteBatchDmlResponse.status][google.spanner.v1.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:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SpannerClient spannerClient = SpannerClient.create()) {
* ExecuteBatchDmlRequest request =
* ExecuteBatchDmlRequest.newBuilder()
* .setSession(
* SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString())
* .setTransaction(TransactionSelector.newBuilder().build())
* .addAllStatements(new ArrayList())
* .setSeqno(109325920)
* .setRequestOptions(RequestOptions.newBuilder().build())
* .build();
* ApiFuture future =
* spannerClient.executeBatchDmlCallable().futureCall(request);
* // Do something.
* ExecuteBatchDmlResponse response = future.get();
* }
* }
*/
public final UnaryCallable
executeBatchDmlCallable() {
return stub.executeBatchDmlCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Reads rows from the database using key lookups and scans, as a simple key/value style
* alternative to [ExecuteSql][google.spanner.v1.Spanner.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][google.spanner.v1.Transaction] for more details.
*
*
Larger result sets can be yielded in streaming fashion by calling
* [StreamingRead][google.spanner.v1.Spanner.StreamingRead] instead.
*
*
Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* 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())
* .setKeySet(KeySet.newBuilder().build())
* .setLimit(102976443)
* .setResumeToken(ByteString.EMPTY)
* .setPartitionToken(ByteString.EMPTY)
* .setRequestOptions(RequestOptions.newBuilder().build())
* .setDirectedReadOptions(DirectedReadOptions.newBuilder().build())
* .setDataBoostEnabled(true)
* .build();
* ResultSet response = spannerClient.read(request);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ResultSet read(ReadRequest request) {
return readCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Reads rows from the database using key lookups and scans, as a simple key/value style
* alternative to [ExecuteSql][google.spanner.v1.Spanner.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][google.spanner.v1.Transaction] for more details.
*
*
Larger result sets can be yielded in streaming fashion by calling
* [StreamingRead][google.spanner.v1.Spanner.StreamingRead] instead.
*
*
Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* 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())
* .setKeySet(KeySet.newBuilder().build())
* .setLimit(102976443)
* .setResumeToken(ByteString.EMPTY)
* .setPartitionToken(ByteString.EMPTY)
* .setRequestOptions(RequestOptions.newBuilder().build())
* .setDirectedReadOptions(DirectedReadOptions.newBuilder().build())
* .setDataBoostEnabled(true)
* .build();
* ApiFuture future = spannerClient.readCallable().futureCall(request);
* // Do something.
* ResultSet response = future.get();
* }
* }
*/
public final UnaryCallable readCallable() {
return stub.readCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Like [Read][google.spanner.v1.Spanner.Read], except returns the result set as a stream. Unlike
* [Read][google.spanner.v1.Spanner.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:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* 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())
* .setKeySet(KeySet.newBuilder().build())
* .setLimit(102976443)
* .setResumeToken(ByteString.EMPTY)
* .setPartitionToken(ByteString.EMPTY)
* .setRequestOptions(RequestOptions.newBuilder().build())
* .setDirectedReadOptions(DirectedReadOptions.newBuilder().build())
* .setDataBoostEnabled(true)
* .build();
* ServerStream stream = spannerClient.streamingReadCallable().call(request);
* for (PartialResultSet response : stream) {
* // Do something when a response is received.
* }
* }
* }
*/
public final ServerStreamingCallable streamingReadCallable() {
return stub.streamingReadCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Begins a new transaction. This step can often be skipped:
* [Read][google.spanner.v1.Spanner.Read], [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql] and
* [Commit][google.spanner.v1.Spanner.Commit] can begin a new transaction as a side-effect.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SpannerClient spannerClient = SpannerClient.create()) {
* SessionName session = SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]");
* TransactionOptions options = TransactionOptions.newBuilder().build();
* Transaction response = spannerClient.beginTransaction(session, options);
* }
* }
*
* @param session Required. The session in which the transaction runs.
* @param options Required. Options for the new transaction.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Transaction beginTransaction(SessionName session, TransactionOptions options) {
BeginTransactionRequest request =
BeginTransactionRequest.newBuilder()
.setSession(session == null ? null : session.toString())
.setOptions(options)
.build();
return beginTransaction(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Begins a new transaction. This step can often be skipped:
* [Read][google.spanner.v1.Spanner.Read], [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql] and
* [Commit][google.spanner.v1.Spanner.Commit] can begin a new transaction as a side-effect.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* 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);
* }
* }
*
* @param session Required. The session in which the transaction runs.
* @param options Required. Options for the new transaction.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Transaction beginTransaction(String session, TransactionOptions options) {
BeginTransactionRequest request =
BeginTransactionRequest.newBuilder().setSession(session).setOptions(options).build();
return beginTransaction(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Begins a new transaction. This step can often be skipped:
* [Read][google.spanner.v1.Spanner.Read], [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql] and
* [Commit][google.spanner.v1.Spanner.Commit] can begin a new transaction as a side-effect.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* 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);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Transaction beginTransaction(BeginTransactionRequest request) {
return beginTransactionCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Begins a new transaction. This step can often be skipped:
* [Read][google.spanner.v1.Spanner.Read], [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql] and
* [Commit][google.spanner.v1.Spanner.Commit] can begin a new transaction as a side-effect.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* 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 future = spannerClient.beginTransactionCallable().futureCall(request);
* // Do something.
* Transaction response = future.get();
* }
* }
*/
public final UnaryCallable beginTransactionCallable() {
return stub.beginTransactionCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* 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:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SpannerClient spannerClient = SpannerClient.create()) {
* SessionName session = SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]");
* ByteString transactionId = ByteString.EMPTY;
* List mutations = new ArrayList<>();
* CommitResponse response = spannerClient.commit(session, transactionId, mutations);
* }
* }
*
* @param session Required. The session in which the transaction to be committed is running.
* @param transactionId Commit a previously-started transaction.
* @param mutations The mutations to be executed when this transaction commits. All mutations are
* applied atomically, in the order they appear in this list.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final CommitResponse commit(
SessionName session, ByteString transactionId, List mutations) {
CommitRequest request =
CommitRequest.newBuilder()
.setSession(session == null ? null : session.toString())
.setTransactionId(transactionId)
.addAllMutations(mutations)
.build();
return commit(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* 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:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SpannerClient spannerClient = SpannerClient.create()) {
* SessionName session = SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]");
* TransactionOptions singleUseTransaction = TransactionOptions.newBuilder().build();
* List mutations = new ArrayList<>();
* CommitResponse response = spannerClient.commit(session, singleUseTransaction, mutations);
* }
* }
*
* @param session Required. The session in which the transaction to be committed is running.
* @param singleUseTransaction 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][google.spanner.v1.Spanner.BeginTransaction] and
* [Commit][google.spanner.v1.Spanner.Commit] instead.
* @param mutations The mutations to be executed when this transaction commits. All mutations are
* applied atomically, in the order they appear in this list.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final CommitResponse commit(
SessionName session, TransactionOptions singleUseTransaction, List mutations) {
CommitRequest request =
CommitRequest.newBuilder()
.setSession(session == null ? null : session.toString())
.setSingleUseTransaction(singleUseTransaction)
.addAllMutations(mutations)
.build();
return commit(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* 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:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SpannerClient spannerClient = SpannerClient.create()) {
* String session =
* SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString();
* ByteString transactionId = ByteString.EMPTY;
* List mutations = new ArrayList<>();
* CommitResponse response = spannerClient.commit(session, transactionId, mutations);
* }
* }
*
* @param session Required. The session in which the transaction to be committed is running.
* @param transactionId Commit a previously-started transaction.
* @param mutations The mutations to be executed when this transaction commits. All mutations are
* applied atomically, in the order they appear in this list.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final CommitResponse commit(
String session, ByteString transactionId, List mutations) {
CommitRequest request =
CommitRequest.newBuilder()
.setSession(session)
.setTransactionId(transactionId)
.addAllMutations(mutations)
.build();
return commit(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* 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:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SpannerClient spannerClient = SpannerClient.create()) {
* String session =
* SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString();
* TransactionOptions singleUseTransaction = TransactionOptions.newBuilder().build();
* List mutations = new ArrayList<>();
* CommitResponse response = spannerClient.commit(session, singleUseTransaction, mutations);
* }
* }
*
* @param session Required. The session in which the transaction to be committed is running.
* @param singleUseTransaction 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][google.spanner.v1.Spanner.BeginTransaction] and
* [Commit][google.spanner.v1.Spanner.Commit] instead.
* @param mutations The mutations to be executed when this transaction commits. All mutations are
* applied atomically, in the order they appear in this list.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final CommitResponse commit(
String session, TransactionOptions singleUseTransaction, List mutations) {
CommitRequest request =
CommitRequest.newBuilder()
.setSession(session)
.setSingleUseTransaction(singleUseTransaction)
.addAllMutations(mutations)
.build();
return commit(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* 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:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SpannerClient spannerClient = SpannerClient.create()) {
* CommitRequest request =
* CommitRequest.newBuilder()
* .setSession(
* SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString())
* .addAllMutations(new ArrayList())
* .setReturnCommitStats(true)
* .setMaxCommitDelay(Duration.newBuilder().build())
* .setRequestOptions(RequestOptions.newBuilder().build())
* .build();
* CommitResponse response = spannerClient.commit(request);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final CommitResponse commit(CommitRequest request) {
return commitCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* 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:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SpannerClient spannerClient = SpannerClient.create()) {
* CommitRequest request =
* CommitRequest.newBuilder()
* .setSession(
* SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString())
* .addAllMutations(new ArrayList())
* .setReturnCommitStats(true)
* .setMaxCommitDelay(Duration.newBuilder().build())
* .setRequestOptions(RequestOptions.newBuilder().build())
* .build();
* ApiFuture future = spannerClient.commitCallable().futureCall(request);
* // Do something.
* CommitResponse response = future.get();
* }
* }
*/
public final UnaryCallable commitCallable() {
return stub.commitCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* 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][google.spanner.v1.Spanner.Read] or
* [ExecuteSql][google.spanner.v1.Spanner.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:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SpannerClient spannerClient = SpannerClient.create()) {
* SessionName session = SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]");
* ByteString transactionId = ByteString.EMPTY;
* spannerClient.rollback(session, transactionId);
* }
* }
*
* @param session Required. The session in which the transaction to roll back is running.
* @param transactionId Required. The transaction to roll back.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void rollback(SessionName session, ByteString transactionId) {
RollbackRequest request =
RollbackRequest.newBuilder()
.setSession(session == null ? null : session.toString())
.setTransactionId(transactionId)
.build();
rollback(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* 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][google.spanner.v1.Spanner.Read] or
* [ExecuteSql][google.spanner.v1.Spanner.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:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SpannerClient spannerClient = SpannerClient.create()) {
* String session =
* SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString();
* ByteString transactionId = ByteString.EMPTY;
* spannerClient.rollback(session, transactionId);
* }
* }
*
* @param session Required. The session in which the transaction to roll back is running.
* @param transactionId Required. The transaction to roll back.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void rollback(String session, ByteString transactionId) {
RollbackRequest request =
RollbackRequest.newBuilder().setSession(session).setTransactionId(transactionId).build();
rollback(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* 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][google.spanner.v1.Spanner.Read] or
* [ExecuteSql][google.spanner.v1.Spanner.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:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SpannerClient spannerClient = SpannerClient.create()) {
* RollbackRequest request =
* RollbackRequest.newBuilder()
* .setSession(
* SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString())
* .setTransactionId(ByteString.EMPTY)
* .build();
* spannerClient.rollback(request);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void rollback(RollbackRequest request) {
rollbackCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* 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][google.spanner.v1.Spanner.Read] or
* [ExecuteSql][google.spanner.v1.Spanner.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:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SpannerClient spannerClient = SpannerClient.create()) {
* RollbackRequest request =
* RollbackRequest.newBuilder()
* .setSession(
* SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString())
* .setTransactionId(ByteString.EMPTY)
* .build();
* ApiFuture future = spannerClient.rollbackCallable().futureCall(request);
* // Do something.
* future.get();
* }
* }
*/
public final UnaryCallable rollbackCallable() {
return stub.rollbackCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* 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][google.spanner.v1.Spanner.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:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* 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())
* .setPartitionOptions(PartitionOptions.newBuilder().build())
* .build();
* PartitionResponse response = spannerClient.partitionQuery(request);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final PartitionResponse partitionQuery(PartitionQueryRequest request) {
return partitionQueryCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* 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][google.spanner.v1.Spanner.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:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* 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())
* .setPartitionOptions(PartitionOptions.newBuilder().build())
* .build();
* ApiFuture future =
* spannerClient.partitionQueryCallable().futureCall(request);
* // Do something.
* PartitionResponse response = future.get();
* }
* }
*/
public final UnaryCallable partitionQueryCallable() {
return stub.partitionQueryCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* 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][google.spanner.v1.Spanner.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:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* 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())
* .setKeySet(KeySet.newBuilder().build())
* .setPartitionOptions(PartitionOptions.newBuilder().build())
* .build();
* PartitionResponse response = spannerClient.partitionRead(request);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final PartitionResponse partitionRead(PartitionReadRequest request) {
return partitionReadCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* 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][google.spanner.v1.Spanner.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:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* 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())
* .setKeySet(KeySet.newBuilder().build())
* .setPartitionOptions(PartitionOptions.newBuilder().build())
* .build();
* ApiFuture future =
* spannerClient.partitionReadCallable().futureCall(request);
* // Do something.
* PartitionResponse response = future.get();
* }
* }
*/
public final UnaryCallable partitionReadCallable() {
return stub.partitionReadCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Batches the supplied mutation groups in a collection of efficient transactions. All mutations
* in a group are committed atomically. However, mutations across groups can be committed
* non-atomically in an unspecified order and thus, they must be independent of each other.
* Partial failure is possible, i.e., some groups may have been committed successfully, while some
* may have failed. The results of individual batches are streamed into the response as the
* batches are applied.
*
* BatchWrite requests are not replay protected, meaning that each mutation group may be
* applied more than once. Replays of non-idempotent mutations may have undesirable effects. For
* example, replays of an insert mutation may produce an already exists error or if you use
* generated or commit timestamp-based keys, it may result in additional rows being added to the
* mutation's table. We recommend structuring your mutation groups to be idempotent to avoid this
* issue.
*
*
Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SpannerClient spannerClient = SpannerClient.create()) {
* BatchWriteRequest request =
* BatchWriteRequest.newBuilder()
* .setSession(
* SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString())
* .setRequestOptions(RequestOptions.newBuilder().build())
* .addAllMutationGroups(new ArrayList())
* .setExcludeTxnFromChangeStreams(true)
* .build();
* ServerStream stream = spannerClient.batchWriteCallable().call(request);
* for (BatchWriteResponse response : stream) {
* // Do something when a response is received.
* }
* }
* }
*/
public final ServerStreamingCallable batchWriteCallable() {
return stub.batchWriteCallable();
}
@Override
public final void close() {
stub.close();
}
@Override
public void shutdown() {
stub.shutdown();
}
@Override
public boolean isShutdown() {
return stub.isShutdown();
}
@Override
public boolean isTerminated() {
return stub.isTerminated();
}
@Override
public void shutdownNow() {
stub.shutdownNow();
}
@Override
public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException {
return stub.awaitTermination(duration, unit);
}
public static class ListSessionsPagedResponse
extends AbstractPagedListResponse<
ListSessionsRequest,
ListSessionsResponse,
Session,
ListSessionsPage,
ListSessionsFixedSizeCollection> {
public static ApiFuture createAsync(
PageContext context,
ApiFuture futureResponse) {
ApiFuture futurePage =
ListSessionsPage.createEmptyPage().createPageAsync(context, futureResponse);
return ApiFutures.transform(
futurePage,
input -> new ListSessionsPagedResponse(input),
MoreExecutors.directExecutor());
}
private ListSessionsPagedResponse(ListSessionsPage page) {
super(page, ListSessionsFixedSizeCollection.createEmptyCollection());
}
}
public static class ListSessionsPage
extends AbstractPage {
private ListSessionsPage(
PageContext context,
ListSessionsResponse response) {
super(context, response);
}
private static ListSessionsPage createEmptyPage() {
return new ListSessionsPage(null, null);
}
@Override
protected ListSessionsPage createPage(
PageContext context,
ListSessionsResponse response) {
return new ListSessionsPage(context, response);
}
@Override
public ApiFuture createPageAsync(
PageContext context,
ApiFuture futureResponse) {
return super.createPageAsync(context, futureResponse);
}
}
public static class ListSessionsFixedSizeCollection
extends AbstractFixedSizeCollection<
ListSessionsRequest,
ListSessionsResponse,
Session,
ListSessionsPage,
ListSessionsFixedSizeCollection> {
private ListSessionsFixedSizeCollection(List pages, int collectionSize) {
super(pages, collectionSize);
}
private static ListSessionsFixedSizeCollection createEmptyCollection() {
return new ListSessionsFixedSizeCollection(null, 0);
}
@Override
protected ListSessionsFixedSizeCollection createCollection(
List pages, int collectionSize) {
return new ListSessionsFixedSizeCollection(pages, collectionSize);
}
}
}