Enum ColumnOption

pub enum ColumnOption {
    Null,
    NotNull,
    Default(Expr),
    Materialized(Expr),
    Ephemeral(Option<Expr>),
    Alias(Expr),
    Unique {
        is_primary: bool,
        characteristics: Option<ConstraintCharacteristics>,
    },
    ForeignKey {
        foreign_table: ObjectName,
        referred_columns: Vec<Ident>,
        on_delete: Option<ReferentialAction>,
        on_update: Option<ReferentialAction>,
        characteristics: Option<ConstraintCharacteristics>,
    },
    Check(Expr),
    DialectSpecific(Vec<Token>),
    CharacterSet(ObjectName),
    Collation(ObjectName),
    Comment(String),
    OnUpdate(Expr),
    Generated {
        generated_as: GeneratedAs,
        sequence_options: Option<Vec<SequenceOptions>>,
        generation_expr: Option<Expr>,
        generation_expr_mode: Option<GeneratedExpressionMode>,
        generated_keyword: bool,
    },
    Options(Vec<SqlOption>),
    Identity(IdentityPropertyKind),
    OnConflict(Keyword),
    Policy(ColumnPolicy),
    Tags(TagsColumnOption),
}

ColumnOptions are modifiers that follow a column definition in a CREATE TABLE statement.

Variants

Null

NULL

NotNull

NOT NULL

Default(Expr)

DEFAULT <restricted-expr>

Materialized(Expr)

MATERIALIZE <expr> Syntax: b INT MATERIALIZE (a + 1)

ClickHouse

Ephemeral(Option<Expr>)

EPHEMERAL [<expr>]

ClickHouse

Alias(Expr)

ALIAS <expr>

ClickHouse

Unique

{ PRIMARY KEY | UNIQUE } [<constraint_characteristics>]

Fields

is_primary: bool

characteristics: Option<ConstraintCharacteristics>

ForeignKey

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

Fields

foreign_table: ObjectName

referred_columns: Vec<Ident>

on_delete: Option<ReferentialAction>

on_update: Option<ReferentialAction>

characteristics: Option<ConstraintCharacteristics>

Check(Expr)

CHECK (<expr>)

DialectSpecific(Vec<Token>)

Dialect-specific options, such as:

• MySQL’s AUTO_INCREMENT or SQLite’s AUTOINCREMENT
• …

CharacterSet(ObjectName)

Collation(ObjectName)

Comment(String)

OnUpdate(Expr)

Generated

Generateds are modifiers that follow a column definition in a CREATE TABLE statement.

Fields

generated_as: GeneratedAs

sequence_options: Option<Vec<SequenceOptions>>

generation_expr: Option<Expr>

generation_expr_mode: Option<GeneratedExpressionMode>

generated_keyword: bool

false if ‘GENERATED ALWAYS’ is skipped (option starts with AS)

Options(Vec<SqlOption>)

BigQuery specific: Explicit column options in a view 1 or table 2 Syntax

OPTIONS(description="field desc")

Identity(IdentityPropertyKind)

Creates an identity or an autoincrement column in a table. Syntax

{ IDENTITY | AUTOINCREMENT } [ (seed , increment) | START num INCREMENT num ] [ ORDER | NOORDER ]

OnConflict(Keyword)

SQLite specific: ON CONFLICT option on column definition https://www.sqlite.org/lang_conflict.html

Policy(ColumnPolicy)

Snowflake specific: an option of specifying security masking or projection policy to set on a column. Syntax:

[ WITH ] MASKING POLICY <policy_name> [ USING ( <col_name> , <cond_col1> , ... ) ]
[ WITH ] PROJECTION POLICY <policy_name>

Tags(TagsColumnOption)

Snowflake specific: Specifies the tag name and the tag string value. Syntax:

[ WITH ] TAG ( <tag_name> = '<tag_value>' [ , <tag_name> = '<tag_value>' , ... ] )

Trait Implementations

impl Clone for ColumnOption

fn clone(&self) -> ColumnOption

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ColumnOption

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ColumnOption

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ColumnOption

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

Formats the value using the given formatter.

impl Hash for ColumnOption

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 ColumnOption

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

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

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Spanned for ColumnOption

partial span

Missing spans:

• ColumnOption::Null
• ColumnOption::NotNull
• ColumnOption::Comment
• ColumnOption::Unique¨
• ColumnOption::DialectSpecific
• ColumnOption::Generated

fn span(&self) -> Span

Return the Span (the minimum and maximum Location) for this AST node, by recursively combining the spans of its children.

impl Visit for ColumnOption

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

impl VisitMut for ColumnOption

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

impl Eq for ColumnOption

impl StructuralPartialEq for ColumnOption