ExScylla.Statement.Batch (ex_scylla v0.10.2)

@spec append_statement(
  ExScylla.Types.batch(),
  ExScylla.Types.prepared_statement() | ExScylla.Types.query() | String.t()
) :: ExScylla.Types.batch()

See: https://docs.rs/scylla/1.8.0/scylla/statement/batch/struct.Batch.html#method.append_statement

Example

iex> Batch.new(:unlogged)
...>   |> Batch.append_statement("INSERT INTO test (a, b) VALUES (1, 2)")
...>   |> is_reference()
true

get_consistency(batch)

@spec get_consistency(ExScylla.Types.batch()) :: ExScylla.Types.consistency() | nil

See: https://docs.rs/scylla/1.8.0/scylla/statement/batch/struct.Batch.html#method.get_consistency

Example

iex> b = Batch.new(:unlogged)
iex> Batch.get_consistency(b)
nil
iex> b = Batch.set_consistency(b, :quorum)
iex> Batch.get_consistency(b)
:quorum

get_execution_profile_handle(batch)

@spec get_execution_profile_handle(ExScylla.Types.batch()) ::
  ExScylla.Types.execution_profile_handle() | nil

See: https://docs.rs/scylla/1.8.0/scylla/statement/batch/struct.Batch.html#method.get_execution_profile_handle

Example

iex> eph = ExScylla.Execution.ExecutionProfile.builder()
...>          |> ExScylla.Execution.ExecutionProfileBuilder.build()
...>          |> ExScylla.Execution.ExecutionProfile.into_handle()
iex> b = Batch.new(:unlogged)
...>   |> Batch.set_execution_profile_handle(eph)
iex> b |> Batch.get_execution_profile_handle()
...>   |> is_reference()
true

get_is_idempotent(batch)

@spec get_is_idempotent(ExScylla.Types.batch()) :: boolean()

See: https://docs.rs/scylla/1.8.0/scylla/statement/batch/struct.Batch.html#method.get_is_idempotent

Example

iex> batch = Batch.new(:unlogged)
iex> Batch.get_is_idempotent(batch)
false

get_request_timeout(batch)

@spec get_request_timeout(ExScylla.Types.batch()) :: pos_integer() | nil

See: https://docs.rs/scylla/1.8.0/scylla/statement/batch/struct.Batch.html#method.get_request_timeout

Example

iex> batch = Batch.new(:unlogged)
iex> nil = Batch.get_request_timeout(batch)
iex> batch = Batch.set_request_timeout(batch, 5000)
iex> 5000 = Batch.get_request_timeout(batch)

get_serial_consistency(batch)

@spec get_serial_consistency(ExScylla.Types.batch()) ::
  ExScylla.Types.serial_consistency() | nil

See: https://docs.rs/scylla/1.8.0/scylla/statement/batch/struct.Batch.html#method.get_serial_consistency

Example

iex> batch = Batch.new(:unlogged)
...>          |> Batch.set_serial_consistency(:local_serial)
iex> :local_serial = Batch.get_serial_consistency(batch)

get_timestamp(batch)

@spec get_timestamp(ExScylla.Types.batch()) :: ExScylla.Types.ts_micros() | nil

See: https://docs.rs/scylla/1.8.0/scylla/statement/batch/struct.Batch.html#method.get_timestamp

Example

iex> batch = Batch.new(:unlogged)
iex> nil = Batch.get_timestamp(batch)
iex> ts_micro = :os.system_time(:microsecond)
iex> batch = Batch.set_timestamp(batch, ts_micro)
iex> ^ts_micro = Batch.get_timestamp(batch)

get_tracing(batch)

@spec get_tracing(ExScylla.Types.batch()) :: boolean()

See: https://docs.rs/scylla/1.8.0/scylla/statement/batch/struct.Batch.html#method.get_tracing

Example

iex> batch = Batch.new(:unlogged)
iex> false = Batch.get_tracing(batch)

get_type(batch)

@spec get_type(ExScylla.Types.batch()) :: ExScylla.Types.batch_type()

See: https://docs.rs/scylla/1.8.0/scylla/statement/batch/struct.Batch.html#method.get_type

Example

iex> batch = Batch.new(:unlogged)
iex> :unlogged = Batch.get_type(batch)

new(batch_type)

