com.yandex.ydb.table.rpc.grpc

Class GrpcTableRpc

java.lang.Object

com.yandex.ydb.table.rpc.grpc.GrpcTableRpc

All Implemented Interfaces:

Rpc, TableRpc, AutoCloseable

@ParametersAreNonnullByDefault
public final class GrpcTableRpc
extends Object
implements TableRpc

Author:

Sergey Polovko

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Result<com.yandex.ydb.table.YdbTable.AlterTableResponse>>	alterTable(com.yandex.ydb.table.YdbTable.AlterTableRequest request, long deadlineAfter) Modifies schema of given table.
CompletableFuture<Result<com.yandex.ydb.table.YdbTable.BeginTransactionResponse>>	beginTransaction(com.yandex.ydb.table.YdbTable.BeginTransactionRequest request, long deadlineAfter) Begins new transaction.
CompletableFuture<Result<com.yandex.ydb.table.YdbTable.BulkUpsertResponse>>	bulkUpsert(com.yandex.ydb.table.YdbTable.BulkUpsertRequest request, long deadlineAfter) Execute bulk upsert
void	close()
CompletableFuture<Result<com.yandex.ydb.table.YdbTable.CommitTransactionResponse>>	commitTransaction(com.yandex.ydb.table.YdbTable.CommitTransactionRequest request, long deadlineAfter) Commits specified active transaction.
CompletableFuture<Result<com.yandex.ydb.table.YdbTable.CopyTableResponse>>	copyTable(com.yandex.ydb.table.YdbTable.CopyTableRequest request, long deadlineAfter) Creates copy of given table.
CompletableFuture<Result<com.yandex.ydb.table.YdbTable.CreateSessionResponse>>	createSession(com.yandex.ydb.table.YdbTable.CreateSessionRequest request, long deadlineAfter) Create new session.
CompletableFuture<Result<com.yandex.ydb.table.YdbTable.CreateTableResponse>>	createTable(com.yandex.ydb.table.YdbTable.CreateTableRequest request, long deadlineAfter) Creates new table.
CompletableFuture<Result<com.yandex.ydb.table.YdbTable.DeleteSessionResponse>>	deleteSession(com.yandex.ydb.table.YdbTable.DeleteSessionRequest request, long deadlineAfter) Ends a session, releasing server resources associated with it.
CompletableFuture<Result<com.yandex.ydb.table.YdbTable.DescribeTableResponse>>	describeTable(com.yandex.ydb.table.YdbTable.DescribeTableRequest request, long deadlineAfter) Returns information about given table (metadata).
CompletableFuture<Result<com.yandex.ydb.table.YdbTable.DropTableResponse>>	dropTable(com.yandex.ydb.table.YdbTable.DropTableRequest request, long deadlineAfter) Drop table.
CompletableFuture<Result<com.yandex.ydb.table.YdbTable.ExecuteDataQueryResponse>>	executeDataQuery(com.yandex.ydb.table.YdbTable.ExecuteDataQueryRequest request, long deadlineAfter) Executes data query.
CompletableFuture<Result<com.yandex.ydb.table.YdbTable.ExecuteSchemeQueryResponse>>	executeSchemeQuery(com.yandex.ydb.table.YdbTable.ExecuteSchemeQueryRequest request, long deadlineAfter) Executes scheme query.
CompletableFuture<Result<com.yandex.ydb.table.YdbTable.ExplainDataQueryResponse>>	explainDataQuery(com.yandex.ydb.table.YdbTable.ExplainDataQueryRequest request, long deadlineAfter) Explains data query.
String	getDatabase()
OperationTray	getOperationTray()
CompletableFuture<Result<com.yandex.ydb.table.YdbTable.KeepAliveResponse>>	keepAlive(com.yandex.ydb.table.YdbTable.KeepAliveRequest request, long deadlineAfter) Idle sessions can be kept alive by calling KeepAlive periodically.
static GrpcTableRpc	ownTransport(RpcTransport transport)
CompletableFuture<Result<com.yandex.ydb.table.YdbTable.PrepareDataQueryResponse>>	prepareDataQuery(com.yandex.ydb.table.YdbTable.PrepareDataQueryRequest request, long deadlineAfter) Prepares data query, returns query id.
CompletableFuture<Result<com.yandex.ydb.table.YdbTable.RollbackTransactionResponse>>	rollbackTransaction(com.yandex.ydb.table.YdbTable.RollbackTransactionRequest request, long deadlineAfter) Performs a rollback of the specified active transaction.
StreamControl	streamExecuteScanQuery(com.yandex.ydb.table.YdbTable.ExecuteScanQueryRequest request, StreamObserver<com.yandex.ydb.table.YdbTable.ExecuteScanQueryPartialResponse> observer, long deadlineAfter) Streaming execute scan query.
StreamControl	streamReadTable(com.yandex.ydb.table.YdbTable.ReadTableRequest request, StreamObserver<com.yandex.ydb.table.YdbTable.ReadTableResponse> observer, long deadlineAfter) Streaming read table.
static GrpcTableRpc	useTransport(RpcTransport transport)

