com.google.spanner.v1

Class SpannerGrpc.SpannerFutureStub

java.lang.Object

io.grpc.stub.AbstractStub<SpannerGrpc.SpannerFutureStub>

com.google.spanner.v1.SpannerGrpc.SpannerFutureStub

Enclosing class:

SpannerGrpc

public static final class SpannerGrpc.SpannerFutureStub
extends io.grpc.stub.AbstractStub<SpannerGrpc.SpannerFutureStub>

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

Method Summary

Modifier and Type	Method and Description
com.google.common.util.concurrent.ListenableFuture<Transaction>	beginTransaction(BeginTransactionRequest request) Begins a new transaction.
protected SpannerGrpc.SpannerFutureStub	build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
com.google.common.util.concurrent.ListenableFuture<CommitResponse>	commit(CommitRequest request) Commits a transaction.
com.google.common.util.concurrent.ListenableFuture<Session>	createSession(CreateSessionRequest request) Creates a new session.
com.google.common.util.concurrent.ListenableFuture<Empty>	deleteSession(DeleteSessionRequest request) Ends a session, releasing server resources associated with it.
com.google.common.util.concurrent.ListenableFuture<ResultSet>	executeSql(ExecuteSqlRequest request) Executes an SQL query, returning all rows in a single reply.
com.google.common.util.concurrent.ListenableFuture<Session>	getSession(GetSessionRequest request) Gets a session.
com.google.common.util.concurrent.ListenableFuture<ListSessionsResponse>	listSessions(ListSessionsRequest request) Lists all sessions in a given database.
com.google.common.util.concurrent.ListenableFuture<PartitionResponse>	partitionQuery(PartitionQueryRequest request) Creates a set of partition tokens that can be used to execute a query operation in parallel.
com.google.common.util.concurrent.ListenableFuture<PartitionResponse>	partitionRead(PartitionReadRequest request) Creates a set of partition tokens that can be used to execute a read operation in parallel.
com.google.common.util.concurrent.ListenableFuture<ResultSet>	read(ReadRequest request) Reads rows from the database using key lookups and scans, as a simple key/value style alternative to [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql].
com.google.common.util.concurrent.ListenableFuture<Empty>	rollback(RollbackRequest request) Rolls back a transaction, releasing any locks it holds.

Methods inherited from class io.grpc.stub.AbstractStub

getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, withExecutor, withInterceptors, withMaxInboundMessageSize, withMaxOutboundMessageSize, withOption, withWaitForReady

Methods inherited from class java.lang.Object

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

Method Detail

build

protected SpannerGrpc.SpannerFutureStub build(io.grpc.Channel channel,
                                              io.grpc.CallOptions callOptions)

Specified by:

build in class io.grpc.stub.AbstractStub<SpannerGrpc.SpannerFutureStub>

createSession

public com.google.common.util.concurrent.ListenableFuture<Session> createSession(CreateSessionRequest request)

 Creates a new session. A session can be used to perform
 transactions that read and/or modify data in a Cloud Spanner database.
 Sessions are meant to be reused for many consecutive
 transactions.
 Sessions can only execute one transaction at a time. To execute
 multiple concurrent read-write/write-only transactions, create
 multiple sessions. Note that standalone reads and queries use a
 transaction internally, and count toward the one transaction
 limit.
 Cloud Spanner limits the number of sessions that can exist at any given
 time; thus, it is a good idea to delete idle and/or unneeded sessions.
 Aside from explicit deletes, Cloud Spanner can 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"`.
 

getSession

public com.google.common.util.concurrent.ListenableFuture<Session> getSession(GetSessionRequest request)

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

listSessions

public com.google.common.util.concurrent.ListenableFuture<ListSessionsResponse> listSessions(ListSessionsRequest request)

 Lists all sessions in a given database.
 

deleteSession

public com.google.common.util.concurrent.ListenableFuture<Empty> deleteSession(DeleteSessionRequest request)

 Ends a session, releasing server resources associated with it.
 

executeSql

public com.google.common.util.concurrent.ListenableFuture<ResultSet> executeSql(ExecuteSqlRequest request)

 Executes an SQL query, returning all rows 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.
 Queries 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.
 

read

public com.google.common.util.concurrent.ListenableFuture<ResultSet> read(ReadRequest request)

 Reads rows from the database using key lookups and scans, as a
 simple key/value style alternative to
 [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql].  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.
 

beginTransaction

public com.google.common.util.concurrent.ListenableFuture<Transaction> beginTransaction(BeginTransactionRequest request)

 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.
 

commit

public com.google.common.util.concurrent.ListenableFuture<CommitResponse> commit(CommitRequest request)

 Commits a transaction. The request includes the mutations to be
 applied to rows in the database.
 `Commit` might return an `ABORTED` error. This can occur at any time;
 commonly, the cause is conflicts with concurrent
 transactions. However, it can also happen for a variety of other
 reasons. If `Commit` returns `ABORTED`, the caller should re-attempt
 the transaction from the beginning, re-using the same session.
 

rollback

public com.google.common.util.concurrent.ListenableFuture<Empty> rollback(RollbackRequest request)

 Rolls back a transaction, releasing any locks it holds. It is a good
 idea to call this for any transaction that includes one or more
 [Read][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`.
 

partitionQuery

public com.google.common.util.concurrent.ListenableFuture<PartitionResponse> partitionQuery(PartitionQueryRequest request)

 Creates a set of partition tokens that can be used to execute a query
 operation in parallel.  Each of the returned partition tokens can be used
 by [ExecuteStreamingSql][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 or begins a new transaction.
 

partitionRead

public com.google.common.util.concurrent.ListenableFuture<PartitionResponse> partitionRead(PartitionReadRequest request)

 Creates a set of partition tokens that can be used to execute a read
 operation in parallel.  Each of the returned partition tokens can be used
 by [StreamingRead][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.
 Partition tokens become invalid when the session used to create them
 is deleted or begins a new transaction.