Struct TypeAlterStatement

pub struct TypeAlterStatement { /* private fields */ }

Available on crate feature backend-postgres only.

Implementations

impl TypeAlterStatement

pub fn new() -> Self

pub fn name<T>(self, name: T) -> Self

where T: IntoTypeRef,

Change the definition of a type

use sea_query::{extension::postgres::Type, *};

enum FontFamily {
    Type,
    Serif,
    Sans,
    Monospace,
}

impl Iden for FontFamily {
    fn unquoted(&self, s: &mut dyn Write) {
        write!(
            s,
            "{}",
            match self {
                Self::Type => "font_family",
                Self::Serif => "serif",
                Self::Sans => "sans",
                Self::Monospace => "monospace",
            }
        )
        .unwrap();
    }
}

assert_eq!(
    Type::alter()
        .name(FontFamily::Type)
        .add_value(Alias::new("cursive"))
        .to_string(PostgresQueryBuilder),
    r#"ALTER TYPE "font_family" ADD VALUE 'cursive'"#
);

pub fn add_value<T>(self, value: T) -> Self

where T: IntoIden,

pub fn before<T>(self, value: T) -> Self

where T: IntoIden,

Add a enum value before an existing value

use sea_query::{extension::postgres::Type, tests_cfg::*, *};

assert_eq!(
    Type::alter()
        .name(Font::Table)
        .add_value(Alias::new("weight"))
        .before(Font::Variant)
        .to_string(PostgresQueryBuilder),
    r#"ALTER TYPE "font" ADD VALUE 'weight' BEFORE 'variant'"#
)

pub fn after<T>(self, value: T) -> Self

where T: IntoIden,

pub fn if_not_exists(self) -> Self

Add a enum value if not already exists

use sea_query::{extension::postgres::Type, tests_cfg::*, *};

assert_eq!(
    Type::alter()
        .name(Font::Table)
        .add_value(Alias::new("weight"))
        .if_not_exists()
        .after(Font::Variant)
        .to_string(PostgresQueryBuilder),
    r#"ALTER TYPE "font" ADD VALUE IF NOT EXISTS 'weight' AFTER 'variant'"#
)

pub fn rename_to<T>(self, name: T) -> Self

where T: IntoIden,

pub fn rename_value<T, V>(self, existing: T, new_name: V) -> Self

where T: IntoIden, V: IntoIden,

Rename a enum value

use sea_query::{extension::postgres::Type, tests_cfg::*, *};

assert_eq!(
    Type::alter()
        .name(Font::Table)
        .rename_value(Alias::new("variant"), Alias::new("language"))
        .to_string(PostgresQueryBuilder),
    r#"ALTER TYPE "font" RENAME VALUE 'variant' TO 'language'"#
)

impl TypeAlterStatement

pub fn build_ref<T: TypeBuilder>(&self, type_builder: &T) -> String

pub fn build_collect<T: TypeBuilder>( &self, type_builder: T, sql: &mut dyn SqlWriter, ) -> String

pub fn build_collect_ref<T: TypeBuilder>( &self, type_builder: &T, sql: &mut dyn SqlWriter, ) -> String

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

where T: TypeBuilder + QueryBuilder,

Build corresponding SQL statement and return SQL string

Trait Implementations

impl Clone for TypeAlterStatement

fn clone(&self) -> TypeAlterStatement

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TypeAlterStatement

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

Formats the value using the given formatter.

impl Default for TypeAlterStatement

fn default() -> TypeAlterStatement

Returns the “default value” for a type.