Methods inherited from class java.lang.Object

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

Method Detail

useTransport

@Nullable
public static GrpcTableRpc useTransport(@WillNotClose
                                                  RpcTransport transport)

ownTransport

@Nullable
public static GrpcTableRpc ownTransport(@WillClose
                                                  RpcTransport transport)

createSession

public CompletableFuture<Result<com.yandex.ydb.table.YdbTable.CreateSessionResponse>> createSession(com.yandex.ydb.table.YdbTable.CreateSessionRequest request,
                                                                                                    long deadlineAfter)

Description copied from interface: TableRpc

Create new session. Implicit session creation is forbidden, so user must create new session before execute any query, otherwise BAD_SESSION status wil be returned. Simultaneous execution of requests are forbidden. Sessions are volatile, can be invalidated by server, e.g. in case of fatal errors. All requests with this session will fail with BAD_SESSION status. So, client must be able to handle BAD_SESSION status.

Specified by:

createSession in interface TableRpc

deleteSession

public CompletableFuture<Result<com.yandex.ydb.table.YdbTable.DeleteSessionResponse>> deleteSession(com.yandex.ydb.table.YdbTable.DeleteSessionRequest request,
                                                                                                    long deadlineAfter)

Description copied from interface: TableRpc

Ends a session, releasing server resources associated with it.

Specified by:

deleteSession in interface TableRpc

keepAlive

public CompletableFuture<Result<com.yandex.ydb.table.YdbTable.KeepAliveResponse>> keepAlive(com.yandex.ydb.table.YdbTable.KeepAliveRequest request,
                                                                                            long deadlineAfter)

Description copied from interface: TableRpc

Idle sessions can be kept alive by calling KeepAlive periodically.

Specified by:

keepAlive in interface TableRpc

createTable

public CompletableFuture<Result<com.yandex.ydb.table.YdbTable.CreateTableResponse>> createTable(com.yandex.ydb.table.YdbTable.CreateTableRequest request,
                                                                                                long deadlineAfter)

Description copied from interface: TableRpc

Creates new table.

Specified by:

createTable in interface TableRpc

dropTable

public CompletableFuture<Result<com.yandex.ydb.table.YdbTable.DropTableResponse>> dropTable(com.yandex.ydb.table.YdbTable.DropTableRequest request,
                                                                                            long deadlineAfter)

Description copied from interface: TableRpc

Drop table.

Specified by:

dropTable in interface TableRpc

alterTable

public CompletableFuture<Result<com.yandex.ydb.table.YdbTable.AlterTableResponse>> alterTable(com.yandex.ydb.table.YdbTable.AlterTableRequest request,
                                                                                              long deadlineAfter)

Description copied from interface: TableRpc

Modifies schema of given table.

Specified by:

alterTable in interface TableRpc

copyTable

public CompletableFuture<Result<com.yandex.ydb.table.YdbTable.CopyTableResponse>> copyTable(com.yandex.ydb.table.YdbTable.CopyTableRequest request,
                                                                                            long deadlineAfter)

Description copied from interface: TableRpc

Creates copy of given table.

Specified by:

copyTable in interface TableRpc

describeTable

public CompletableFuture<Result<com.yandex.ydb.table.YdbTable.DescribeTableResponse>> describeTable(com.yandex.ydb.table.YdbTable.DescribeTableRequest request,
                                                                                                    long deadlineAfter)

Description copied from interface: TableRpc

Returns information about given table (metadata).

Specified by:

describeTable in interface TableRpc

explainDataQuery

