Struct tikv::storage::txn::commands::prewrite::Prewrite

pub struct Prewrite {
    pub ctx: Context,
    pub mutations: Vec<Mutation>,
    pub primary: Vec<u8>,
    pub start_ts: TimeStamp,
    pub lock_ttl: u64,
    pub skip_constraint_check: bool,
    pub txn_size: u64,
    pub min_commit_ts: TimeStamp,
    pub max_commit_ts: TimeStamp,
    pub secondary_keys: Option<Vec<Vec<u8>>>,
    pub try_one_pc: bool,
}

The prewrite phase of a transaction. The first phase of 2PC.

This prepares the system to commit the transaction. Later a Commit or a Rollback should follow.

Fields

ctx: Context

mutations: Vec<Mutation>

The set of mutations to apply.

primary: Vec<u8>

The primary lock. Secondary locks (from mutations) will refer to the primary lock.

start_ts: TimeStamp

The transaction timestamp.

lock_ttl: u64

skip_constraint_check: bool

txn_size: u64

How many keys this transaction involved.

min_commit_ts: TimeStamp

max_commit_ts: TimeStamp

Limits the maximum value of commit ts of async commit and 1PC, which can be used to avoid inconsistency with schema change.

secondary_keys: Option<Vec<Vec<u8>>>

All secondary keys in the whole transaction (i.e., as sent to all nodes, not only this node). Only present if using async commit.

try_one_pc: bool

When the transaction involves only one region, it’s possible to commit the transaction directly with 1PC protocol.

Implementations

impl Prewrite

pub fn new(
    mutations: Vec<Mutation>,
    primary: Vec<u8>,
    start_ts: TimeStamp,
    lock_ttl: u64,
    skip_constraint_check: bool,
    txn_size: u64,
    min_commit_ts: TimeStamp,
    max_commit_ts: TimeStamp,
    secondary_keys: Option<Vec<Vec<u8>>>,
    try_one_pc: bool,
    ctx: Context
) -> TypedCommand<PrewriteResult>

Return a TypedCommand that encapsulates the result of executing this command.

impl Prewrite

pub fn with_context(
    mutations: Vec<Mutation>,
    primary: Vec<u8>,
    start_ts: TimeStamp,
    ctx: Context
) -> TypedCommand<PrewriteResult>

fn into_prewriter(self) -> Prewriter<Optimistic>

Trait Implementations

impl CommandExt for Prewrite

fn get_ctx(&self) -> &Context

fn get_ctx_mut(&mut self) -> &mut Context

fn tag(&self) -> CommandKind

fn incr_cmd_metric(&self)

fn ts(&self) -> TimeStamp

fn write_bytes(&self) -> usize

fn gen_lock(&self) -> Lock

fn readonly(&self) -> bool

fn is_sys_cmd(&self) -> bool

fn can_be_pipelined(&self) -> bool

impl Debug for Prewrite

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

Formats the value using the given formatter.

impl Display for Prewrite

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

Formats the value using the given formatter.

impl<S: Snapshot, L: LockManager> WriteCommand<S, L> for Prewrite

fn process_write(
    self,
    snapshot: S,
    context: WriteContext<'_, L>
) -> Result<WriteResult>