Struct ColumnDef 

pub struct ColumnDef {
    pub table: &'static str,
    pub name: &'static str,
    pub sql_type: &'static str,
    pub not_null: bool,
    pub primary_key: Option<PrimaryKeyKind>,
    pub unique: bool,
    pub default: Option<&'static str>,
    pub generated: Option<GeneratedDef>,
    pub collate: Option<&'static str>,
}

A column definition that can be built in a const.

Builder methods set one property each; into_column converts to the runtime Column.

Examples

use drizzle_types::sqlite::ddl::ColumnDef;

const ID: ColumnDef = ColumnDef::new("users", "id", "INTEGER")
    .primary_key()
    .autoincrement();

const COLUMNS: &[ColumnDef] = &[
    ColumnDef::new("users", "id", "INTEGER").primary_key().autoincrement(),
    ColumnDef::new("users", "name", "TEXT").not_null(),
    ColumnDef::new("users", "email", "TEXT"),
];

Fields

table: &'static str

Parent table name

name: &'static str

Column name

sql_type: &'static str

SQL type, such as "INTEGER" or "TEXT"

not_null: bool

NOT NULL

primary_key: Option<PrimaryKeyKind>

Primary key form; None if not a primary key

unique: bool

UNIQUE

default: Option<&'static str>

DEFAULT value as SQL, such as "0" or "'active'"

generated: Option<GeneratedDef>

Generated column configuration

collate: Option<&'static str>

Collation name (BINARY, NOCASE, RTRIM, or a custom registered collation). None means the default collation (BINARY) and no COLLATE clause is emitted.

Implementations

impl ColumnDef

pub const fn new( table: &'static str, name: &'static str, sql_type: &'static str, ) -> Self

Creates a nullable column with no constraints.

pub const fn not_null(self) -> Self

Adds NOT NULL.

pub const fn autoincrement(self) -> Self

Makes the column PRIMARY KEY AUTOINCREMENT (and NOT NULL).

pub const fn primary_key(self) -> Self

Makes the column PRIMARY KEY (and NOT NULL), keeping AUTOINCREMENT if already set.

pub const fn primary(self) -> Self

Same as primary_key.

pub const fn unique(self) -> Self

Adds UNIQUE.

pub const fn default_value(self, value: &'static str) -> Self

Sets the DEFAULT value, written as SQL.

pub const fn generated_stored(self, expression: &'static str) -> Self

Makes the column GENERATED ALWAYS AS (expression) STORED.

pub const fn generated_virtual(self, expression: &'static str) -> Self

Makes the column GENERATED ALWAYS AS (expression) VIRTUAL.

pub const fn collate(self, name: &'static str) -> Self

Sets the column’s COLLATE sequence.

name should be a built-in collation (BINARY, NOCASE, RTRIM) or one registered on the connection with sqlite3_create_collation.

pub const fn into_column(self) -> Column

Converts to the runtime Column.

Trait Implementations

impl Clone for ColumnDef

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ColumnDef

impl Debug for ColumnDef

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

Formats the value using the given formatter.

impl Default for ColumnDef

fn default() -> Self

Returns the “default value” for a type.

impl Eq for ColumnDef

impl From<ColumnDef> for Column

fn from(def: ColumnDef) -> Self

Converts to this type from the input type.

impl Hash for ColumnDef

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 PartialEq for ColumnDef

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ColumnDef