Struct scylla::statement::prepared_statement::PreparedStatement

pub struct PreparedStatement {
    pub prepare_tracing_ids: Vec<Uuid>,
    /* private fields */
}

Represents a statement prepared on the server.

Fields

prepare_tracing_ids: Vec<Uuid>

Implementations

impl PreparedStatement

pub fn get_id(&self) -> &Bytes

pub fn get_statement(&self) -> &str

pub fn set_page_size(&mut self, page_size: i32)

Sets the page size for this CQL query.

pub fn disable_paging(&mut self)

Disables paging for this CQL query.

pub fn get_page_size(&self) -> Option<i32>

Returns the page size for this CQL query.

pub fn get_prepare_tracing_ids(&self) -> &[Uuid]

Gets tracing ids of queries used to prepare this statement

pub fn is_token_aware(&self) -> bool

Returns true if the prepared statement has necessary information to be routed in a token-aware manner. If false, the query will always be sent to a random node/shard.

pub fn is_confirmed_lwt(&self) -> bool

Returns true if it is known that the prepared statement contains a Lightweight Transaction. If so, the optimisation can be performed: the query should be routed to the replicas in a predefined order (i. e. always try first to contact replica A, then B if it fails, then C, etc.). If false, the query should be routed normally. Note: this a Scylla-specific optimisation. Therefore, the result will be always false for Cassandra.

pub fn compute_partition_key( &self, bound_values: &impl SerializeRow ) -> Result<Bytes, PartitionKeyError>

Computes the partition key of the target table from given values — it assumes that all partition key columns are passed in values. Partition keys have specific serialization rules. Ref: https://github.com/scylladb/scylla/blob/40adf38915b6d8f5314c621a94d694d172360833/compound_compat.hh#L33-L47

Note: this is no longer required to compute a token. This is because partitioners are now stateful and stream-based, so they do not require materialised partition key. Therefore, for computing a token, there are more efficient methods, such as Self::calculate_token().

pub fn calculate_token( &self, values: &impl SerializeRow ) -> Result<Option<Token>, QueryError>

Calculates the token for given prepared statement and values.

Returns the token that would be computed for executing the provided prepared statement with the provided values.

pub fn get_table_spec(&self) -> Option<&TableSpec<'_>>

Return keyspace name and table name this statement is operating on.

pub fn get_keyspace_name(&self) -> Option<&str>

Returns the name of the keyspace this statement is operating on.

pub fn get_table_name(&self) -> Option<&str>

Returns the name of the table this statement is operating on.

pub fn set_consistency(&mut self, c: Consistency)

Sets the consistency to be used when executing this statement.

pub fn get_consistency(&self) -> Option<Consistency>

Gets the consistency to be used when executing this prepared statement if it is filled. If this is empty, the default_consistency of the session will be used.

pub fn set_serial_consistency(&mut self, sc: Option<SerialConsistency>)

Sets the serial consistency to be used when executing this statement. (Ignored unless the statement is an LWT)

pub fn get_serial_consistency(&self) -> Option<SerialConsistency>

Gets the serial consistency to be used when executing this statement. (Ignored unless the statement is an LWT)

pub fn set_is_idempotent(&mut self, is_idempotent: bool)

Sets the idempotence of this statement A query is idempotent if it can be applied multiple times without changing the result of the initial application If set to true we can be sure that it is idempotent If set to false it is unknown whether it is idempotent This is used in RetryPolicy to decide if retrying a query is safe

pub fn get_is_idempotent(&self) -> bool

Gets the idempotence of this statement

pub fn set_tracing(&mut self, should_trace: bool)

Enable or disable CQL Tracing for this statement If enabled session.execute() will return a QueryResult containing tracing_id which can be used to query tracing information about the execution of this query

pub fn get_tracing(&self) -> bool

Gets whether tracing is enabled for this statement

pub fn set_use_cached_result_metadata(&mut self, use_cached_metadata: bool)

Make use of cached metadata to decode results of the statement’s execution.

If true, the driver will request the server not to attach the result metadata in response to the statement execution.

The driver will cache the result metadata received from the server after statement preparation and will use it to deserialize the results of statement execution.

This option is false by default.

pub fn get_use_cached_result_metadata(&self) -> bool

Gets the information whether the driver uses cached metadata to decode the results of the statement’s execution.

pub fn set_timestamp(&mut self, timestamp: Option<i64>)

Sets the default timestamp for this statement in microseconds. If not None, it will replace the server side assigned timestamp as default timestamp If a statement contains a USING TIMESTAMP clause, calling this method won’t change anything

pub fn get_timestamp(&self) -> Option<i64>

Gets the default timestamp for this statement in microseconds.

pub fn set_request_timeout(&mut self, timeout: Option<Duration>)

Sets the client-side timeout for this statement. If not None, the driver will stop waiting for the request to finish after timeout passed. Otherwise, default session client timeout will be applied.

pub fn get_request_timeout(&self) -> Option<Duration>

Gets client timeout associated with this query

pub fn get_variable_col_specs(&self) -> &[ColumnSpec]

Access column specifications of the bind variables of this statement

pub fn get_variable_pk_indexes(&self) -> &[PartitionKeyIndex]

Access info about partition key indexes of the bind variables of this statement

pub fn get_result_set_col_specs(&self) -> &[ColumnSpec]

Access column specifications of the result set returned after the execution of this statement

pub fn set_retry_policy(&mut self, retry_policy: Option<Arc<dyn RetryPolicy>>)

Set the retry policy for this statement, overriding the one from execution profile if not None.

pub fn get_retry_policy(&self) -> Option<&Arc<dyn RetryPolicy>>

Get the retry policy set for the statement.

pub fn set_history_listener( &mut self, history_listener: Arc<dyn HistoryListener> )

Sets the listener capable of listening what happens during query execution.

pub fn remove_history_listener(&mut self) -> Option<Arc<dyn HistoryListener>>

Removes the listener set by set_history_listener.

pub fn set_execution_profile_handle( &mut self, profile_handle: Option<ExecutionProfileHandle> )

Associates the query with execution profile referred by the provided handle. Handle may be later remapped to another profile, and query will reflect those changes.

pub fn get_execution_profile_handle(&self) -> Option<&ExecutionProfileHandle>

Borrows the execution profile handle associated with this query.

Trait Implementations

impl Clone for PreparedStatement

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PreparedStatement

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<PreparedStatement> for BatchStatement

fn from(p: PreparedStatement) -> Self

Converts to this type from the input type.