Struct migration::ColumnDef

pub struct ColumnDef { /* private fields */ }

Expand description

Specification of a table column

Implementations§

§

impl ColumnDef

pub fn new<T>(name: T) -> ColumnDefwhere T: IntoIden,

Construct a table column

pub fn new_with_type<T>(name: T, types: ColumnType) -> ColumnDefwhere T: IntoIden,

Construct a table column with column type

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

Set column not null

pub fn null(&mut self) -> &mut ColumnDef

Set column null

pub fn default<T>(&mut self, value: T) -> &mut ColumnDefwhere T: Into<SimpleExpr>,

Set default value of a column

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

Set column auto increment

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

Set column unique constraint

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

Set column as primary key

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

Set column type as char with custom length

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

Set column type as char

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

Set column type as string with custom length

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

Set column type as string

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

Set column type as text

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

Set column type as tiny_integer

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

Set column type as small_integer

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

Set column type as integer

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

Set column type as big_integer

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

Set column type as tiny_unsigned

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

Set column type as small_unsigned

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

Set column type as unsigned

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

Set column type as big_unsigned

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

Set column type as float

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

Set column type as double

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

Set column type as decimal with custom precision and scale

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

Set column type as decimal

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

Set column type as date_time

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

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),
    [
        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(" ")
);