1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282
use crate::{backend::SchemaBuilder, prepare::*, types::*, ColumnDef, SchemaStatementBuilder};
/// 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"#,
/// );
/// ```
#[derive(Debug, Clone)]
pub struct TableAlterStatement {
pub(crate) table: Option<DynIden>,
pub(crate) options: Vec<TableAlterOption>,
}
/// table alter add column options
#[derive(Debug, Clone)]
pub struct AddColumnOption {
pub(crate) column: ColumnDef,
pub(crate) if_not_exists: bool,
}
/// All available table alter options
#[derive(Debug, Clone)]
pub enum TableAlterOption {
AddColumn(AddColumnOption),
ModifyColumn(ColumnDef),
RenameColumn(DynIden, DynIden),
DropColumn(DynIden),
}
impl Default for TableAlterStatement {
fn default() -> Self {
Self::new()
}
}
impl TableAlterStatement {
/// Construct alter table statement
pub fn new() -> Self {
Self {
table: None,
options: Vec::new(),
}
}
/// Set table name
pub fn table<T: 'static>(&mut self, table: T) -> &mut Self
where
T: Iden,
{
self.table = Some(SeaRc::new(table));
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(&mut self, column_def: &mut ColumnDef) -> &mut Self {
self.options
.push(TableAlterOption::AddColumn(AddColumnOption {
column: column_def.take(),
if_not_exists: false,
}));
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 add_column_if_not_exists(&mut self, column_def: &mut ColumnDef) -> &mut Self {
self.options
.push(TableAlterOption::AddColumn(AddColumnOption {
column: column_def.take(),
if_not_exists: true,
}));
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 modify_column(&mut self, column_def: &mut ColumnDef) -> &mut Self {
self.add_alter_option(TableAlterOption::ModifyColumn(column_def.take()))
}
/// 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 rename_column<T: 'static, R: 'static>(&mut self, from_name: T, to_name: R) -> &mut Self
where
T: Iden,
R: Iden,
{
self.add_alter_option(TableAlterOption::RenameColumn(
SeaRc::new(from_name),
SeaRc::new(to_name),
))
}
/// 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 drop_column<T: 'static>(&mut self, col_name: T) -> &mut Self
where
T: Iden,
{
self.add_alter_option(TableAlterOption::DropColumn(SeaRc::new(col_name)))
}
fn add_alter_option(&mut self, alter_option: TableAlterOption) -> &mut Self {
self.options.push(alter_option);
self
}
pub fn take(&mut self) -> Self {
Self {
table: self.table.take(),
options: std::mem::take(&mut self.options),
}
}
}
impl SchemaStatementBuilder for TableAlterStatement {
fn build<T: SchemaBuilder>(&self, schema_builder: T) -> String {
let mut sql = SqlWriter::new();
schema_builder.prepare_table_alter_statement(self, &mut sql);
sql.result()
}
fn build_any(&self, schema_builder: &dyn SchemaBuilder) -> String {
let mut sql = SqlWriter::new();
schema_builder.prepare_table_alter_statement(self, &mut sql);
sql.result()
}
}