tech.ydb.table.impl

Class BaseSession

java.lang.Object

tech.ydb.table.impl.BaseSession

All Implemented Interfaces:

AutoCloseable, Session

@ThreadSafe
public abstract class BaseSession
extends Object
implements Session

Author:

Sergey Polovko, Alexandr Gorshenin, Nikolay Perfilov

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	BaseSession.DeprecatedTransactionImpl

Nested classes/interfaces inherited from interface tech.ydb.table.Session

Session.State

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseSession(String id, TableRpc tableRpc, boolean keepQueryText)

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Status>	alterTable(String path, AlterTableSettings settings)
CompletableFuture<Result<Transaction>>	beginTransaction(Transaction.Mode transactionMode, BeginTxSettings settings) Consider using Session.beginTransaction(TxMode, BeginTxSettings) instead
CompletableFuture<Result<TableTransaction>>	beginTransaction(TxMode txMode, BeginTxSettings settings) Create and start a new active TableTransaction.
CompletableFuture<Status>	commitTransaction(String txId, CommitTxSettings settings) Consider using TableTransaction.commit() ()} instead
CompletableFuture<Status>	copyTable(String src, String dst, CopyTableSettings settings)
CompletableFuture<Status>	copyTables(CopyTablesSettings settings)
TableTransaction	createNewTransaction(TxMode txMode) Create a new not active TableTransaction.
static CompletableFuture<Result<String>>	createSessionId(TableRpc tableRpc, CreateSessionSettings settings, boolean useServerBalancer)
CompletableFuture<Status>	createTable(String path, TableDescription description, CreateTableSettings settings)
CompletableFuture<Status>	delete(DeleteSessionSettings settings)
CompletableFuture<Result<TableDescription>>	describeTable(String path, DescribeTableSettings settings)
CompletableFuture<Status>	dropTable(String path, DropTableSettings settings)
CompletableFuture<Status>	executeBulkUpsert(String tablePath, ListValue rows, BulkUpsertSettings settings)
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)
CompletableFuture<Status>	executeSchemeQuery(String query, ExecuteSchemeQuerySettings settings)
CompletableFuture<Result<ExplainDataQueryResult>>	explainDataQuery(String query, ExplainDataQuerySettings settings)
String	getId()
CompletableFuture<Result<Session.State>>	keepAlive(KeepAliveSessionSettings settings)
CompletableFuture<Result<DataQuery>>	prepareDataQuery(String query, PrepareDataQuerySettings settings)
CompletableFuture<Result<ReadRowsResult>>	readRows(String pathToTable, ReadRowsSettings settings)
CompletableFuture<Status>	renameTables(RenameTablesSettings settings)
CompletableFuture<Status>	rollbackTransaction(String txId, RollbackTxSettings settings) Deprecated.
String	toString()
protected abstract void	updateSessionState(Throwable th, StatusCode code, boolean shutdownHint)

Methods inherited from class java.lang.Object

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

Methods inherited from interface tech.ydb.table.Session

alterTable, beginTransaction, beginTransaction, close, copyTable, createTable, describeTable, dropTable, executeBulkUpsert, executeDataQuery, executeDataQuery, executeScanQuery, executeSchemeQuery, explainDataQuery, keepAlive, prepareDataQuery, readTable, readTable, renameTable, renameTable

Constructor Detail

BaseSession

protected BaseSession(String id,
                      TableRpc tableRpc,
                      boolean keepQueryText)

Method Detail

getId

public String getId()

Specified by:

getId in interface Session

createSessionId

public static CompletableFuture<Result<String>> createSessionId(TableRpc tableRpc,
                                                                CreateSessionSettings settings,
                                                                boolean useServerBalancer)

createTable

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

Specified by:

createTable in interface Session

dropTable

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

Specified by:

dropTable in interface Session

alterTable

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

Specified by:

alterTable in interface Session

copyTable

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

Specified by:

copyTable in interface Session

copyTables

public CompletableFuture<Status> copyTables(CopyTablesSettings settings)

Specified by:

copyTables in interface Session

renameTables

public CompletableFuture<Status> renameTables(RenameTablesSettings settings)

Specified by:

renameTables in interface Session

describeTable

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

Specified by:

describeTable in interface Session

executeDataQuery

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

Specified by:

executeDataQuery in interface Session

readRows

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

Specified by:

readRows in interface Session

prepareDataQuery

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

Specified by:

prepareDataQuery in interface Session

executeSchemeQuery

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

Specified by:

executeSchemeQuery in interface Session

explainDataQuery

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

Specified by:

explainDataQuery in interface Session

beginTransaction

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

Description copied from interface: Session

Consider using Session.beginTransaction(TxMode, BeginTxSettings) instead

Specified by:

beginTransaction in interface Session

createNewTransaction

public TableTransaction createNewTransaction(TxMode txMode)

Description copied from interface: Session

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

Specified by:

createNewTransaction in interface Session

Parameters:

txMode - transaction mode

Returns:

new implicit transaction

beginTransaction

public CompletableFuture<Result<TableTransaction>> beginTransaction(TxMode txMode,
                                                                    BeginTxSettings settings)

Description copied from interface: Session

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

Specified by:

beginTransaction in interface Session

Parameters:

txMode - transaction mode

settings - additional settings for request

Returns:

future with result of the transaction starting

executeReadTable

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

Specified by:

executeReadTable in interface Session

executeScanQuery

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

Specified by:

executeScanQuery in interface Session

commitTransaction

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

Description copied from interface: Session

Consider using TableTransaction.commit() ()} instead

Specified by:

commitTransaction in interface Session

rollbackTransaction

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

Deprecated.

Description copied from interface: Session

Consider using TableTransaction.rollback() instead

Specified by:

rollbackTransaction in interface Session

keepAlive

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

Specified by:

keepAlive in interface Session

executeBulkUpsert

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

Specified by:

executeBulkUpsert in interface Session

delete

public CompletableFuture<Status> delete(DeleteSessionSettings settings)

updateSessionState

protected abstract void updateSessionState(Throwable th,
                                           StatusCode code,
                                           boolean shutdownHint)

toString

public String toString()

Overrides:

toString in class Object