Enum TableConstraint 

pub enum TableConstraint {
    PrimaryKey {
        name: Option<Identifier>,
        columns: Vec<Identifier>,
        include_columns: Vec<Identifier>,
        modifiers: ConstraintModifiers,
        has_constraint_keyword: bool,
    },
    Unique {
        name: Option<Identifier>,
        columns: Vec<Identifier>,
        columns_parenthesized: bool,
        modifiers: ConstraintModifiers,
        has_constraint_keyword: bool,
        nulls_not_distinct: bool,
    },
    ForeignKey {
        name: Option<Identifier>,
        columns: Vec<Identifier>,
        references: Option<ForeignKeyRef>,
        on_delete: Option<ReferentialAction>,
        on_update: Option<ReferentialAction>,
        modifiers: ConstraintModifiers,
    },
    Check {
        name: Option<Identifier>,
        expression: Expression,
        modifiers: ConstraintModifiers,
    },
    Index {
        name: Option<Identifier>,
        columns: Vec<Identifier>,
        kind: Option<String>,
        modifiers: ConstraintModifiers,
        use_key_keyword: bool,
        expression: Option<Box<Expression>>,
        index_type: Option<Box<Expression>>,
        granularity: Option<Box<Expression>>,
    },
    Projection {
        name: Identifier,
        expression: Expression,
    },
    Like {
        source: TableRef,
        options: Vec<(LikeOptionAction, String)>,
    },
    PeriodForSystemTime {
        start_col: Identifier,
        end_col: Identifier,
    },
    Exclude {
        name: Option<Identifier>,
        using: Option<String>,
        elements: Vec<ExcludeElement>,
        include_columns: Vec<Identifier>,
        where_clause: Option<Box<Expression>>,
        with_params: Vec<(String, String)>,
        using_index_tablespace: Option<String>,
        modifiers: ConstraintModifiers,
    },
    Tags(Tags),
    InitiallyDeferred {
        deferred: bool,
    },
}

Table-level constraint

Variants

PrimaryKey

Fields

name: Option<Identifier>

columns: Vec<Identifier>

include_columns: Vec<Identifier>

INCLUDE (columns) - non-key columns included in the index (PostgreSQL)

modifiers: ConstraintModifiers

has_constraint_keyword: bool

Whether the CONSTRAINT keyword was used (vs MySQL’s PRIMARY KEY name (cols) syntax)

Unique

Fields

name: Option<Identifier>

columns: Vec<Identifier>

columns_parenthesized: bool

Whether columns are parenthesized (false for UNIQUE idx_name without parens)

modifiers: ConstraintModifiers

has_constraint_keyword: bool

Whether the CONSTRAINT keyword was used (vs MySQL’s UNIQUE name (cols) syntax)

nulls_not_distinct: bool

PostgreSQL 15+: NULLS NOT DISTINCT

ForeignKey

Fields

name: Option<Identifier>

columns: Vec<Identifier>

references: Option<ForeignKeyRef>

on_delete: Option<ReferentialAction>

ON DELETE action when REFERENCES is absent

on_update: Option<ReferentialAction>

ON UPDATE action when REFERENCES is absent

modifiers: ConstraintModifiers

Check

Fields

name: Option<Identifier>

expression: Expression

modifiers: ConstraintModifiers

Index

INDEX / KEY constraint (MySQL)

Fields

name: Option<Identifier>

columns: Vec<Identifier>

kind: Option<String>

Index kind: UNIQUE, FULLTEXT, SPATIAL, etc.

modifiers: ConstraintModifiers

use_key_keyword: bool

True if KEY keyword was used instead of INDEX

expression: Option<Box<Expression>>

ClickHouse: indexed expression (instead of columns)

index_type: Option<Box<Expression>>

ClickHouse: TYPE type_func(args)

granularity: Option<Box<Expression>>

ClickHouse: GRANULARITY n

Projection

ClickHouse PROJECTION definition

Fields

name: Identifier

expression: Expression

Like

PostgreSQL LIKE clause: LIKE source_table [INCLUDING|EXCLUDING options]

Fields

source: TableRef

options: Vec<(LikeOptionAction, String)>

Options as (INCLUDING|EXCLUDING, property) pairs

PeriodForSystemTime

TSQL PERIOD FOR SYSTEM_TIME (start_col, end_col)

Fields

start_col: Identifier

end_col: Identifier

Exclude

PostgreSQL EXCLUDE constraint EXCLUDE [USING method] (element WITH operator, …) [INCLUDE (cols)] [WHERE (expr)] [WITH (params)]

Fields

name: Option<Identifier>

using: Option<String>

Index access method (gist, btree, etc.)

elements: Vec<ExcludeElement>

Elements: (expression, operator) pairs

include_columns: Vec<Identifier>

INCLUDE columns

where_clause: Option<Box<Expression>>

WHERE predicate

with_params: Vec<(String, String)>

WITH (storage_parameters)

using_index_tablespace: Option<String>

USING INDEX TABLESPACE tablespace_name

modifiers: ConstraintModifiers

Tags(Tags)

Snowflake TAG clause: TAG (key=‘value’, key2=‘value2’)

InitiallyDeferred

PostgreSQL table-level INITIALLY DEFERRED/INITIALLY IMMEDIATE This is a standalone clause at the end of the CREATE TABLE that sets the default for all deferrable constraints in the table

Fields

deferred: bool

true = INITIALLY DEFERRED, false = INITIALLY IMMEDIATE

Trait Implementations

impl Clone for TableConstraint

fn clone(&self) -> TableConstraint

Returns a duplicate 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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TableConstraint

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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 Serialize for TableConstraint

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for TableConstraint