Struct sea_query::table::TableAlterStatement

pub struct TableAlterStatement { /* private fields */ }

Alter a table

Examples

use sea_query::{tests_cfg::*, *};

let table = Table::alter()
    .table(Font::Table)
    .add_column(
        ColumnDef::new(Alias::new("new_col"))
            .integer()
            .not_null()
            .default(100),
    )
    .to_owned();

assert_eq!(
    table.to_string(MysqlQueryBuilder),
    r#"ALTER TABLE `font` ADD COLUMN `new_col` int NOT NULL DEFAULT 100"#
);
assert_eq!(
    table.to_string(PostgresQueryBuilder),
    r#"ALTER TABLE "font" ADD COLUMN "new_col" integer NOT NULL DEFAULT 100"#
);
assert_eq!(
    table.to_string(SqliteQueryBuilder),
    r#"ALTER TABLE "font" ADD COLUMN "new_col" integer NOT NULL DEFAULT 100"#,
);

Implementations

impl TableAlterStatement

pub fn new() -> Self

Construct alter table statement

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

Set table name

pub fn add_column(&mut self, column_def: &mut ColumnDef) -> &mut Self

Add a column to an existing table

Examples

use sea_query::{tests_cfg::*, *};

let table = Table::alter()
    .table(Font::Table)
    .add_column(
        ColumnDef::new(Alias::new("new_col"))
            .integer()
            .not_null()
            .default(100),
    )
    .to_owned();

assert_eq!(
    table.to_string(MysqlQueryBuilder),
    r#"ALTER TABLE `font` ADD COLUMN `new_col` int NOT NULL DEFAULT 100"#
);
assert_eq!(
    table.to_string(PostgresQueryBuilder),
    r#"ALTER TABLE "font" ADD COLUMN "new_col" integer NOT NULL DEFAULT 100"#
);
assert_eq!(
    table.to_string(SqliteQueryBuilder),
    r#"ALTER TABLE "font" ADD COLUMN "new_col" integer NOT NULL DEFAULT 100"#,
);

pub fn add_column_if_not_exists(
    &mut self,
    column_def: &mut ColumnDef
) -> &mut Self

Try add a column to an existing table if it does not exists

Examples

use sea_query::{tests_cfg::*, *};

let table = Table::alter()
    .table(Font::Table)
    .add_column_if_not_exists(
        ColumnDef::new(Alias::new("new_col"))
            .integer()
            .not_null()
            .default(100),
    )
    .to_owned();

assert_eq!(
    table.to_string(MysqlQueryBuilder),
    r#"ALTER TABLE `font` ADD COLUMN IF NOT EXISTS `new_col` int NOT NULL DEFAULT 100"#
);
assert_eq!(
    table.to_string(PostgresQueryBuilder),
    r#"ALTER TABLE "font" ADD COLUMN IF NOT EXISTS "new_col" integer NOT NULL DEFAULT 100"#
);
assert_eq!(
    table.to_string(SqliteQueryBuilder),
    r#"ALTER TABLE "font" ADD COLUMN "new_col" integer NOT NULL DEFAULT 100"#,
);

pub fn modify_column(&mut self, column_def: &mut ColumnDef) -> &mut Self

Modify a column in an existing table

Examples

use sea_query::{tests_cfg::*, *};

let table = Table::alter()
    .table(Font::Table)
    .modify_column(
        ColumnDef::new(Alias::new("new_col"))
            .big_integer()
            .default(999),
    )
    .to_owned();

assert_eq!(
    table.to_string(MysqlQueryBuilder),
    r#"ALTER TABLE `font` MODIFY COLUMN `new_col` bigint DEFAULT 999"#
);
assert_eq!(
    table.to_string(PostgresQueryBuilder),
    vec![
        r#"ALTER TABLE "font""#,
        r#"ALTER COLUMN "new_col" TYPE bigint,"#,
        r#"ALTER COLUMN "new_col" SET DEFAULT 999"#,
    ]
    .join(" ")
);
// Sqlite not support modifying table column

pub fn rename_column<T: 'static, R: 'static>(
    &mut self,
    from_name: T,
    to_name: R
) -> &mut Self where
    T: Iden,
    R: Iden, 

Rename a column in an existing table

Examples

use sea_query::{tests_cfg::*, *};

let table = Table::alter()
    .table(Font::Table)
    .rename_column(Alias::new("new_col"), Alias::new("new_column"))
    .to_owned();

assert_eq!(
    table.to_string(MysqlQueryBuilder),
    r#"ALTER TABLE `font` RENAME COLUMN `new_col` TO `new_column`"#
);
assert_eq!(
    table.to_string(PostgresQueryBuilder),
    r#"ALTER TABLE "font" RENAME COLUMN "new_col" TO "new_column""#
);
assert_eq!(
    table.to_string(SqliteQueryBuilder),
    r#"ALTER TABLE "font" RENAME COLUMN "new_col" TO "new_column""#
);

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

Add a column to existing table

Examples

use sea_query::{tests_cfg::*, *};

let table = Table::alter()
    .table(Font::Table)
    .drop_column(Alias::new("new_column"))
    .to_owned();

assert_eq!(
    table.to_string(MysqlQueryBuilder),
    r#"ALTER TABLE `font` DROP COLUMN `new_column`"#
);
assert_eq!(
    table.to_string(PostgresQueryBuilder),
    r#"ALTER TABLE "font" DROP COLUMN "new_column""#
);
// Sqlite not support modifying table column

pub fn take(&mut self) -> Self

impl TableAlterStatement

pub fn to_string<T: SchemaBuilder>(&self, schema_builder: T) -> String

pub fn build<T: SchemaBuilder>(&self, schema_builder: T) -> String

pub fn build_any(&self, schema_builder: &dyn SchemaBuilder) -> String

Trait Implementations

impl Clone for TableAlterStatement

fn clone(&self) -> TableAlterStatement

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TableAlterStatement

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

Formats the value using the given formatter.

impl Default for TableAlterStatement

fn default() -> Self

Returns the “default value” for a type.

impl SchemaStatementBuilder for TableAlterStatement

fn build<T: SchemaBuilder>(&self, schema_builder: T) -> String

Build corresponding SQL statement for certain database backend and return SQL string

fn build_any(&self, schema_builder: &dyn SchemaBuilder) -> String

Build corresponding SQL statement for certain database backend and return SQL string

fn to_string<T: SchemaBuilder>(&self, schema_builder: T) -> String

Build corresponding SQL statement for certain database backend and return SQL string