Struct sea_query::table::ColumnDef

pub struct ColumnDef { /* private fields */ }

Specification of a table column

Implementations

impl ColumnDef

pub fn new<T: 'static>(name: T) -> Self where
    T: Iden, 

Construct a table column

pub fn new_with_type<T: 'static>(name: T, types: ColumnType) -> Self where
    T: Iden, 

Construct a table column with column type

pub fn not_null(&mut self) -> &mut Self

Set column not null

pub fn default<T>(&mut self, value: T) -> &mut Self where
    T: Into<Value>, 

Set default value of a column

pub fn auto_increment(&mut self) -> &mut Self

Set column auto increment

pub fn unique_key(&mut self) -> &mut Self

Set column unique constraint

pub fn primary_key(&mut self) -> &mut Self

Set column as primary key

pub fn char_len(&mut self, length: u32) -> &mut Self

Set column type as char with custom length

pub fn char(&mut self) -> &mut Self

Set column type as char

pub fn string_len(&mut self, length: u32) -> &mut Self

Set column type as string with custom length

pub fn string(&mut self) -> &mut Self

Set column type as string

pub fn text(&mut self) -> &mut Self

Set column type as text

pub fn tiny_integer_len(&mut self, length: u32) -> &mut Self

Set column type as tiny_integer with custom length

pub fn tiny_integer(&mut self) -> &mut Self

Set column type as tiny_integer

pub fn small_integer_len(&mut self, length: u32) -> &mut Self

Set column type as small_integer with custom length

pub fn small_integer(&mut self) -> &mut Self

Set column type as small_integer

pub fn integer_len(&mut self, length: u32) -> &mut Self

Set column type as integer with custom length

pub fn integer(&mut self) -> &mut Self

Set column type as integer

pub fn big_integer_len(&mut self, length: u32) -> &mut Self

Set column type as big_integer with custom length

pub fn big_integer(&mut self) -> &mut Self

Set column type as big_integer

pub fn tiny_unsigned_len(&mut self, length: u32) -> &mut Self

Set column type as tiny_unsigned with custom length

pub fn tiny_unsigned(&mut self) -> &mut Self

Set column type as tiny_unsigned

pub fn small_unsigned_len(&mut self, length: u32) -> &mut Self

Set column type as small_unsigned with custom length

pub fn small_unsigned(&mut self) -> &mut Self

Set column type as small_unsigned

pub fn unsigned_len(&mut self, length: u32) -> &mut Self

Set column type as unsigned with custom length

pub fn unsigned(&mut self) -> &mut Self

Set column type as unsigned

pub fn big_unsigned_len(&mut self, length: u32) -> &mut Self

Set column type as big_unsigned with custom length

pub fn big_unsigned(&mut self) -> &mut Self

Set column type as big_unsigned

pub fn float_len(&mut self, precision: u32) -> &mut Self

Set column type as float with custom precision

pub fn float(&mut self) -> &mut Self

Set column type as float

pub fn double_len(&mut self, precision: u32) -> &mut Self

Set column type as double with custom precision

pub fn double(&mut self) -> &mut Self

Set column type as double

pub fn decimal_len(&mut self, precision: u32, scale: u32) -> &mut Self

Set column type as decimal with custom precision and scale

pub fn decimal(&mut self) -> &mut Self

Set column type as decimal

pub fn date_time_len(&mut self, precision: u32) -> &mut Self

Set column type as date_time with custom precision

pub fn date_time(&mut self) -> &mut Self

Set column type as date_time

pub fn interval(
    &mut self,
    fields: Option<PgInterval>,
    precision: Option<u32>
) -> &mut Self

Set column type as interval type with optional fields and precision. Postgres only

use sea_query::{tests_cfg::*, *};
assert_eq!(
    Table::create()
        .table(Glyph::Table)
        .col(
            ColumnDef::new(Alias::new("I1"))
                .interval(None, None)
                .not_null()
        )
        .col(
            ColumnDef::new(Alias::new("I2"))
                .interval(Some(PgInterval::YearToMonth), None)
                .not_null()
        )
        .col(
            ColumnDef::new(Alias::new("I3"))
                .interval(None, Some(42))
                .not_null()
        )
        .col(
            ColumnDef::new(Alias::new("I4"))
                .interval(Some(PgInterval::Hour), Some(43))
                .not_null()
        )
        .to_string(PostgresQueryBuilder),
    vec![
        r#"CREATE TABLE "glyph" ("#,
        r#""I1" interval NOT NULL,"#,
        r#""I2" interval YEAR TO MONTH NOT NULL,"#,
        r#""I3" interval(42) NOT NULL,"#,
        r#""I4" interval HOUR(43) NOT NULL"#,
        r#")"#,
    ]
    .join(" ")
);

pub fn timestamp_len(&mut self, precision: u32) -> &mut Self

Set column type as timestamp with custom precision

pub fn timestamp(&mut self) -> &mut Self

Set column type as timestamp

pub fn timestamp_with_time_zone(&mut self) -> &mut Self

Set column type as timestamp with time zone. Postgres only

pub fn timestamp_with_time_zone_len(&mut self, precision: u32) -> &mut Self

Set column type as timestamp with time zone plus custom precision

pub fn time_len(&mut self, precision: u32) -> &mut Self

Set column type as time with custom precision

pub fn time(&mut self) -> &mut Self

Set column type as time

pub fn date(&mut self) -> &mut Self

Set column type as date

pub fn binary_len(&mut self, length: u32) -> &mut Self

Set column type as binary with custom length

pub fn binary(&mut self) -> &mut Self

Set column type as binary

pub fn boolean(&mut self) -> &mut Self

Set column type as boolean

pub fn money_len(&mut self, precision: u32, scale: u32) -> &mut Self

Set column type as money with custom precision and scale

pub fn money(&mut self) -> &mut Self

Set column type as money

pub fn json(&mut self) -> &mut Self

Set column type as json. On MySQL, this is equivalent to json_binary. On MariaDB, this is equivalent to text. On PgSQL, this is equivalent to json.

pub fn json_binary(&mut self) -> &mut Self

Set column type as json binary. On MySQL, this is equivalent to json. On MariaDB, this is equivalent to text. On PgSQL, this is equivalent to jsonb.

pub fn uuid(&mut self) -> &mut Self

Set column type as uuid

pub fn custom<T: 'static>(&mut self, n: T) -> &mut Self where
    T: Iden, 

Use a custom type on this column.

pub fn enumeration<N, S, V>(&mut self, name: N, variants: V) -> &mut Self where
    N: ToString,
    S: ToString,
    V: IntoIterator<Item = S>, 

Set column type as enum.

pub fn array(&mut self, elem_type: String) -> &mut Self

Set column type as an array with a specified element type. This is only supported on Postgres.

pub fn extra(&mut self, string: String) -> &mut Self

Some extra options in custom string

pub fn get_column_name(&self) -> String

pub fn get_column_type(&self) -> Option<&ColumnType>

pub fn get_column_spec(&self) -> &Vec<ColumnSpec>

pub fn take(&mut self) -> Self

Trait Implementations

impl Clone for ColumnDef

fn clone(&self) -> ColumnDef

Returns a copy 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.