Enum LockTables

#[non_exhaustive]
pub enum LockTables {
    MySql {
        pluralized_table_keyword: bool,
        tables: Vec<MySqlTableLock>,
    },
    Postgres {
        tables: Vec<ObjectName>,
        lock_mode: Option<LockTableType>,
        has_table_keyword: bool,
        only: bool,
        no_wait: bool,
    },
}

A LOCK TABLE .. statement. MySQL and Postgres variants are supported.

The MySQL and Postgres syntax variants are significant enough that they are explicitly represented as enum variants. In order to support additional databases in the future, this enum is marked as #[non_exhaustive].

In MySQL, when multiple tables are mentioned in the statement the lock mode can vary per table.

In contrast, Postgres only allows specifying a single mode which is applied to all mentioned tables.

MySQL: see https://dev.mysql.com/doc/refman/8.0/en/lock-tables.html

LOCK [TABLE | TABLES] name [[AS] alias] locktype [,name [[AS] alias] locktype]

Where locktype is:

READ [LOCAL] | [LOW_PRIORITY] WRITE

Postgres: See https://www.postgresql.org/docs/current/sql-lock.html

LOCK [ TABLE ] [ ONLY ] name [, ...] [ IN lockmode MODE ] [ NOWAIT ]

Where lockmode is one of:

ACCESS SHARE | ROW SHARE | ROW EXCLUSIVE | SHARE UPDATE EXCLUSIVE
| SHARE | SHARE ROW EXCLUSIVE | EXCLUSIVE | ACCESS EXCLUSIVE

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

MySql

The MySQL syntax variant

Fields

pluralized_table_keyword: bool

Whether the TABLE or TABLES keyword was used.

tables: Vec<MySqlTableLock>

The tables to lock and their per-table lock mode.

Postgres

The Postgres syntax variant.

Fields

tables: Vec<ObjectName>

One or more optionally schema-qualified table names to lock.

lock_mode: Option<LockTableType>

The lock type applied to all mentioned tables.

has_table_keyword: bool

Whether the optional TABLE keyword was present (to support round-trip parse & render)

only: bool

Whether the ONLY option was specified.

no_wait: bool

Whether the NOWAIT option was specified.

Trait Implementations

impl Clone for LockTables

fn clone(&self) -> LockTables

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LockTables

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for LockTables

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for LockTables

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

Formats the value using the given formatter.

impl Hash for LockTables

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for LockTables

fn cmp(&self, other: &LockTables) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for LockTables

fn eq(&self, other: &LockTables) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for LockTables

fn partial_cmp(&self, other: &LockTables) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for LockTables

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Visit for LockTables

fn visit<V: Visitor>(&self, visitor: &mut V) -> ControlFlow<V::Break>

impl VisitMut for LockTables

fn visit<V: VisitorMut>(&mut self, visitor: &mut V) -> ControlFlow<V::Break>

impl Eq for LockTables

impl StructuralPartialEq for LockTables