Enum TableConstraint

pub enum TableConstraint {
    Unique {
        name: Option<Ident>,
        index_name: Option<Ident>,
        index_type_display: KeyOrIndexDisplay,
        index_type: Option<IndexType>,
        columns: Vec<Ident>,
        index_options: Vec<IndexOption>,
        characteristics: Option<ConstraintCharacteristics>,
    },
    PrimaryKey {
        name: Option<Ident>,
        index_name: Option<Ident>,
        index_type: Option<IndexType>,
        columns: Vec<Ident>,
        index_options: Vec<IndexOption>,
        characteristics: Option<ConstraintCharacteristics>,
    },
    ForeignKey {
        name: Option<Ident>,
        columns: Vec<Ident>,
        foreign_table: ObjectName,
        referred_columns: Vec<Ident>,
        on_delete: Option<ReferentialAction>,
        on_update: Option<ReferentialAction>,
        characteristics: Option<ConstraintCharacteristics>,
    },
    Check {
        name: Option<Ident>,
        expr: Box<Expr>,
    },
    Index {
        display_as_key: bool,
        name: Option<Ident>,
        index_type: Option<IndexType>,
        columns: Vec<Ident>,
    },
    FulltextOrSpatial {
        fulltext: bool,
        index_type_display: KeyOrIndexDisplay,
        opt_index_name: Option<Ident>,
        columns: Vec<Ident>,
    },
}

A table-level constraint, specified in a CREATE TABLE or an ALTER TABLE ADD <constraint> statement.

Variants

Unique

MySQL definition for UNIQUE constraints statements:\

• [CONSTRAINT [<name>]] UNIQUE <index_type_display> [<index_name>] [index_type] (<columns>) <index_options>

where:

• index_type is USING {BTREE | HASH}
• index_options is {index_type | COMMENT 'string' | ... %currently unsupported stmts% } ...
• index_type_display is [INDEX | KEY]

Fields

name: Option<Ident>

Constraint name.

Can be not the same as index_name

index_name: Option<Ident>

Index name

index_type_display: KeyOrIndexDisplay

Whether the type is followed by the keyword KEY, INDEX, or no keyword at all.

index_type: Option<IndexType>

Optional USING of index type statement before columns.

columns: Vec<Ident>

Identifiers of the columns that are unique.

index_options: Vec<IndexOption>

characteristics: Option<ConstraintCharacteristics>

PrimaryKey

MySQL definition for PRIMARY KEY constraints statements:\

• [CONSTRAINT [<name>]] PRIMARY KEY [index_name] [index_type] (<columns>) <index_options>

Actually the specification have no [index_name] but the next query will complete successfully:

CREATE TABLE unspec_table (
  xid INT NOT NULL,
  CONSTRAINT p_name PRIMARY KEY index_name USING BTREE (xid)
);

where:

• index_type is USING {BTREE | HASH}
• index_options is {index_type | COMMENT 'string' | ... %currently unsupported stmts% } ...

Fields

name: Option<Ident>

Constraint name.

Can be not the same as index_name

index_name: Option<Ident>

Index name

index_type: Option<IndexType>

Optional USING of index type statement before columns.

columns: Vec<Ident>

Identifiers of the columns that form the primary key.

index_options: Vec<IndexOption>

characteristics: Option<ConstraintCharacteristics>

ForeignKey

A referential integrity constraint ([ CONSTRAINT <name> ] FOREIGN KEY (<columns>) REFERENCES <foreign_table> (<referred_columns>) { [ON DELETE <referential_action>] [ON UPDATE <referential_action>] | [ON UPDATE <referential_action>] [ON DELETE <referential_action>] }).

Fields

name: Option<Ident>

columns: Vec<Ident>

foreign_table: ObjectName

referred_columns: Vec<Ident>

on_delete: Option<ReferentialAction>

on_update: Option<ReferentialAction>

characteristics: Option<ConstraintCharacteristics>

Check

[ CONSTRAINT <name> ] CHECK (<expr>)

Fields

name: Option<Ident>

expr: Box<Expr>

Index

MySQLs index definition for index creation. Not present on ANSI so, for now, the usage is restricted to MySQL, as no other dialects that support this syntax were found.

{INDEX | KEY} [index_name] [index_type] (key_part,...) [index_option]...

Fields

display_as_key: bool

Whether this index starts with KEY (true) or INDEX (false), to maintain the same syntax.

name: Option<Ident>

Index name.

index_type: Option<IndexType>

Optional index type.

columns: Vec<Ident>

Referred column identifier list.

FulltextOrSpatial

MySQLs fulltext definition. Since the SPATIAL definition is exactly the same, and MySQL displays both the same way, it is part of this definition as well.

Supported syntax:

{FULLTEXT | SPATIAL} [INDEX | KEY] [index_name] (key_part,...)

key_part: col_name

Fields

fulltext: bool

Whether this is a FULLTEXT (true) or SPATIAL (false) definition.

index_type_display: KeyOrIndexDisplay

Whether the type is followed by the keyword KEY, INDEX, or no keyword at all.

opt_index_name: Option<Ident>

Optional index name.

columns: Vec<Ident>

Referred column identifier list.

Trait Implementations

impl Clone for TableConstraint

fn clone(&self) -> TableConstraint

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TableConstraint

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

Formats the value using the given formatter.

impl Display for TableConstraint

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

Formats the value using the given formatter.

impl Hash for TableConstraint

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

where __H: Hasher,

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 TableConstraint

fn cmp(&self, other: &TableConstraint) -> 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 TableConstraint

fn eq(&self, other: &TableConstraint) -> 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 TableConstraint

fn partial_cmp(&self, other: &TableConstraint) -> 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 Visit for TableConstraint

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

where V: Visitor,

impl VisitMut for TableConstraint

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

where V: VisitorMut,

impl Eq for TableConstraint

impl StructuralPartialEq for TableConstraint