Struct tikv::storage::txn::commands::AcquirePessimisticLock

[+] Show declaration

pub struct AcquirePessimisticLock {
    pub ctx: Context,
    pub keys: Vec<(Key, bool)>,
    pub primary: Vec<u8>,
    pub start_ts: TimeStamp,
    pub lock_ttl: u64,
    pub is_first_lock: bool,
    pub for_update_ts: TimeStamp,
    pub wait_timeout: Option<WaitTimeout>,
    pub return_values: bool,
    pub min_commit_ts: TimeStamp,
    pub old_values: OldValues,
}

[−] Expand description

Acquire a Pessimistic lock on the keys.

This can be rolled back with a PessimisticRollback command.

Fields

ctx: Context

keys: Vec<(Key, bool)>

[−] Expand description

The set of keys to lock.

primary: Vec<u8>

[−] Expand description

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

start_ts: TimeStamp

[−] Expand description

The transaction timestamp.

lock_ttl: u64

[−] Expand description

The Time To Live of the lock, in milliseconds

is_first_lock: bool

for_update_ts: TimeStamp

wait_timeout: Option<WaitTimeout>

[−] Expand description

Time to wait for lock released in milliseconds when encountering locks.

return_values: bool

[−] Expand description

If it is true, TiKV will return values of the keys if no error, so TiDB can cache the values for later read in the same transaction.

min_commit_ts: TimeStamp

old_values: OldValues

Implementations

impl AcquirePessimisticLock[−]

pub fn new(
    keys: Vec<(Key, bool)>,
    primary: Vec<u8>,
    start_ts: TimeStamp,
    lock_ttl: u64,
    is_first_lock: bool,
    for_update_ts: TimeStamp,
    wait_timeout: Option<WaitTimeout>,
    return_values: bool,
    min_commit_ts: TimeStamp,
    old_values: OldValues,
    ctx: Context
) -> TypedCommand<StorageResult<PessimisticLockRes>>[−]

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

Trait Implementations

impl CommandExt for AcquirePessimisticLock[+]

[+] Show hidden undocumented items

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 can_be_pipelined(&self) -> bool

fn write_bytes(&self) -> usize

fn gen_lock(&self) -> Lock

fn readonly(&self) -> bool

fn is_sys_cmd(&self) -> bool

impl Debug for AcquirePessimisticLock[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl Display for AcquirePessimisticLock[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl<S: Snapshot, L: LockManager> WriteCommand<S, L> for AcquirePessimisticLock[+]

[+] Show hidden undocumented items

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