Enum ColumnOption 

pub enum ColumnOption {
    Null,
    NotNull,
    Default(Expr),
    Materialized(Expr),
    Ephemeral(Option<Expr>),
    Alias(Expr),
    PrimaryKey(PrimaryKeyConstraint),
    Unique(UniqueConstraint),
    ForeignKey(ForeignKeyConstraint),
    Check(CheckConstraint),
    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),
    Srid(Box<Expr>),
    Invisible,
}

Available on crate feature sql only.

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

PrimaryKey(PrimaryKeyConstraint)

PRIMARY KEY [<constraint_characteristics>]

Unique(UniqueConstraint)

UNIQUE [<constraint_characteristics>]

ForeignKey(ForeignKeyConstraint)

A referential integrity constraint (REFERENCES <foreign_table> (<referred_columns>) [ MATCH { FULL | PARTIAL | SIMPLE } ] { [ON DELETE <referential_action>] [ON UPDATE <referential_action>] | [ON UPDATE <referential_action>] [ON DELETE <referential_action>] } [<constraint_characteristics>] ).

Check(CheckConstraint)

CHECK (<expr>)

DialectSpecific(Vec<Token>)

Dialect-specific options, such as:

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

CharacterSet(ObjectName)

CHARACTER SET <name> column option

Collation(ObjectName)

COLLATE <name> column option

Comment(String)

COMMENT '<text>' column option

OnUpdate(Expr)

ON UPDATE <expr> column option

Generated

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

Fields

generated_as: GeneratedAs

How the column is generated (e.g. GENERATED ALWAYS, BY DEFAULT, or expression-stored).

sequence_options: Option<Vec<SequenceOptions>>

Sequence/identity options when generation is backed by a sequence.

generation_expr: Option<Expr>

Optional expression used to generate the column value.

generation_expr_mode: Option<GeneratedExpressionMode>

Mode of the generated expression (VIRTUAL or STORED) when generation_expr is present.

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>' , ... ] )

Srid(Box<Expr>)

MySQL specific: Spatial reference identifier Syntax:

CREATE TABLE geom (g GEOMETRY NOT NULL SRID 4326);

Invisible

MySQL specific: Column is invisible via SELECT * Syntax:

CREATE TABLE t (foo INT, bar INT INVISIBLE);

Trait Implementations

impl Clone for ColumnOption

fn clone(&self) -> ColumnOption

Returns a duplicate 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<(), Error>

Formats the value using the given formatter.

impl Display for ColumnOption

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

Formats the value using the given formatter.

impl From<CheckConstraint> for ColumnOption

fn from(c: CheckConstraint) -> ColumnOption

Converts to this type from the input type.

impl From<ForeignKeyConstraint> for ColumnOption

fn from(fk: ForeignKeyConstraint) -> ColumnOption

Converts to this type from the input type.

impl From<PrimaryKeyConstraint> for ColumnOption

fn from(c: PrimaryKeyConstraint) -> ColumnOption

Converts to this type from the input type.

impl From<UniqueConstraint> for ColumnOption

fn from(c: UniqueConstraint) -> ColumnOption

Converts to this type from the input type.

impl Hash for ColumnOption

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 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 Spanned for ColumnOption

partial span

Missing spans:

• ColumnOption::Null
• ColumnOption::NotNull
• ColumnOption::Comment
• ColumnOption::PrimaryKey
• 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>(&self, visitor: &mut V) -> ControlFlow<<V as Visitor>::Break>

where V: Visitor,

Visit this node with the provided Visitor.

impl VisitMut for ColumnOption

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

where V: VisitorMut,

Mutably visit this node with the provided VisitorMut.

impl Eq for ColumnOption

impl StructuralPartialEq for ColumnOption