sea_query/table/create.rs
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 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373
use inherent::inherent;
use crate::{
backend::SchemaBuilder, foreign_key::*, index::*, types::*, ColumnDef, IntoColumnDef,
SchemaStatementBuilder, SimpleExpr,
};
/// Create a table
///
/// # Examples
///
/// ```
/// use sea_query::{*, tests_cfg::*};
///
/// let table = Table::create()
/// .table(Char::Table)
/// .if_not_exists()
/// .comment("table's comment")
/// .col(ColumnDef::new(Char::Id).integer().not_null().auto_increment().primary_key())
/// .col(ColumnDef::new(Char::FontSize).integer().not_null().comment("font's size"))
/// .col(ColumnDef::new(Char::Character).string().not_null())
/// .col(ColumnDef::new(Char::SizeW).integer().not_null())
/// .col(ColumnDef::new(Char::SizeH).integer().not_null())
/// .col(ColumnDef::new(Char::FontId).integer().default(Value::Int(None)))
/// .foreign_key(
/// ForeignKey::create()
/// .name("FK_2e303c3a712662f1fc2a4d0aad6")
/// .from(Char::Table, Char::FontId)
/// .to(Font::Table, Font::Id)
/// .on_delete(ForeignKeyAction::Cascade)
/// .on_update(ForeignKeyAction::Cascade)
/// )
/// .to_owned();
///
/// assert_eq!(
/// table.to_string(MysqlQueryBuilder),
/// [
/// r#"CREATE TABLE IF NOT EXISTS `character` ("#,
/// r#"`id` int NOT NULL AUTO_INCREMENT PRIMARY KEY,"#,
/// r#"`font_size` int NOT NULL COMMENT 'font\'s size',"#,
/// r#"`character` varchar(255) NOT NULL,"#,
/// r#"`size_w` int NOT NULL,"#,
/// r#"`size_h` int NOT NULL,"#,
/// r#"`font_id` int DEFAULT NULL,"#,
/// r#"CONSTRAINT `FK_2e303c3a712662f1fc2a4d0aad6`"#,
/// r#"FOREIGN KEY (`font_id`) REFERENCES `font` (`id`)"#,
/// r#"ON DELETE CASCADE ON UPDATE CASCADE"#,
/// r#") COMMENT 'table\'s comment'"#,
/// ].join(" ")
/// );
/// assert_eq!(
/// table.to_string(PostgresQueryBuilder),
/// [
/// r#"CREATE TABLE IF NOT EXISTS "character" ("#,
/// r#""id" serial NOT NULL PRIMARY KEY,"#,
/// r#""font_size" integer NOT NULL,"#,
/// r#""character" varchar NOT NULL,"#,
/// r#""size_w" integer NOT NULL,"#,
/// r#""size_h" integer NOT NULL,"#,
/// r#""font_id" integer DEFAULT NULL,"#,
/// r#"CONSTRAINT "FK_2e303c3a712662f1fc2a4d0aad6""#,
/// r#"FOREIGN KEY ("font_id") REFERENCES "font" ("id")"#,
/// r#"ON DELETE CASCADE ON UPDATE CASCADE"#,
/// r#")"#,
/// ].join(" ")
/// );
/// assert_eq!(
/// table.to_string(SqliteQueryBuilder),
/// [
/// r#"CREATE TABLE IF NOT EXISTS "character" ("#,
/// r#""id" integer NOT NULL PRIMARY KEY AUTOINCREMENT,"#,
/// r#""font_size" integer NOT NULL,"#,
/// r#""character" varchar NOT NULL,"#,
/// r#""size_w" integer NOT NULL,"#,
/// r#""size_h" integer NOT NULL,"#,
/// r#""font_id" integer DEFAULT NULL,"#,
/// r#"FOREIGN KEY ("font_id") REFERENCES "font" ("id") ON DELETE CASCADE ON UPDATE CASCADE"#,
/// r#")"#,
/// ].join(" ")
/// );
/// ```
#[derive(Default, Debug, Clone)]
pub struct TableCreateStatement {
pub(crate) table: Option<TableRef>,
pub(crate) columns: Vec<ColumnDef>,
pub(crate) options: Vec<TableOpt>,
pub(crate) partitions: Vec<TablePartition>,
pub(crate) indexes: Vec<IndexCreateStatement>,
pub(crate) foreign_keys: Vec<ForeignKeyCreateStatement>,
pub(crate) if_not_exists: bool,
pub(crate) check: Vec<SimpleExpr>,
pub(crate) comment: Option<String>,
pub(crate) extra: Option<String>,
}
/// All available table options
#[derive(Debug, Clone)]
pub enum TableOpt {
Engine(String),
Collate(String),
CharacterSet(String),
}
/// All available table partition options
#[derive(Debug, Clone)]
pub enum TablePartition {}
impl TableCreateStatement {
/// Construct create table statement
pub fn new() -> Self {
Self::default()
}
/// Create table if table not exists
pub fn if_not_exists(&mut self) -> &mut Self {
self.if_not_exists = true;
self
}
/// Set table name
pub fn table<T>(&mut self, table: T) -> &mut Self
where
T: IntoTableRef,
{
self.table = Some(table.into_table_ref());
self
}
/// Set table comment
pub fn comment<T>(&mut self, comment: T) -> &mut Self
where
T: Into<String>,
{
self.comment = Some(comment.into());
self
}
/// Add a new table column
pub fn col<C: IntoColumnDef>(&mut self, column: C) -> &mut Self {
let mut column = column.into_column_def();
column.table.clone_from(&self.table);
self.columns.push(column);
self
}
pub fn check(&mut self, value: SimpleExpr) -> &mut Self {
self.check.push(value);
self
}
/// Add an index. MySQL only.
///
/// # Examples
///
/// ```
/// use sea_query::{tests_cfg::*, *};
///
/// assert_eq!(
/// Table::create()
/// .table(Glyph::Table)
/// .col(ColumnDef::new(Glyph::Id).integer().not_null())
/// .index(Index::create().unique().name("idx-glyph-id").col(Glyph::Id))
/// .to_string(MysqlQueryBuilder),
/// [
/// "CREATE TABLE `glyph` (",
/// "`id` int NOT NULL,",
/// "UNIQUE KEY `idx-glyph-id` (`id`)",
/// ")",
/// ]
/// .join(" ")
/// );
/// ```
pub fn index(&mut self, index: &mut IndexCreateStatement) -> &mut Self {
self.indexes.push(index.take());
self
}
/// Add an primary key.
///
/// # Examples
///
/// ```
/// use sea_query::{tests_cfg::*, *};
///
/// let mut statement = Table::create();
/// statement
/// .table(Glyph::Table)
/// .col(ColumnDef::new(Glyph::Id).integer().not_null())
/// .col(ColumnDef::new(Glyph::Image).string().not_null())
/// .primary_key(Index::create().col(Glyph::Id).col(Glyph::Image));
/// assert_eq!(
/// statement.to_string(MysqlQueryBuilder),
/// [
/// "CREATE TABLE `glyph` (",
/// "`id` int NOT NULL,",
/// "`image` varchar(255) NOT NULL,",
/// "PRIMARY KEY (`id`, `image`)",
/// ")",
/// ]
/// .join(" ")
/// );
/// assert_eq!(
/// statement.to_string(PostgresQueryBuilder),
/// [
/// "CREATE TABLE \"glyph\" (",
/// "\"id\" integer NOT NULL,",
/// "\"image\" varchar NOT NULL,",
/// "PRIMARY KEY (\"id\", \"image\")",
/// ")",
/// ]
/// .join(" ")
/// );
/// assert_eq!(
/// statement.to_string(SqliteQueryBuilder),
/// [
/// r#"CREATE TABLE "glyph" ("#,
/// r#""id" integer NOT NULL,"#,
/// r#""image" varchar NOT NULL,"#,
/// r#"PRIMARY KEY ("id", "image")"#,
/// r#")"#,
/// ]
/// .join(" ")
/// );
/// ```
pub fn primary_key(&mut self, index: &mut IndexCreateStatement) -> &mut Self {
let mut index = index.take();
index.primary = true;
self.indexes.push(index);
self
}
/// Add a foreign key
pub fn foreign_key(&mut self, foreign_key: &mut ForeignKeyCreateStatement) -> &mut Self {
self.foreign_keys.push(foreign_key.take());
self
}
/// Set database engine. MySQL only.
pub fn engine<T>(&mut self, string: T) -> &mut Self
where
T: Into<String>,
{
self.opt(TableOpt::Engine(string.into()));
self
}
/// Set database collate. MySQL only.
pub fn collate<T>(&mut self, string: T) -> &mut Self
where
T: Into<String>,
{
self.opt(TableOpt::Collate(string.into()));
self
}
/// Set database character set. MySQL only.
pub fn character_set<T>(&mut self, name: T) -> &mut Self
where
T: Into<String>,
{
self.opt(TableOpt::CharacterSet(name.into()));
self
}
fn opt(&mut self, option: TableOpt) -> &mut Self {
self.options.push(option);
self
}
#[allow(dead_code)]
fn partition(&mut self, partition: TablePartition) -> &mut Self {
self.partitions.push(partition);
self
}
pub fn get_table_name(&self) -> Option<&TableRef> {
self.table.as_ref()
}
pub fn get_columns(&self) -> &Vec<ColumnDef> {
self.columns.as_ref()
}
pub fn get_comment(&self) -> Option<&String> {
self.comment.as_ref()
}
pub fn get_foreign_key_create_stmts(&self) -> &Vec<ForeignKeyCreateStatement> {
self.foreign_keys.as_ref()
}
pub fn get_indexes(&self) -> &Vec<IndexCreateStatement> {
self.indexes.as_ref()
}
/// Rewriting extra param. You should take care self about concat extra params. Add extra after options.
/// Example for PostgresSQL [Citus](https://github.com/citusdata/citus) extension:
/// ```
/// use sea_query::{tests_cfg::*, *};
/// let table = Table::create()
/// .table(Char::Table)
/// .col(
/// ColumnDef::new(Char::Id)
/// .uuid()
/// .extra("DEFAULT uuid_generate_v4()")
/// .primary_key()
/// .not_null(),
/// )
/// .col(
/// ColumnDef::new(Char::CreatedAt)
/// .timestamp_with_time_zone()
/// .extra("DEFAULT NOW()")
/// .not_null(),
/// )
/// .col(ColumnDef::new(Char::UserData).json_binary().not_null())
/// .extra("USING columnar")
/// .to_owned();
/// assert_eq!(
/// table.to_string(PostgresQueryBuilder),
/// [
/// r#"CREATE TABLE "character" ("#,
/// r#""id" uuid DEFAULT uuid_generate_v4() PRIMARY KEY NOT NULL,"#,
/// r#""created_at" timestamp with time zone DEFAULT NOW() NOT NULL,"#,
/// r#""user_data" jsonb NOT NULL"#,
/// r#") USING columnar"#,
/// ]
/// .join(" ")
/// );
/// ```
pub fn extra<T>(&mut self, extra: T) -> &mut Self
where
T: Into<String>,
{
self.extra = Some(extra.into());
self
}
pub fn get_extra(&self) -> Option<&String> {
self.extra.as_ref()
}
pub fn take(&mut self) -> Self {
Self {
table: self.table.take(),
columns: std::mem::take(&mut self.columns),
options: std::mem::take(&mut self.options),
partitions: std::mem::take(&mut self.partitions),
indexes: std::mem::take(&mut self.indexes),
foreign_keys: std::mem::take(&mut self.foreign_keys),
if_not_exists: self.if_not_exists,
check: std::mem::take(&mut self.check),
comment: std::mem::take(&mut self.comment),
extra: std::mem::take(&mut self.extra),
}
}
}
#[inherent]
impl SchemaStatementBuilder for TableCreateStatement {
pub fn build<T: SchemaBuilder>(&self, schema_builder: T) -> String {
let mut sql = String::with_capacity(256);
schema_builder.prepare_table_create_statement(self, &mut sql);
sql
}
pub fn build_any(&self, schema_builder: &dyn SchemaBuilder) -> String {
let mut sql = String::with_capacity(256);
schema_builder.prepare_table_create_statement(self, &mut sql);
sql
}
pub fn to_string<T: SchemaBuilder>(&self, schema_builder: T) -> String;
}