tech.ydb.table

Interface Session

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

BaseSession

public interface Session
extends AutoCloseable

Author:

Sergey Polovko, Nikolay Perfilov

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Session.State

Method Summary

Modifier and Type	Method and Description
default CompletableFuture<Status>	alterTable(String path)
CompletableFuture<Status>	alterTable(String path, AlterTableSettings settings)
default CompletableFuture<Result<Transaction>>	beginTransaction(Transaction.Mode transactionMode) Consider using beginTransaction(TxMode) instead
CompletableFuture<Result<Transaction>>	beginTransaction(Transaction.Mode transactionMode, BeginTxSettings settings) Consider using beginTransaction(TxMode, BeginTxSettings) instead
default CompletableFuture<Result<TableTransaction>>	beginTransaction(TxMode txMode) Create and start a new active TableTransaction.
CompletableFuture<Result<TableTransaction>>	beginTransaction(TxMode txMode, BeginTxSettings settings) Create and start a new active TableTransaction.
void	close()
CompletableFuture<Status>	commitTransaction(String txId, CommitTxSettings settings) Consider using TableTransaction.commit() ()} instead
default CompletableFuture<Status>	copyTable(String src, String dst)
CompletableFuture<Status>	copyTable(String src, String dst, CopyTableSettings settings)
CompletableFuture<Status>	copyTables(CopyTablesSettings settings)
TableTransaction	createNewTransaction(TxMode txMode) Create a new not active TableTransaction.
default CompletableFuture<Status>	createTable(String path, TableDescription tableDescriptions)
CompletableFuture<Status>	createTable(String path, TableDescription tableDescriptions, CreateTableSettings settings)
default CompletableFuture<Result<TableDescription>>	describeTable(String path)
CompletableFuture<Result<TableDescription>>	describeTable(String path, DescribeTableSettings settings)
default CompletableFuture<Status>	dropTable(String path)
CompletableFuture<Status>	dropTable(String path, DropTableSettings settings)
default CompletableFuture<Status>	executeBulkUpsert(String tablePath, ListValue rows)
CompletableFuture<Status>	executeBulkUpsert(String tablePath, ListValue rows, BulkUpsertSettings settings)
default CompletableFuture<Result<DataQueryResult>>	executeDataQuery(String query, TxControl<?> txControl)
default CompletableFuture<Result<DataQueryResult>>	executeDataQuery(String query, TxControl<?> txControl, Params params)
CompletableFuture<Result<DataQueryResult>>	executeDataQuery(String query, TxControl<?> txControl, Params params, ExecuteDataQuerySettings settings)
GrpcReadStream<ReadTablePart>	executeReadTable(String tablePath, ReadTableSettings settings)
GrpcReadStream<ResultSetReader>	executeScanQuery(String query, Params params, ExecuteScanQuerySettings settings)
default CompletableFuture<Status>	executeScanQuery(String query, Params params, ExecuteScanQuerySettings settings, Consumer<ResultSetReader> fn) Deprecated.
default CompletableFuture<Status>	executeSchemeQuery(String query)
CompletableFuture<Status>	executeSchemeQuery(String query, ExecuteSchemeQuerySettings settings)
default CompletableFuture<Result<ExplainDataQueryResult>>	explainDataQuery(String query)
CompletableFuture<Result<ExplainDataQueryResult>>	explainDataQuery(String query, ExplainDataQuerySettings settings)
String	getId()
default CompletableFuture<Result<Session.State>>	keepAlive()
CompletableFuture<Result<Session.State>>	keepAlive(KeepAliveSessionSettings settings)
default CompletableFuture<Result<DataQuery>>	prepareDataQuery(String query)
CompletableFuture<Result<DataQuery>>	prepareDataQuery(String query, PrepareDataQuerySettings settings)
CompletableFuture<Result<ReadRowsResult>>	readRows(String pathToTable, ReadRowsSettings settings)
default GrpcReadStream<ResultSetReader>	readTable(String tablePath, ReadTableSettings settings) Deprecated.
default CompletableFuture<Status>	readTable(String tablePath, ReadTableSettings settings, Consumer<ResultSetReader> fn) Deprecated.
default CompletableFuture<Status>	renameTable(String src, String dst)
default CompletableFuture<Status>	renameTable(String src, String dst, boolean overwrite)
CompletableFuture<Status>	renameTables(RenameTablesSettings settings)
CompletableFuture<Status>	rollbackTransaction(String txId, RollbackTxSettings settings) Consider using TableTransaction.rollback() instead

Method Detail

getId

String getId()

close

void close()

Specified by:

close in interface AutoCloseable

createTable

CompletableFuture<Status> createTable(String path,
                                      TableDescription tableDescriptions,
                                      CreateTableSettings settings)

dropTable

CompletableFuture<Status> dropTable(String path,
                                    DropTableSettings settings)

alterTable

CompletableFuture<Status> alterTable(String path,
                                     AlterTableSettings settings)

copyTable

CompletableFuture<Status> copyTable(String src,
                                    String dst,
                                    CopyTableSettings settings)

copyTables

CompletableFuture<Status> copyTables(CopyTablesSettings settings)

renameTables

CompletableFuture<Status> renameTables(RenameTablesSettings settings)

describeTable

CompletableFuture<Result<TableDescription>> describeTable(String path,
                                                          DescribeTableSettings settings)

