Struct ColumnDef 

pub struct ColumnDef {
    pub schema: &'static str,
    pub table: &'static str,
    pub name: &'static str,
    pub sql_type: &'static str,
    pub type_schema: Option<&'static str>,
    pub not_null: bool,
    pub default: Option<&'static str>,
    pub generated: Option<GeneratedDef>,
    pub identity: Option<IdentityDef>,
    pub dimensions: Option<i32>,
    pub comment: Option<&'static str>,
    pub collate: Option<&'static str>,
}

A column definition that can be built in a const.

Primary keys and unique constraints are separate entities (PrimaryKeyDef, UniqueConstraintDef).

Examples

use drizzle_types::postgres::ddl::{ColumnDef, IdentityDef, IdentityType};

const ID: ColumnDef = ColumnDef::new("public", "users", "id", "integer")
    .not_null()
    .identity(IdentityDef::new("users_id_seq", IdentityType::Always));

let column = ID.into_column();
assert!(column.identity.is_some());

Fields

schema: &'static str

Schema name

table: &'static str

Parent table name

name: &'static str

Column name

sql_type: &'static str

SQL type, such as "integer" or "varchar(255)"; for an enum, the enum’s type name

type_schema: Option<&'static str>

Schema of a custom or enum type

not_null: bool

NOT NULL

default: Option<&'static str>

DEFAULT value as SQL

generated: Option<GeneratedDef>

Generated column configuration

identity: Option<IdentityDef>

Identity column configuration

dimensions: Option<i32>

Number of array dimensions: Some(1) renders type[]

comment: Option<&'static str>

Column comment, emitted as COMMENT ON COLUMN

collate: Option<&'static str>

Collation name (e.g. "en_US", "C", "POSIX", or a custom CREATE COLLATION name). None uses the type’s default collation and emits no COLLATE clause.

Implementations

impl ColumnDef

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

Creates a nullable column with no default.

pub const fn type_schema(self, schema: &'static str) -> Self

Sets the schema of a custom or enum type.

pub const fn not_null(self) -> Self

Adds NOT NULL.

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 identity(self, identity: IdentityDef) -> Self

Makes the column an identity column.

pub const fn dimensions(self, dims: i32) -> Self

Sets the number of array dimensions.

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

Sets the column comment.

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

Sets the column’s collation.

Pass the bare name, such as en_US; it is rendered quoted, as in COLLATE "en_US".

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