tech.ydb.jdbc

Interface YdbConnection

All Superinterfaces:

AutoCloseable, Connection, Wrapper

All Known Implementing Classes:

YdbConnectionImpl

public interface YdbConnection
extends Connection

Field Summary

Fields inherited from interface java.sql.Connection

TRANSACTION_NONE, TRANSACTION_READ_COMMITTED, TRANSACTION_READ_UNCOMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE

Method Summary

Modifier and Type	Method and Description
YdbStatement	createStatement()
YdbStatement	createStatement(int resultSetType, int resultSetConcurrency)
YdbStatement	createStatement(int resultSetType, int resultSetConcurrency, int resultSetHoldability)
List<tech.ydb.table.result.ResultSetReader>	executeDataQuery(String yql, YdbValidator validator, int timeout, boolean keepInCache, tech.ydb.table.query.Params params) Explicitly execute query as a data query
ExplainedQuery	executeExplainQuery(String yql, YdbValidator validator) Explicitly explain this query
tech.ydb.table.result.ResultSetReader	executeScanQuery(String yql, YdbValidator validator, tech.ydb.table.query.Params params) Explicitly execute query as a scan query
void	executeSchemeQuery(String yql, YdbValidator validator) Explicitly execute query as a schema query
YdbContext	getCtx()
YdbDatabaseMetaData	getMetaData()
String	getYdbTxId() Return current YDB transaction, if exists
YdbPreparedStatement	prepareStatement(String sql) Prepares statement depending on driver settings
YdbPreparedStatement	prepareStatement(String sql, int autoGeneratedKeys)
YdbPreparedStatement	prepareStatement(String sql, int[] columnIndexes)
YdbPreparedStatement	prepareStatement(String sql, int resultSetType, int resultSetConcurrency)
YdbPreparedStatement	prepareStatement(String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability)
YdbPreparedStatement	prepareStatement(String sql, String[] columnNames)
YdbPreparedStatement	prepareStatement(String sql, YdbPrepareMode mode) Prepares statement with explicit configuration

Methods inherited from interface java.sql.Connection

abort, clearWarnings, close, commit, createArrayOf, createBlob, createClob, createNClob, createSQLXML, createStruct, getAutoCommit, getCatalog, getClientInfo, getClientInfo, getHoldability, getNetworkTimeout, getSchema, getTransactionIsolation, getTypeMap, getWarnings, isClosed, isReadOnly, isValid, nativeSQL, prepareCall, prepareCall, prepareCall, releaseSavepoint, rollback, rollback, setAutoCommit, setCatalog, setClientInfo, setClientInfo, setHoldability, setNetworkTimeout, setReadOnly, setSavepoint, setSavepoint, setSchema, setTransactionIsolation, setTypeMap

Methods inherited from interface java.sql.Wrapper

isWrapperFor, unwrap

Method Detail

getYdbTxId

@Nullable
String getYdbTxId()

Return current YDB transaction, if exists

Returns:

YDB transaction ID or null, if no transaction started

getCtx

YdbContext getCtx()

executeSchemeQuery

void executeSchemeQuery(String yql,
                        YdbValidator validator)
                 throws SQLException

Explicitly execute query as a schema query

Parameters:

yql - query (DDL) to execute

validator - handler for logging and warnings

Throws:

SQLException - if query cannot be executed

executeDataQuery

List<tech.ydb.table.result.ResultSetReader> executeDataQuery(String yql,
                                                             YdbValidator validator,
                                                             int timeout,
                                                             boolean keepInCache,
                                                             tech.ydb.table.query.Params params)
                                                      throws SQLException

Explicitly execute query as a data query

Parameters:

yql - query to execute

params - parameters for query

timeout - timeout of operation

keepInCache - flag to store query in server-side cache

validator - handler for logging and warnings

Returns:

list of result set

Throws:

SQLException - if query cannot be executed

executeScanQuery

tech.ydb.table.result.ResultSetReader executeScanQuery(String yql,
                                                       YdbValidator validator,
                                                       tech.ydb.table.query.Params params)
                                                throws SQLException

Explicitly execute query as a scan query

Parameters:

yql - query to execute

params - parameters for query

validator - handler for logging and warnings

Returns:

single result set with rows

Throws:

SQLException - if query cannot be executed

executeExplainQuery

ExplainedQuery executeExplainQuery(String yql,
                                   YdbValidator validator)
                            throws SQLException

Explicitly explain this query

Parameters:

yql - query to explain

validator - handler for logging and warnings

Returns:

list of result set of two string columns: YdbConst.EXPLAIN_COLUMN_AST and YdbConst.EXPLAIN_COLUMN_PLAN

Throws:

SQLException - if query cannot be explained

getMetaData

YdbDatabaseMetaData getMetaData()
                         throws SQLException

Specified by:

getMetaData in interface Connection

Throws:

SQLException

createStatement

YdbStatement createStatement()
                      throws SQLException

Specified by:

createStatement in interface Connection

Throws:

SQLException

createStatement

YdbStatement createStatement(int resultSetType,
                             int resultSetConcurrency)
                      throws SQLException

Specified by:

createStatement in interface Connection

Throws:

SQLException

prepareStatement

YdbPreparedStatement prepareStatement(String sql,
                                      int resultSetType,
                                      int resultSetConcurrency)
                               throws SQLException

Specified by:

prepareStatement in interface Connection

Throws:

SQLException

createStatement

YdbStatement createStatement(int resultSetType,
                             int resultSetConcurrency,
                             int resultSetHoldability)
                      throws SQLException

Specified by:

createStatement in interface Connection

Throws:

SQLException

prepareStatement

YdbPreparedStatement prepareStatement(String sql,
                                      int resultSetType,
                                      int resultSetConcurrency,
                                      int resultSetHoldability)
                               throws SQLException

Specified by:

prepareStatement in interface Connection

Throws:

SQLException

prepareStatement

YdbPreparedStatement prepareStatement(String sql,
                                      int autoGeneratedKeys)
                               throws SQLException

Specified by:

prepareStatement in interface Connection

Throws:

SQLException

prepareStatement

YdbPreparedStatement prepareStatement(String sql,
                                      int[] columnIndexes)
                               throws SQLException

Specified by:

prepareStatement in interface Connection

Throws:

SQLException

prepareStatement

YdbPreparedStatement prepareStatement(String sql,
                                      String[] columnNames)
                               throws SQLException

Specified by:

prepareStatement in interface Connection

Throws:

SQLException

prepareStatement

YdbPreparedStatement prepareStatement(String sql)
                               throws SQLException

Prepares statement depending on driver settings

Specified by:

prepareStatement in interface Connection

Parameters:

sql - sql to execute

Returns:

statement

Throws:

SQLException - in case of any internal error

prepareStatement

YdbPreparedStatement prepareStatement(String sql,
                                      YdbPrepareMode mode)
                               throws SQLException

Prepares statement with explicit configuration

Parameters:

sql - sql to prepare

mode - prepare mode

Returns:

prepared statement

Throws:

SQLException - in case of any internal error