com.google.cloud.spanner.connection.ConnectionStatementExecutor Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-cloud-spanner Show documentation
Java idiomatic client for Google Cloud Spanner.
There is a newer version: 6.81.1
/*
 * Copyright 2019 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.google.cloud.spanner.connection;

import com.google.cloud.spanner.Options.RpcPriority;
import com.google.cloud.spanner.Statement;
import com.google.cloud.spanner.TimestampBound;
import com.google.cloud.spanner.connection.PgTransactionMode.IsolationLevel;
import com.google.spanner.v1.DirectedReadOptions;
import java.time.Duration;

/**
 * The Cloud Spanner JDBC driver supports a number of client side statements that are interpreted by
 * the driver and that can modify the current state of a connection, or report the current state of
 * a connection. Each of the methods in this interface correspond with one such client side
 * statement.
 *
 * The methods in this interface are called by the different {@link ClientSideStatement}s. These
 * method calls are then forwarded into the appropriate method of a {@link Connection} instance.
 *
 * The client side statements are defined in the ClientSideStatements.json file.
 */
interface ConnectionStatementExecutor {

  StatementResult statementSetAutocommit(Boolean autocommit);

  StatementResult statementShowAutocommit();

  StatementResult statementSetReadOnly(Boolean readOnly);

  StatementResult statementShowReadOnly();

  StatementResult statementSetRetryAbortsInternally(Boolean retryAbortsInternally);

  StatementResult statementShowRetryAbortsInternally();

  StatementResult statementSetAutocommitDmlMode(AutocommitDmlMode mode);

  StatementResult statementShowAutocommitDmlMode();

  StatementResult statementSetStatementTimeout(Duration duration);

  StatementResult statementShowStatementTimeout();

  StatementResult statementShowReadTimestamp();

  StatementResult statementShowCommitTimestamp();

  StatementResult statementShowCommitResponse();

  StatementResult statementSetReadOnlyStaleness(TimestampBound staleness);

  StatementResult statementShowReadOnlyStaleness();

  StatementResult statementSetDirectedRead(DirectedReadOptions directedReadOptions);

  StatementResult statementShowDirectedRead();

  StatementResult statementSetOptimizerVersion(String optimizerVersion);

  StatementResult statementShowOptimizerVersion();

  StatementResult statementSetOptimizerStatisticsPackage(String optimizerStatisticsPackage);

  StatementResult statementShowOptimizerStatisticsPackage();

  StatementResult statementSetReturnCommitStats(Boolean returnCommitStats);

  StatementResult statementShowReturnCommitStats();

  StatementResult statementSetMaxCommitDelay(Duration maxCommitDelay);

  StatementResult statementShowMaxCommitDelay();

  StatementResult statementSetDelayTransactionStartUntilFirstWrite(
      Boolean delayTransactionStartUntilFirstWrite);

  StatementResult statementShowDelayTransactionStartUntilFirstWrite();

  StatementResult statementSetKeepTransactionAlive(Boolean keepTransactionAlive);

  StatementResult statementShowKeepTransactionAlive();

  StatementResult statementSetStatementTag(String tag);

  StatementResult statementShowStatementTag();

  StatementResult statementSetTransactionTag(String tag);

  StatementResult statementShowTransactionTag();

  StatementResult statementSetExcludeTxnFromChangeStreams(Boolean excludeTxnFromChangeStreams);

  StatementResult statementShowExcludeTxnFromChangeStreams();

  StatementResult statementBeginTransaction();

  StatementResult statementBeginPgTransaction(PgTransactionMode transactionMode);

  StatementResult statementCommit();

  StatementResult statementRollback();

  StatementResult statementSetTransactionMode(TransactionMode mode);

  StatementResult statementSetPgTransactionMode(PgTransactionMode transactionMode);

  StatementResult statementSetPgSessionCharacteristicsTransactionMode(
      PgTransactionMode transactionMode);

  StatementResult statementSetPgDefaultTransactionIsolation(IsolationLevel isolationLevel);

  StatementResult statementStartBatchDdl();

  StatementResult statementStartBatchDml();

  StatementResult statementRunBatch();

  StatementResult statementAbortBatch();

  StatementResult statementResetAll();

  StatementResult statementSetRPCPriority(RpcPriority priority);

  StatementResult statementShowRPCPriority();

  StatementResult statementSetSavepointSupport(SavepointSupport savepointSupport);

  StatementResult statementShowSavepointSupport();

  StatementResult statementShowTransactionIsolationLevel();

  StatementResult statementSetProtoDescriptors(byte[] protoDescriptors);

  StatementResult statementSetProtoDescriptorsFilePath(String filePath);

  StatementResult statementShowProtoDescriptors();

  StatementResult statementShowProtoDescriptorsFilePath();

  StatementResult statementExplain(String sql);

  StatementResult statementShowDataBoostEnabled();

  StatementResult statementSetDataBoostEnabled(Boolean dataBoostEnabled);

  StatementResult statementShowAutoPartitionMode();

  StatementResult statementSetAutoPartitionMode(Boolean autoPartitionMode);

  StatementResult statementShowMaxPartitions();

  StatementResult statementSetMaxPartitions(Integer maxPartitions);

  StatementResult statementShowMaxPartitionedParallelism();

  StatementResult statementSetMaxPartitionedParallelism(Integer maxPartitionedParallelism);

  StatementResult statementPartition(Statement statement);

  StatementResult statementRunPartition(String partitionId);

  StatementResult statementRunPartitionedQuery(Statement statement);
}