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>,
}

Const-friendly column definition for compile-time schema definitions.

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 (e.g., “INTEGER”, “TEXT”, “REAL”, “BLOB”)

not_null: bool

Is this column NOT NULL?

primary_key: Option<PrimaryKeyKind>

Primary-key variant (None if not a primary key)

unique: bool

Is this column UNIQUE?

default: Option<&'static str>

Default value as string (if any)

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

Create a new column definition

pub const fn not_null(self) -> Self

Set NOT NULL constraint

pub const fn autoincrement(self) -> Self

Set AUTOINCREMENT (implies PRIMARY KEY and NOT NULL)

pub const fn primary_key(self) -> Self

Set PRIMARY KEY (also sets NOT NULL). Preserves AUTOINCREMENT if already set.

pub const fn primary(self) -> Self

Alias for primary_key()

pub const fn unique(self) -> Self

Set UNIQUE constraint

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

Set default value

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

Set as generated stored column

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

Set as generated virtual column

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

Set the collation sequence for this column.

name should be one of SQLite’s built-in collations (BINARY, NOCASE, RTRIM) or a custom collation that’s registered on the connection at runtime via sqlite3_create_collation.

pub const fn into_column(self) -> Column

Convert to runtime Column type

Trait Implementations

impl Clone for ColumnDef

fn clone(&self) -> ColumnDef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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 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: &ColumnDef) -> 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 Copy for ColumnDef

impl Eq for ColumnDef

impl StructuralPartialEq for ColumnDef