Struct sea_query::table::TableAlterStatement[][src]

pub struct TableAlterStatement { /* fields omitted */ }

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[src]

pub fn new() -> Self[src]

Construct alter table statement

pub fn table<T: 'static>(self, table: T) -> Self where
    T: Iden
[src]

Set table name

pub fn add_column(self, column_def: ColumnDef) -> Self[src]

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 modify_column(self, column_def: ColumnDef) -> Self[src]

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>(
    self,
    from_name: T,
    to_name: R
) -> Self where
    T: Iden,
    R: Iden
[src]

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>(self, col_name: T) -> Self where
    T: Iden
[src]

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 build<T: TableBuilder>(&self, table_builder: T) -> String[src]

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

pub fn build_any(&self, table_builder: &dyn TableBuilder) -> String[src]

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

pub fn to_string<T: TableBuilder>(&self, table_builder: T) -> String[src]

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

Trait Implementations

impl Clone for TableAlterStatement[src]

impl Debug for TableAlterStatement[src]

impl Default for TableAlterStatement[src]

Auto Trait Implementations

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<V, T> VZip<V> for T where
    V: MultiLane<T>,