@spec new(ExScylla.Types.batch_type()) :: ExScylla.Types.batch()

See: https://docs.rs/scylla/1.8.0/scylla/statement/batch/struct.Batch.html#method.new

Example

iex> Batch.new(:unlogged)
...>   |> is_reference()
true

new_with_statements(batch_type, statements)

@spec new_with_statements(
  ExScylla.Types.batch_type(),
  [ExScylla.Types.prepared_statement() | ExScylla.Types.query() | String.t()]
) :: ExScylla.Types.batch()

See: https://docs.rs/scylla/1.8.0/scylla/statement/batch/struct.Batch.html#method.new_with_statements

Example

iex> Batch.new_with_statements(:unlogged, ["INSERT INTO test (a, b) VALUES (1, 2)"])
...>   |> is_reference()
true

set_consistency(batch, consistency)

@spec set_consistency(ExScylla.Types.batch(), ExScylla.Types.consistency()) ::
  ExScylla.Types.batch()

See: https://docs.rs/scylla/1.8.0/scylla/statement/batch/struct.Batch.html#method.set_consistency

Example

iex> batch = Batch.new(:unlogged)
iex> batch = Batch.set_consistency(batch, :quorum)
iex> true = is_reference(batch)

set_execution_profile_handle(batch, profile_handle)

@spec set_execution_profile_handle(
  ExScylla.Types.batch(),
  ExScylla.Types.execution_profile_handle() | nil
) :: ExScylla.Types.batch()

See: https://docs.rs/scylla/1.8.0/scylla/statement/batch/struct.Batch.html#method.set_execution_profile_handle

Example

iex> eph = ExScylla.Execution.ExecutionProfile.builder()
...>          |> ExScylla.Execution.ExecutionProfileBuilder.build()
...>          |> ExScylla.Execution.ExecutionProfile.into_handle()
iex> b = Batch.new(:unlogged)
...>   |> Batch.set_execution_profile_handle(eph)
iex> b |> Batch.get_execution_profile_handle()
...>   |> is_reference()
true

set_is_idempotent(batch, is_idempotent)

@spec set_is_idempotent(ExScylla.Types.batch(), boolean()) :: ExScylla.Types.batch()

See: https://docs.rs/scylla/1.8.0/scylla/statement/batch/struct.Batch.html#method.set_is_idempotent

Example

iex> batch = Batch.new(:unlogged)
iex> batch = Batch.set_is_idempotent(batch, true)
iex> true = is_reference(batch)

set_request_timeout(batch, timeout_ms)

@spec set_request_timeout(ExScylla.Types.batch(), pos_integer() | nil) ::
  ExScylla.Types.batch()

See: https://docs.rs/scylla/1.8.0/scylla/statement/batch/struct.Batch.html#method.set_request_timeout

Example

iex> batch = Batch.new(:unlogged)
iex> batch = Batch.set_request_timeout(batch, 5000)
iex> true = is_reference(batch)

set_serial_consistency(batch, sc)

@spec set_serial_consistency(
  ExScylla.Types.batch(),
  ExScylla.Types.serial_consistency() | nil
) ::
  ExScylla.Types.batch()

See: https://docs.rs/scylla/1.8.0/scylla/statement/batch/struct.Batch.html#method.set_serial_consistency

Example

iex> batch = Batch.new(:unlogged)
iex> batch = Batch.set_serial_consistency(batch, :serial)
iex> true = is_reference(batch)

set_timestamp(batch, timestamp_micros)

@spec set_timestamp(ExScylla.Types.batch(), ExScylla.Types.ts_micros() | nil) ::
  ExScylla.Types.batch()

See: https://docs.rs/scylla/1.8.0/scylla/statement/batch/struct.Batch.html#method.set_timestamp

Example

iex> batch = Batch.new(:unlogged)
iex> batch = Batch.set_timestamp(batch, :os.system_time(:microsecond))
iex> true = is_reference(batch)

set_tracing(batch, should_trace)

@spec set_tracing(ExScylla.Types.batch(), boolean()) :: ExScylla.Types.batch()

See: https://docs.rs/scylla/1.8.0/scylla/statement/batch/struct.Batch.html#method.set_tracing

Example

iex> batch = Batch.new(:unlogged)
iex> batch = Batch.set_tracing(batch, true)
iex> true = is_reference(batch)