public CompletableFuture<Result<com.yandex.ydb.table.YdbTable.ExplainDataQueryResponse>> explainDataQuery(com.yandex.ydb.table.YdbTable.ExplainDataQueryRequest request,
                                                                                                          long deadlineAfter)

Description copied from interface: TableRpc

Explains data query. SessionId of previously created session must be provided.

Specified by:

explainDataQuery in interface TableRpc

prepareDataQuery

public CompletableFuture<Result<com.yandex.ydb.table.YdbTable.PrepareDataQueryResponse>> prepareDataQuery(com.yandex.ydb.table.YdbTable.PrepareDataQueryRequest request,
                                                                                                          long deadlineAfter)

Description copied from interface: TableRpc

Prepares data query, returns query id. SessionId of previously created session must be provided.

Specified by:

prepareDataQuery in interface TableRpc

executeDataQuery

public CompletableFuture<Result<com.yandex.ydb.table.YdbTable.ExecuteDataQueryResponse>> executeDataQuery(com.yandex.ydb.table.YdbTable.ExecuteDataQueryRequest request,
                                                                                                          long deadlineAfter)

Description copied from interface: TableRpc

Executes data query. SessionId of previously created session must be provided.

Specified by:

executeDataQuery in interface TableRpc

executeSchemeQuery

public CompletableFuture<Result<com.yandex.ydb.table.YdbTable.ExecuteSchemeQueryResponse>> executeSchemeQuery(com.yandex.ydb.table.YdbTable.ExecuteSchemeQueryRequest request,
                                                                                                              long deadlineAfter)

Description copied from interface: TableRpc

Executes scheme query. SessionId of previously created session must be provided.

Specified by:

executeSchemeQuery in interface TableRpc

beginTransaction

public CompletableFuture<Result<com.yandex.ydb.table.YdbTable.BeginTransactionResponse>> beginTransaction(com.yandex.ydb.table.YdbTable.BeginTransactionRequest request,
                                                                                                          long deadlineAfter)

Description copied from interface: TableRpc

Begins new transaction.

Specified by:

beginTransaction in interface TableRpc

commitTransaction

public CompletableFuture<Result<com.yandex.ydb.table.YdbTable.CommitTransactionResponse>> commitTransaction(com.yandex.ydb.table.YdbTable.CommitTransactionRequest request,
                                                                                                            long deadlineAfter)

Description copied from interface: TableRpc

Commits specified active transaction.

Specified by:

commitTransaction in interface TableRpc

rollbackTransaction

public CompletableFuture<Result<com.yandex.ydb.table.YdbTable.RollbackTransactionResponse>> rollbackTransaction(com.yandex.ydb.table.YdbTable.RollbackTransactionRequest request,
                                                                                                                long deadlineAfter)

Description copied from interface: TableRpc

Performs a rollback of the specified active transaction.

Specified by:

rollbackTransaction in interface TableRpc

streamReadTable

public StreamControl streamReadTable(com.yandex.ydb.table.YdbTable.ReadTableRequest request,
                                     StreamObserver<com.yandex.ydb.table.YdbTable.ReadTableResponse> observer,
                                     long deadlineAfter)

Description copied from interface: TableRpc

Streaming read table.

Specified by:

streamReadTable in interface TableRpc

streamExecuteScanQuery

public StreamControl streamExecuteScanQuery(com.yandex.ydb.table.YdbTable.ExecuteScanQueryRequest request,
                                            StreamObserver<com.yandex.ydb.table.YdbTable.ExecuteScanQueryPartialResponse> observer,
                                            long deadlineAfter)

Description copied from interface: TableRpc

Streaming execute scan query.

Specified by:

streamExecuteScanQuery in interface TableRpc

bulkUpsert

public CompletableFuture<Result<com.yandex.ydb.table.YdbTable.BulkUpsertResponse>> bulkUpsert(com.yandex.ydb.table.YdbTable.BulkUpsertRequest request,
                                                                                              long deadlineAfter)

Description copied from interface: TableRpc

Execute bulk upsert

Specified by:

bulkUpsert in interface TableRpc

getDatabase

public String getDatabase()

Specified by:

getDatabase in interface Rpc

getOperationTray

public OperationTray getOperationTray()

Specified by:

getOperationTray in interface Rpc

close

public void close()

Specified by:

close in interface Rpc

Specified by:

close in interface AutoCloseable