tech.ydb.table.rpc.grpc

Class GrpcTableRpc

java.lang.Object

tech.ydb.table.rpc.grpc.GrpcTableRpc

All Implemented Interfaces:

AutoCloseable, TableRpc

@ParametersAreNonnullByDefault
public final class GrpcTableRpc
extends Object
implements TableRpc

Author:

Sergey Polovko

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Status>	alterTable(tech.ydb.proto.table.YdbTable.AlterTableRequest request, GrpcRequestSettings settings) Modifies schema of given table.
CompletableFuture<Result<tech.ydb.proto.table.YdbTable.BeginTransactionResult>>	beginTransaction(tech.ydb.proto.table.YdbTable.BeginTransactionRequest request, GrpcRequestSettings settings) Begins new transaction.
CompletableFuture<Status>	bulkUpsert(tech.ydb.proto.table.YdbTable.BulkUpsertRequest request, GrpcRequestSettings settings) Execute bulk upsert
void	close()
CompletableFuture<Status>	commitTransaction(tech.ydb.proto.table.YdbTable.CommitTransactionRequest request, GrpcRequestSettings settings) Commits specified active transaction.
CompletableFuture<Status>	copyTable(tech.ydb.proto.table.YdbTable.CopyTableRequest request, GrpcRequestSettings settings) Creates copy of given table.
CompletableFuture<Status>	copyTables(tech.ydb.proto.table.YdbTable.CopyTablesRequest request, GrpcRequestSettings settings) Creates consistent copies of the given tables.
CompletableFuture<Result<tech.ydb.proto.table.YdbTable.CreateSessionResult>>	createSession(tech.ydb.proto.table.YdbTable.CreateSessionRequest request, GrpcRequestSettings settings) Create new session.
CompletableFuture<Status>	createTable(tech.ydb.proto.table.YdbTable.CreateTableRequest request, GrpcRequestSettings settings) Creates new table.
CompletableFuture<Status>	deleteSession(tech.ydb.proto.table.YdbTable.DeleteSessionRequest request, GrpcRequestSettings settings) Ends a session, releasing server resources associated with it.
CompletableFuture<Result<tech.ydb.proto.table.YdbTable.DescribeTableResult>>	describeTable(tech.ydb.proto.table.YdbTable.DescribeTableRequest request, GrpcRequestSettings settings) Returns information about given table (metadata).
CompletableFuture<Status>	dropTable(tech.ydb.proto.table.YdbTable.DropTableRequest request, GrpcRequestSettings settings) Drop table.
CompletableFuture<Result<tech.ydb.proto.table.YdbTable.ExecuteQueryResult>>	executeDataQuery(tech.ydb.proto.table.YdbTable.ExecuteDataQueryRequest request, GrpcRequestSettings settings) Executes data query.
CompletableFuture<Status>	executeSchemeQuery(tech.ydb.proto.table.YdbTable.ExecuteSchemeQueryRequest request, GrpcRequestSettings settings) Executes scheme query.
CompletableFuture<Result<tech.ydb.proto.table.YdbTable.ExplainQueryResult>>	explainDataQuery(tech.ydb.proto.table.YdbTable.ExplainDataQueryRequest request, GrpcRequestSettings settings) Explains data query.
String	getDatabase()
ScheduledExecutorService	getScheduler()
CompletableFuture<Result<tech.ydb.proto.table.YdbTable.KeepAliveResult>>	keepAlive(tech.ydb.proto.table.YdbTable.KeepAliveRequest request, GrpcRequestSettings settings) Idle sessions can be kept alive by calling KeepAlive periodically.
static GrpcTableRpc	ownTransport(GrpcTransport transport)
CompletableFuture<Result<tech.ydb.proto.table.YdbTable.PrepareQueryResult>>	prepareDataQuery(tech.ydb.proto.table.YdbTable.PrepareDataQueryRequest request, GrpcRequestSettings settings) Prepares data query, returns query id.
CompletableFuture<Status>	rollbackTransaction(tech.ydb.proto.table.YdbTable.RollbackTransactionRequest request, GrpcRequestSettings settings) Performs a rollback of the specified active transaction.
GrpcReadStream<tech.ydb.proto.table.YdbTable.ExecuteScanQueryPartialResponse>	streamExecuteScanQuery(tech.ydb.proto.table.YdbTable.ExecuteScanQueryRequest request, GrpcRequestSettings settings) Streaming execute scan query.
GrpcReadStream<tech.ydb.proto.table.YdbTable.ReadTableResponse>	streamReadTable(tech.ydb.proto.table.YdbTable.ReadTableRequest request, GrpcRequestSettings settings) Streaming read table.
static GrpcTableRpc	useTransport(GrpcTransport transport)

