com.datastax.oss.driver.api.core.cql.PrepareRequest Maven / Gradle / Ivy
/*
* Copyright DataStax, Inc.
*
* 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.datastax.oss.driver.api.core.cql;
import com.datastax.oss.driver.api.core.ConsistencyLevel;
import com.datastax.oss.driver.api.core.CqlIdentifier;
import com.datastax.oss.driver.api.core.CqlSession;
import com.datastax.oss.driver.api.core.config.DriverExecutionProfile;
import com.datastax.oss.driver.api.core.metadata.token.Token;
import com.datastax.oss.driver.api.core.retry.RetryPolicy;
import com.datastax.oss.driver.api.core.session.Request;
import com.datastax.oss.driver.api.core.session.Session;
import com.datastax.oss.driver.api.core.type.reflect.GenericType;
import edu.umd.cs.findbugs.annotations.NonNull;
import edu.umd.cs.findbugs.annotations.Nullable;
import java.nio.ByteBuffer;
import java.time.Duration;
import java.util.Map;
import java.util.concurrent.CompletionStage;
/**
* A request to prepare a CQL query.
*
* Driver clients should rarely have to deal directly with this type, it's used internally by
* {@link Session}'s prepare methods. However a {@link RetryPolicy} implementation might use it if
* it needs a custom behavior for prepare requests.
*
*
A client may also provide their own implementation of this interface to customize which
* attributes are propagated when preparing a simple statement; see {@link
* CqlSession#prepare(SimpleStatement)} for more explanations.
*/
public interface PrepareRequest extends Request {
/**
* The type returned when a CQL statement is prepared synchronously.
*
*
Most users won't use this explicitly. It is needed for the generic execute method ({@link
* Session#execute(Request, GenericType)}), but CQL statements will generally be prepared with one
* of the driver's built-in helper methods (such as {@link CqlSession#prepare(SimpleStatement)}).
*/
GenericType SYNC = GenericType.of(PreparedStatement.class);
/**
* The type returned when a CQL statement is prepared asynchronously.
*
* Most users won't use this explicitly. It is needed for the generic execute method ({@link
* Session#execute(Request, GenericType)}), but CQL statements will generally be prepared with one
* of the driver's built-in helper methods (such as {@link
* CqlSession#prepareAsync(SimpleStatement)}.
*/
GenericType> ASYNC =
new GenericType>() {};
/** The CQL query to prepare. */
@NonNull
String getQuery();
/**
* {@inheritDoc}
*
* Note that this refers to the prepare query itself, not to the bound statements that will be
* created from the prepared statement (see {@link #areBoundStatementsIdempotent()}).
*/
@NonNull
@Override
default Boolean isIdempotent() {
// Retrying to prepare is always safe
return true;
}
/**
* The name of the execution profile to use for the bound statements that will be created from the
* prepared statement.
*
*
Note that this will be ignored if {@link #getExecutionProfileForBoundStatements()} returns a
* non-null value.
*/
@Nullable
String getExecutionProfileNameForBoundStatements();
/**
* The execution profile to use for the bound statements that will be created from the prepared
* statement.
*/
@Nullable
DriverExecutionProfile getExecutionProfileForBoundStatements();
/**
* The routing keyspace to use for the bound statements that will be created from the prepared
* statement.
*/
CqlIdentifier getRoutingKeyspaceForBoundStatements();
/**
* The routing key to use for the bound statements that will be created from the prepared
* statement.
*/
ByteBuffer getRoutingKeyForBoundStatements();
/**
* The routing key to use for the bound statements that will be created from the prepared
* statement.
*
*
If it's not null, it takes precedence over {@link #getRoutingKeyForBoundStatements()}.
*/
Token getRoutingTokenForBoundStatements();
/**
* Returns the custom payload to send alongside the bound statements that will be created from the
* prepared statement.
*/
@NonNull
Map getCustomPayloadForBoundStatements();
/**
* Whether bound statements that will be created from the prepared statement are idempotent.
*
* This follows the same semantics as {@link #isIdempotent()}.
*/
@Nullable
Boolean areBoundStatementsIdempotent();
/**
* The timeout to use for the bound statements that will be created from the prepared statement.
* If the value is null, the default value will be used from the configuration.
*/
@Nullable
Duration getTimeoutForBoundStatements();
/**
* The paging state to use for the bound statements that will be created from the prepared
* statement.
*/
ByteBuffer getPagingStateForBoundStatements();
/**
* The page size to use for the bound statements that will be created from the prepared statement.
* If the value is 0 or negative, the default value will be used from the configuration.
*/
int getPageSizeForBoundStatements();
/**
* The consistency level to use for the bound statements that will be created from the prepared
* statement or {@code null} to use the default value from the configuration.
*/
@Nullable
ConsistencyLevel getConsistencyLevelForBoundStatements();
/**
* The serial consistency level to use for the bound statements that will be created from the
* prepared statement or {@code null} to use the default value from the configuration.
*/
@Nullable
ConsistencyLevel getSerialConsistencyLevelForBoundStatements();
/** Whether bound statements that will be created from the prepared statement are tracing. */
boolean areBoundStatementsTracing();
}