Struct scylla::statement::batch::Batch

pub struct Batch {
    pub statements: Vec<BatchStatement>,
    /* private fields */
}

CQL batch statement.

This represents a CQL batch that can be executed on a server.

Fields

statements: Vec<BatchStatement>

Implementations

impl Batch

pub fn new(batch_type: BatchType) -> Self

Creates a new, empty Batch of batch_type type.

pub fn new_with_statements( batch_type: BatchType, statements: Vec<BatchStatement>, ) -> Self

Creates a new, empty Batch of batch_type type with the provided statements.

pub fn append_statement(&mut self, statement: impl Into<BatchStatement>)

Appends a new statement to the batch.

pub fn get_type(&self) -> BatchType

Gets type of batch.

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

Sets the consistency to be used when executing this batch.

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

Gets the consistency to be used when executing this batch 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 batch. (Ignored unless the batch is an LWT)

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

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

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

Sets the idempotence of this batch 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 batch

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

Enable or disable CQL Tracing for this batch If enabled session.batch() 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 batch

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

Sets the default timestamp for this batch in microseconds. If not None, it will replace the server side assigned timestamp as default timestamp for all the statements contained in the batch.

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

Gets the default timestamp for this batch in microseconds.

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

Set the retry policy for this batch, 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 batch.

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 batch with execution profile referred by the provided handle. Handle may be later remapped to another profile, and batch will reflect those changes.

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

Borrows the execution profile handle associated with this batch.

Trait Implementations

impl Clone for Batch

fn clone(&self) -> Batch

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Batch

fn default() -> Self

Returns the “default value” for a type.