Methods inherited from class java.lang.Object

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

Method Detail

useTransport

public static GrpcTableRpc useTransport(@WillNotClose
                                        GrpcTransport transport)

ownTransport

public static GrpcTableRpc ownTransport(@WillClose
                                        GrpcTransport transport)

createSession

public CompletableFuture<Result<tech.ydb.proto.table.YdbTable.CreateSessionResult>> createSession(tech.ydb.proto.table.YdbTable.CreateSessionRequest request,
                                                                                                  GrpcRequestSettings settings)

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

Parameters:

request - request proto

settings - rpc call settings

Returns:

completable future with id of new session

deleteSession

public CompletableFuture<Status> deleteSession(tech.ydb.proto.table.YdbTable.DeleteSessionRequest request,
                                               GrpcRequestSettings settings)

Description copied from interface: TableRpc

Ends a session, releasing server resources associated with it.

Specified by:

deleteSession in interface TableRpc

Parameters:

request - request proto

settings - rpc call settings

Returns:

completable future with status of operation

keepAlive

public CompletableFuture<Result<tech.ydb.proto.table.YdbTable.KeepAliveResult>> keepAlive(tech.ydb.proto.table.YdbTable.KeepAliveRequest request,
                                                                                          GrpcRequestSettings settings)

Description copied from interface: TableRpc

Idle sessions can be kept alive by calling KeepAlive periodically.

Specified by:

keepAlive in interface TableRpc

Parameters:

request - request proto

settings - rpc call settings

Returns:

completable future with result of operation

createTable

public CompletableFuture<Status> createTable(tech.ydb.proto.table.YdbTable.CreateTableRequest request,
                                             GrpcRequestSettings settings)

Description copied from interface: TableRpc

Creates new table.

Specified by:

createTable in interface TableRpc

Parameters:

request - request proto

settings - rpc call settings

Returns:

completable future with status of operation

dropTable

public CompletableFuture<Status> dropTable(tech.ydb.proto.table.YdbTable.DropTableRequest request,
                                           GrpcRequestSettings settings)

Description copied from interface: TableRpc

Drop table.

Specified by:

dropTable in interface TableRpc

Parameters:

request - request proto

settings - rpc call settings

Returns:

completable future with status of operation

alterTable

public CompletableFuture<Status> alterTable(tech.ydb.proto.table.YdbTable.AlterTableRequest request,
                                            GrpcRequestSettings settings)

Description copied from interface: TableRpc

Modifies schema of given table.

Specified by:

alterTable in interface TableRpc

Parameters:

request - request proto

settings - rpc call settings

Returns:

completable future with status of operation

copyTable

public CompletableFuture<Status> copyTable(tech.ydb.proto.table.YdbTable.CopyTableRequest request,
                                           GrpcRequestSettings settings)

Description copied from interface: TableRpc

Creates copy of given table.

Specified by:

copyTable in interface TableRpc

Parameters:

request - request proto

settings - rpc call settings

Returns:

completable future with status of operation

copyTables

public CompletableFuture<Status> copyTables(tech.ydb.proto.table.YdbTable.CopyTablesRequest request,
                                            GrpcRequestSettings settings)

Description copied from interface: TableRpc

Creates consistent copies of the given tables.

Specified by:

copyTables in interface TableRpc

Parameters:

request - request proto

settings - rpc call settings

Returns:

completable future with status of operation

describeTable

public CompletableFuture<Result<tech.ydb.proto.table.YdbTable.DescribeTableResult>> describeTable(tech.ydb.proto.table.YdbTable.DescribeTableRequest request,
                                                                                                  GrpcRequestSettings settings)

Description copied from interface: TableRpc

Returns information about given table (metadata).

Specified by:

describeTable in interface TableRpc

Parameters:

request - request proto

settings - rpc call settings

Returns:

completable future with result of operation

explainDataQuery

public CompletableFuture<Result<tech.ydb.proto.table.YdbTable.ExplainQueryResult>> explainDataQuery(tech.ydb.proto.table.YdbTable.ExplainDataQueryRequest request,
                                                                                                    GrpcRequestSettings settings)

