tech.ydb.table.transaction.TableTransaction Maven / Gradle / Ivy

Go to download
package tech.ydb.table.transaction;

import java.util.concurrent.CompletableFuture;

import tech.ydb.common.transaction.YdbTransaction;
import tech.ydb.core.Result;
import tech.ydb.core.Status;
import tech.ydb.table.Session;
import tech.ydb.table.query.DataQueryResult;
import tech.ydb.table.query.Params;
import tech.ydb.table.settings.CommitTxSettings;
import tech.ydb.table.settings.ExecuteDataQuerySettings;
import tech.ydb.table.settings.RollbackTxSettings;

/**
 * Interface of transaction from table service
 * Short-living object allows transactional execution of several queries in one interactive transaction.
 * TableTransaction can be used in implicit mode - without calling commit()/rollback().
 * When TableTransaction is not active, any execution of a query with commitAtEnd=false starts a new transaction.
 * And execution of a query with commitAtEnd=true commits this transaction.
 * @author Nikolay Perfilov
 */
public interface TableTransaction extends YdbTransaction {

    /**
     * Returns {@link Session} that was used to create this transaction
     *
     * @return session that was used to create this transaction
     */
    Session getSession();

    /**
     * Execute DataQuery
     *
     * @param query text of query. Can only contain DML statements
     * @param commitAtEnd true if transaction must be committed after query execution
     * @param params query parameters
     * @param settings additional settings of query execution
     * @return a future to query result
     */
    CompletableFuture> executeDataQuery(
            String query, boolean commitAtEnd, Params params, ExecuteDataQuerySettings settings);

    /**
     * Execute DataQuery.
     * Transaction will not be committed after the execution of query.
     *
     * @param query text of query. Can only contain DML statements
     * @return a future to query result
     */
    default CompletableFuture> executeDataQuery(String query) {
        return executeDataQuery(query, false, Params.empty(), new ExecuteDataQuerySettings());
    }

    /**
     * Execute DataQuery.
     * Transaction will not be committed after the execution of query.
     *
     * @param query text of query. Can only contain DML statements
     * @param params query parameters
     * @return a future to query result
     */
    default CompletableFuture> executeDataQuery(String query, Params params) {
        return executeDataQuery(query, false, params, new ExecuteDataQuerySettings());
    }

    /**
     * Execute DataQuery.
     * Transaction will be committed after the execution of query.
     *
     * @param query text of query. Can only contain DML statements
     * @return a future to query result
     */
    default CompletableFuture> executeDataQueryAndCommit(String query) {
        return executeDataQuery(query, true, Params.empty(), new ExecuteDataQuerySettings());
    }

    /**
     * Execute DataQuery.
     * Transaction will be committed after the execution of query.
     *
     * @param query text of query. Can only contain DML statements
     * @param params query parameters
     * @return a future to query result
     */
    default CompletableFuture> executeDataQueryAndCommit(String query, Params params) {
        return executeDataQuery(query, false, params, new ExecuteDataQuerySettings());
    }

    CompletableFuture commit(CommitTxSettings settings);
    CompletableFuture rollback(RollbackTxSettings settings);

    default CompletableFuture commit() {
        return commit(new CommitTxSettings());
    }

    default CompletableFuture rollback() {
        return rollback(new RollbackTxSettings());
    }
}