tech.ydb.query

Interface QueryTransaction

All Superinterfaces:

tech.ydb.common.transaction.YdbTransaction

@ExperimentalApi(value="QueryService is experimental and API may change without notice")
public interface QueryTransaction
extends tech.ydb.common.transaction.YdbTransaction

Interface of transaction from query service Short-living object allows transactional execution of several queries in one interactive transaction. QueryTransaction can be used in implicit mode - without calling commit()/rollback(). When QueryTransaction is not active - any execution of query with commitAtEnd=false starts a new transaction. And execution of query with commitAtEnd=true commits this transaction.

Author:

Aleksandr Gorshenin

Method Summary

Modifier and Type	Method and Description
default CompletableFuture<Result<QueryInfo>>	commit()
CompletableFuture<Result<QueryInfo>>	commit(CommitTransactionSettings settings)
default QueryStream	createQuery(String query) Creates QueryStream for executing query in this transaction.
QueryStream	createQuery(String query, boolean commitAtEnd, Params params, ExecuteQuerySettings settings) Creates QueryStream for executing query in this transaction.
default QueryStream	createQuery(String query, Params params) Creates QueryStream for executing query in this transaction.
default QueryStream	createQueryWithCommit(String query) Creates QueryStream for executing query in this transaction.
default QueryStream	createQueryWithCommit(String query, Params params) Creates QueryStream for executing query in this transaction.
QuerySession	getSession() Returns QuerySession that was used for creating the transaction
default CompletableFuture<Status>	rollback()
CompletableFuture<Status>	rollback(RollbackTransactionSettings settings)

Methods inherited from interface tech.ydb.common.transaction.YdbTransaction

getId, getSessionId, getStatusFuture, getTxMode, isActive

Method Detail

getSession

QuerySession getSession()

Returns QuerySession that was used for creating the transaction

Returns:

session that was used for creating the transaction

commit

CompletableFuture<Result<QueryInfo>> commit(CommitTransactionSettings settings)

rollback

CompletableFuture<Status> rollback(RollbackTransactionSettings settings)

createQuery

QueryStream createQuery(String query,
                        boolean commitAtEnd,
                        Params params,
                        ExecuteQuerySettings settings)

Creates QueryStream for executing query in this transaction. The query can contain DML, DDL and DCL statements. Supported mix of different statement types depends on the chosen transaction type.

Parameters:

query - text of query

commitAtEnd - true if transaction must be committed after query execution

params - query parameters

settings - additional settings of query execution

Returns:

a ready to execute instance of QueryStream

createQuery

default QueryStream createQuery(String query)

Creates QueryStream for executing query in this transaction. Transaction will not be committed after the execution of query. The query can contain DML, DDL and DCL statements. Supported mix of different statement types depends on the chosen transaction type.

Parameters:

query - text of query

Returns:

a ready to execute instance of QueryStream

createQuery

default QueryStream createQuery(String query,
                                Params params)

Creates QueryStream for executing query in this transaction. Transaction will not be committed after the execution of query. The query can contain DML, DDL and DCL statements. Supported mix of different statement types depends on the chosen transaction type.

Parameters:

query - text of query

params - query parameters

Returns:

a ready to execute instance of QueryStream

createQueryWithCommit

default QueryStream createQueryWithCommit(String query)

Creates QueryStream for executing query in this transaction. Transaction will be committed after the execution of query. The query can contain DML, DDL and DCL statements. Supported mix of different statement types depends on the chosen transaction type.

Parameters:

query - text of query

Returns:

a ready to execute instance of QueryStream

createQueryWithCommit

default QueryStream createQueryWithCommit(String query,
                                          Params params)

Creates QueryStream for executing query in this transaction. Transaction will be committed after the execution of query. The query can contain DML, DDL and DCL statements. Supported mix of different statement types depends on the chosen transaction type.

Parameters:

query - text of query

params - query parameters

Returns:

a ready to execute instance of QueryStream

commit

default CompletableFuture<Result<QueryInfo>> commit()

rollback

default CompletableFuture<Status> rollback()