prepareDataQuery

CompletableFuture<Result<DataQuery>> prepareDataQuery(String query,
                                                      PrepareDataQuerySettings settings)

executeDataQuery

CompletableFuture<Result<DataQueryResult>> executeDataQuery(String query,
                                                            TxControl<?> txControl,
                                                            Params params,
                                                            ExecuteDataQuerySettings settings)

readRows

CompletableFuture<Result<ReadRowsResult>> readRows(String pathToTable,
                                                   ReadRowsSettings settings)

executeSchemeQuery

CompletableFuture<Status> executeSchemeQuery(String query,
                                             ExecuteSchemeQuerySettings settings)

explainDataQuery

CompletableFuture<Result<ExplainDataQueryResult>> explainDataQuery(String query,
                                                                   ExplainDataQuerySettings settings)

beginTransaction

CompletableFuture<Result<Transaction>> beginTransaction(Transaction.Mode transactionMode,
                                                        BeginTxSettings settings)

Consider using beginTransaction(TxMode, BeginTxSettings) instead

createNewTransaction

@ExperimentalApi(value="New table transaction interfaces are experimental and may change without notice")
TableTransaction createNewTransaction(TxMode txMode)

Create a new not active TableTransaction. This TableDescription will have no identifier and starts a transaction on server by execution a query

Parameters:

txMode - transaction mode

Returns:

new implicit transaction

beginTransaction

@ExperimentalApi(value="New table transaction interfaces are experimental and may change without notice")
CompletableFuture<Result<TableTransaction>> beginTransaction(TxMode txMode,
                                                                                                                                                                       BeginTxSettings settings)

Create and start a new active TableTransaction. This method creates a transaction on the server and returns TableDescription which is ready to execute queries on this server transaction

Parameters:

txMode - transaction mode

settings - additional settings for request

Returns:

future with result of the transaction starting

beginTransaction

@ExperimentalApi(value="New table transaction interfaces are experimental and may change without notice")
default CompletableFuture<Result<TableTransaction>> beginTransaction(TxMode txMode)

Create and start a new active TableTransaction. This method creates a transaction on the server and returns TableDescription which is ready to execute queries on this server transaction

Parameters:

txMode - transaction mode

Returns:

future with result of the transaction starting

commitTransaction

CompletableFuture<Status> commitTransaction(String txId,
                                            CommitTxSettings settings)

Consider using TableTransaction.commit() ()} instead

rollbackTransaction

CompletableFuture<Status> rollbackTransaction(String txId,
                                              RollbackTxSettings settings)

Consider using TableTransaction.rollback() instead

executeReadTable

GrpcReadStream<ReadTablePart> executeReadTable(String tablePath,
                                               ReadTableSettings settings)

executeScanQuery

GrpcReadStream<ResultSetReader> executeScanQuery(String query,
                                                 Params params,
                                                 ExecuteScanQuerySettings settings)

readTable

@Deprecated
default GrpcReadStream<ResultSetReader> readTable(String tablePath,
                                                              ReadTableSettings settings)

Deprecated.

readTable

@Deprecated
default CompletableFuture<Status> readTable(String tablePath,
                                                        ReadTableSettings settings,
                                                        Consumer<ResultSetReader> fn)

Deprecated.

executeScanQuery

@Deprecated
default CompletableFuture<Status> executeScanQuery(String query,
                                                               Params params,
                                                               ExecuteScanQuerySettings settings,
                                                               Consumer<ResultSetReader> fn)

Deprecated.

keepAlive

CompletableFuture<Result<Session.State>> keepAlive(KeepAliveSessionSettings settings)

executeBulkUpsert

CompletableFuture<Status> executeBulkUpsert(String tablePath,
                                            ListValue rows,
                                            BulkUpsertSettings settings)

createTable

default CompletableFuture<Status> createTable(String path,
                                              TableDescription tableDescriptions)

dropTable

default CompletableFuture<Status> dropTable(String path)

alterTable

default CompletableFuture<Status> alterTable(String path)

copyTable

default CompletableFuture<Status> copyTable(String src,
                                            String dst)

renameTable

default CompletableFuture<Status> renameTable(String src,
                                              String dst)

renameTable

default CompletableFuture<Status> renameTable(String src,
                                              String dst,
                                              boolean overwrite)

describeTable

default CompletableFuture<Result<TableDescription>> describeTable(String path)

executeDataQuery

default CompletableFuture<Result<DataQueryResult>> executeDataQuery(String query,
                                                                    TxControl<?> txControl,
                                                                    Params params)

executeDataQuery

default CompletableFuture<Result<DataQueryResult>> executeDataQuery(String query,
                                                                    TxControl<?> txControl)

prepareDataQuery

default CompletableFuture<Result<DataQuery>> prepareDataQuery(String query)

executeSchemeQuery

default CompletableFuture<Status> executeSchemeQuery(String query)

explainDataQuery

default CompletableFuture<Result<ExplainDataQueryResult>> explainDataQuery(String query)

beginTransaction

default CompletableFuture<Result<Transaction>> beginTransaction(Transaction.Mode transactionMode)

Consider using beginTransaction(TxMode) instead

executeBulkUpsert

default CompletableFuture<Status> executeBulkUpsert(String tablePath,
                                                    ListValue rows)

keepAlive

default CompletableFuture<Result<Session.State>> keepAlive()