Description copied from interface: TableRpc

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

Specified by:

explainDataQuery in interface TableRpc

Parameters:

request - request proto

settings - rpc call settings

Returns:

completable future with result of operation

prepareDataQuery

public CompletableFuture<Result<tech.ydb.proto.table.YdbTable.PrepareQueryResult>> prepareDataQuery(tech.ydb.proto.table.YdbTable.PrepareDataQueryRequest request,
                                                                                                    GrpcRequestSettings settings)

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

Parameters:

request - request proto

settings - rpc call settings

Returns:

completable future with result of operation

executeDataQuery

public CompletableFuture<Result<tech.ydb.proto.table.YdbTable.ExecuteQueryResult>> executeDataQuery(tech.ydb.proto.table.YdbTable.ExecuteDataQueryRequest request,
                                                                                                    GrpcRequestSettings settings)

Description copied from interface: TableRpc

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

Specified by:

executeDataQuery in interface TableRpc

Parameters:

request - request proto

settings - rpc call settings

Returns:

completable future with result of operation

executeSchemeQuery

public CompletableFuture<Status> executeSchemeQuery(tech.ydb.proto.table.YdbTable.ExecuteSchemeQueryRequest request,
                                                    GrpcRequestSettings settings)

Description copied from interface: TableRpc

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

Specified by:

executeSchemeQuery in interface TableRpc

Parameters:

request - request proto

settings - rpc call settings

Returns:

completable future with status of operation

beginTransaction

public CompletableFuture<Result<tech.ydb.proto.table.YdbTable.BeginTransactionResult>> beginTransaction(tech.ydb.proto.table.YdbTable.BeginTransactionRequest request,
                                                                                                        GrpcRequestSettings settings)

Description copied from interface: TableRpc

Begins new transaction.

Specified by:

beginTransaction in interface TableRpc

Parameters:

request - request proto

settings - rpc call settings

Returns:

completable future with result of operation

commitTransaction

public CompletableFuture<Status> commitTransaction(tech.ydb.proto.table.YdbTable.CommitTransactionRequest request,
                                                   GrpcRequestSettings settings)

Description copied from interface: TableRpc

Commits specified active transaction.

Specified by:

commitTransaction in interface TableRpc

Parameters:

request - request proto

settings - rpc call settings

Returns:

completable future with status of operation

rollbackTransaction

public CompletableFuture<Status> rollbackTransaction(tech.ydb.proto.table.YdbTable.RollbackTransactionRequest request,
                                                     GrpcRequestSettings settings)

Description copied from interface: TableRpc

Performs a rollback of the specified active transaction.

Specified by:

rollbackTransaction in interface TableRpc

Parameters:

request - request proto

settings - rpc call settings

Returns:

completable future with status of operation

streamReadTable

public GrpcReadStream<tech.ydb.proto.table.YdbTable.ReadTableResponse> streamReadTable(tech.ydb.proto.table.YdbTable.ReadTableRequest request,
                                                                                       GrpcRequestSettings settings)

Description copied from interface: TableRpc

Streaming read table.

Specified by:

streamReadTable in interface TableRpc

Parameters:

request - request proto

settings - rpc call settings

Returns:

GrpcReadStream object that allows to start and cancel the stream

streamExecuteScanQuery

public GrpcReadStream<tech.ydb.proto.table.YdbTable.ExecuteScanQueryPartialResponse> streamExecuteScanQuery(tech.ydb.proto.table.YdbTable.ExecuteScanQueryRequest request,
                                                                                                            GrpcRequestSettings settings)

Description copied from interface: TableRpc

Streaming execute scan query.

Specified by:

streamExecuteScanQuery in interface TableRpc

Parameters:

request - request proto

settings - rpc call settings

Returns:

GrpcReadStream object that allows to start and cancel the stream

bulkUpsert

public CompletableFuture<Status> bulkUpsert(tech.ydb.proto.table.YdbTable.BulkUpsertRequest request,
                                            GrpcRequestSettings settings)

Description copied from interface: TableRpc

Execute bulk upsert

Specified by:

bulkUpsert in interface TableRpc

Parameters:

request - request proto

settings - rpc call settings

Returns:

completable future with status of operation

getDatabase

public String getDatabase()

Specified by:

getDatabase in interface TableRpc

getScheduler

public ScheduledExecutorService getScheduler()

Specified by:

getScheduler in interface TableRpc

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface TableRpc