com.yandex.ydb.table.rpc

Interface TableRpc

All Superinterfaces:

AutoCloseable, Rpc

All Known Implementing Classes:

GrpcTableRpc

public interface TableRpc
extends Rpc

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
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.
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.
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.

Methods inherited from interface com.yandex.ydb.core.rpc.Rpc

close, getDatabase, getOperationTray

Method Detail

createSession

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

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.

deleteSession

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.

keepAlive

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.

createTable

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

Creates new table.

dropTable

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

Drop table.

alterTable

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

Modifies schema of given table.

copyTable

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

Creates copy of given table.

describeTable

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

Returns information about given table (metadata).

explainDataQuery

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

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

prepareDataQuery

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

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

executeDataQuery

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

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

executeSchemeQuery

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

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

beginTransaction

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

Begins new transaction.

commitTransaction

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

Commits specified active transaction.

rollbackTransaction

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.

streamReadTable

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

Streaming read table.

streamExecuteScanQuery

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

Streaming execute scan query.

bulkUpsert

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

Execute bulk upsert