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 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596
//! A database agnostic runtime query builder for Rust. //! //! This library aims to provide an ergonomic API to construct Abstract Syntax Trees for SQL. //! The AST is generic by design and can be serialized to different SQL variants. //! We align the behaviour between different engines where appropriate, while offering vendor specific features via extensions. //! //! This library is the foundation of upcoming projects: Document ORM (SeaORM) and Database Synchor (SeaHorse). //! //! # Usage //! //! Table of Content //! //! 1. Background //! //! 1. [Iden](#iden) //! 1. [Expression](#expression) //! 1. [Statement Building](#statement-building) //! //! 1. Query Statement //! //! 1. [Query Select](#query-select) //! 1. [Query Insert](#query-insert) //! 1. [Query Update](#query-update) //! 1. [Query Delete](#query-delete) //! //! 1. Table Statement //! //! 1. [Table Create](#table-create) //! 1. [Table Alter](#table-alter) //! 1. [Table Drop](#table-drop) //! 1. [Table Rename](#table-rename) //! 1. [Table Truncate](#table-truncate) //! 1. [Foreign Key Create](#foreign-key-create) //! 1. [Foreign Key Drop](#foreign-key-drop) //! 1. [Index Create](#index-create) //! 1. [Index Drop](#index-drop) //! //! Construct a SQL statement with the library then execute the statement with a database connector, //! see SQLx example [here](https://github.com/SeaQL/sea-query/blob/master/examples/sqlx.rs). //! //! ## Iden //! //! A trait for identifiers used in any query statement. //! //! Commonly implemented by Enum where each Enum represent a table found in a database, //! and its variants include table name and column name. //! //! [`Iden::unquoted()`] must be implemented to provide a mapping between Enum variant and its corresponding string value. //! //! ``` //! use sea_query::{*, tests_cfg::*}; //! //! // For example Character table with column id, character, font_size... //! pub enum Character { //! Table, //! Id, //! Character, //! FontSize, //! SizeW, //! SizeH, //! FontId, //! } //! //! // Mapping between Enum variant and its corresponding string value //! impl Iden for Character { //! fn unquoted(&self, s: &mut dyn FmtWrite) { //! write!(s, "{}", match self { //! Self::Table => "character", //! Self::Id => "id", //! Self::Character => "character", //! Self::FontSize => "font_size", //! Self::SizeW => "size_w", //! Self::SizeH => "size_h", //! Self::FontId => "font_id", //! }).unwrap(); //! } //! } //! ``` //! //! If you're okay with running another procedural macro, you can activate //! the `derive` feature on the crate to save you some boilerplate: //! //! ```rust //! # #[cfg(feature = "derive")] //! use sea_query::Iden; //! //! // This will implement Iden exactly as shown above //! # #[cfg(feature = "derive")] //! #[derive(Iden)] //! pub enum Character { //! Table, //! Id, //! Character, //! FontSize, //! SizeW, //! SizeH, //! FontId, //! } //! ``` //! //! You can also override the generated column names by specifying an `#[iden = ""]` //! attribute on the enum or any of its variants; for more information, look at //! [the derive example](https://github.com/SeaQL/sea-query/blob/master/examples/derive.rs). //! //! ## Expression //! //! Use [`Expr`] to construct select, join, where and having expression in query. //! //! ``` //! use sea_query::{*, tests_cfg::*}; //! //! assert_eq!( //! Query::select() //! .column(Char::Character) //! .from(Char::Table) //! .left_join(Font::Table, Expr::tbl(Char::Table, Char::FontId).equals(Font::Table, Font::Id)) //! .and_where( //! Expr::expr(Expr::col(Char::SizeW).add(1)).mul(2) //! .equals(Expr::expr(Expr::col(Char::SizeH).div(2)).sub(1)) //! ) //! .and_where(Expr::col(Char::SizeW).in_subquery( //! Query::select() //! .expr(Expr::cust("3 + 2 * 2")) //! .take() //! )) //! .or_where(Expr::col(Char::Character).like("D").and(Expr::col(Char::Character).like("E"))) //! .to_string(MysqlQueryBuilder), //! vec![ //! "SELECT `character` FROM `character`", //! "LEFT JOIN `font` ON `character`.`font_id` = `font`.`id`", //! "WHERE ((`size_w` + 1) * 2 = (`size_h` / 2) - 1)", //! "AND `size_w` IN (SELECT 3 + 2 * 2)", //! "OR ((`character` LIKE 'D') AND (`character` LIKE 'E'))", //! ].join(" ") //! ); //! ``` //! //! ## Statement Building //! //! All the query statements and table statements support the following ways to build database specific SQL statement: //! //! 1. `build(&self, query_builder: T) -> (String, Vec<Value>)` //! Build a SQL statement in string and collect parameters into a vector, see [here](https://docs.rs/sea-query/*/sea_query/query/struct.SelectStatement.html#method.build) for example. //! //! 1. `build_collect(&self, query_builder: T, collector: &mut dyn FnMut(Value)) -> String` //! Build a SQL statement in string and collect parameters into a user defined collector, see [here](https://docs.rs/sea-query/*/sea_query/query/struct.SelectStatement.html#method.build_collect) for example. //! //! 1. `to_string(&self, query_builder: T) -> String` //! Build a SQL statement in string with parameters in it, see [here](https://docs.rs/sea-query/*/sea_query/query/struct.SelectStatement.html#method.to_string) for example. //! //! ## Query Select //! //! See [`SelectStatement`] for the full documentation. //! //! ``` //! use sea_query::{*, tests_cfg::*}; //! //! let query = Query::select() //! .column(Char::Character) //! .table_column(Font::Table, Font::Name) //! .from(Char::Table) //! .left_join(Font::Table, Expr::tbl(Char::Table, Char::FontId).equals(Font::Table, Font::Id)) //! .and_where(Expr::col(Char::SizeW).is_in(vec![3, 4])) //! .and_where(Expr::col(Char::Character).like("A%")) //! .to_owned(); //! //! assert_eq!( //! query.to_string(MysqlQueryBuilder), //! r#"SELECT `character`, `font`.`name` FROM `character` LEFT JOIN `font` ON `character`.`font_id` = `font`.`id` WHERE `size_w` IN (3, 4) AND `character` LIKE 'A%'"# //! ); //! assert_eq!( //! query.to_string(PostgresQueryBuilder), //! r#"SELECT "character", "font"."name" FROM "character" LEFT JOIN "font" ON "character"."font_id" = "font"."id" WHERE "size_w" IN (3, 4) AND "character" LIKE 'A%'"# //! ); //! assert_eq!( //! query.to_string(SqliteQueryBuilder), //! r#"SELECT `character`, `font`.`name` FROM `character` LEFT JOIN `font` ON `character`.`font_id` = `font`.`id` WHERE `size_w` IN (3, 4) AND `character` LIKE 'A%'"# //! ); //! ``` //! //! ## Query Insert //! //! See [`InsertStatement`] for the full documentation. //! //! ``` //! use sea_query::{*, tests_cfg::*}; //! //! let query = Query::insert() //! .into_table(Glyph::Table) //! .columns(vec![ //! Glyph::Aspect, //! Glyph::Image, //! ]) //! .values_panic(vec![ //! 5.15.into(), //! "12A".into(), //! ]) //! .json(json!({ //! "aspect": 4.21, //! "image": "123", //! })) //! .to_owned(); //! //! assert_eq!( //! query.to_string(MysqlQueryBuilder), //! r#"INSERT INTO `glyph` (`aspect`, `image`) VALUES (5.15, '12A'), (4.21, '123')"# //! ); //! assert_eq!( //! query.to_string(PostgresQueryBuilder), //! r#"INSERT INTO "glyph" ("aspect", "image") VALUES (5.15, '12A'), (4.21, '123')"# //! ); //! assert_eq!( //! query.to_string(SqliteQueryBuilder), //! r#"INSERT INTO `glyph` (`aspect`, `image`) VALUES (5.15, '12A'), (4.21, '123')"# //! ); //! ``` //! //! ## Query Update //! //! See [`UpdateStatement`] for the full documentation. //! //! ``` //! use sea_query::{*, tests_cfg::*}; //! //! let query = Query::update() //! .table(Glyph::Table) //! .values(vec![ //! (Glyph::Aspect, 1.23.into()), //! (Glyph::Image, "123".into()), //! ]) //! .and_where(Expr::col(Glyph::Id).eq(1)) //! .to_owned(); //! //! assert_eq!( //! query.to_string(MysqlQueryBuilder), //! r#"UPDATE `glyph` SET `aspect` = 1.23, `image` = '123' WHERE `id` = 1"# //! ); //! assert_eq!( //! query.to_string(PostgresQueryBuilder), //! r#"UPDATE "glyph" SET "aspect" = 1.23, "image" = '123' WHERE "id" = 1"# //! ); //! assert_eq!( //! query.to_string(SqliteQueryBuilder), //! r#"UPDATE `glyph` SET `aspect` = 1.23, `image` = '123' WHERE `id` = 1"# //! ); //! ``` //! //! ## Query Delete //! //! See [`DeleteStatement`] for the full documentation. //! //! ``` //! use sea_query::{*, tests_cfg::*}; //! //! let query = Query::delete() //! .from_table(Glyph::Table) //! .or_where(Expr::col(Glyph::Id).lt(1)) //! .or_where(Expr::col(Glyph::Id).gt(10)) //! .to_owned(); //! //! assert_eq!( //! query.to_string(MysqlQueryBuilder), //! r#"DELETE FROM `glyph` WHERE (`id` < 1) OR (`id` > 10)"# //! ); //! assert_eq!( //! query.to_string(PostgresQueryBuilder), //! r#"DELETE FROM "glyph" WHERE ("id" < 1) OR ("id" > 10)"# //! ); //! assert_eq!( //! query.to_string(SqliteQueryBuilder), //! r#"DELETE FROM `glyph` WHERE (`id` < 1) OR (`id` > 10)"# //! ); //! ``` //! //! ## Table Create //! //! See [`TableCreateStatement`] for the full documentation. //! //! ``` //! use sea_query::{*, tests_cfg::*}; //! //! let table = Table::create() //! .table(Char::Table) //! .create_if_not_exists() //! .col(ColumnDef::new(Char::Id).integer().not_null().auto_increment().primary_key()) //! .col(ColumnDef::new(Char::FontSize).integer().not_null()) //! .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::Null)) //! .foreign_key( //! ForeignKey::create() //! .name("FK_2e303c3a712662f1fc2a4d0aad6") //! .table(Char::Table, Font::Table) //! .col(Char::FontId, Font::Id) //! .on_delete(ForeignKeyAction::Cascade) //! .on_update(ForeignKeyAction::Cascade) //! ) //! .to_owned(); //! //! assert_eq!( //! table.to_string(MysqlQueryBuilder), //! vec![ //! r#"CREATE TABLE IF NOT EXISTS `character` ("#, //! r#"`id` int NOT NULL AUTO_INCREMENT PRIMARY KEY,"#, //! r#"`font_size` int NOT NULL,"#, //! 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 `FK_2e303c3a712662f1fc2a4d0aad6` (`font_id`) REFERENCES `font` (`id`)"#, //! r#"ON DELETE CASCADE ON UPDATE CASCADE"#, //! r#")"#, //! ].join(" ") //! ); //! assert_eq!( //! table.to_string(PostgresQueryBuilder), //! vec![ //! 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), //! vec![ //! r#"CREATE TABLE IF NOT EXISTS `character` ("#, //! r#"`id` integer NOT NULL PRIMARY KEY AUTOINCREMENT,"#, //! r#"`font_size` integer NOT NULL,"#, //! r#"`character` text 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(" ") //! ); //! ``` //! //! ## Table Alter //! //! See [`TableAlterStatement`] for the full documentation. //! //! ``` //! 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"#, //! ); //! ``` //! //! ## Table Drop //! //! See [`TableDropStatement`] for the full documentation. //! //! ``` //! use sea_query::{*, tests_cfg::*}; //! //! let table = Table::drop() //! .table(Glyph::Table) //! .table(Char::Table) //! .to_owned(); //! //! assert_eq!( //! table.to_string(MysqlQueryBuilder), //! r#"DROP TABLE `glyph`, `character`"# //! ); //! assert_eq!( //! table.to_string(PostgresQueryBuilder), //! r#"DROP TABLE "glyph", "character""# //! ); //! assert_eq!( //! table.to_string(SqliteQueryBuilder), //! r#"DROP TABLE `glyph`, `character`"# //! ); //! ``` //! //! ## Table Rename //! //! See [`TableRenameStatement`] for the full documentation. //! //! ``` //! use sea_query::{*, tests_cfg::*}; //! //! let table = Table::rename() //! .table(Font::Table, Alias::new("font_new")) //! .to_owned(); //! //! assert_eq!( //! table.to_string(MysqlQueryBuilder), //! r#"RENAME TABLE `font` TO `font_new`"# //! ); //! assert_eq!( //! table.to_string(PostgresQueryBuilder), //! r#"ALTER TABLE "font" RENAME TO "font_new""# //! ); //! assert_eq!( //! table.to_string(SqliteQueryBuilder), //! r#"ALTER TABLE `font` RENAME TO `font_new`"# //! ); //! ``` //! //! ## Table Truncate //! //! See [`TableTruncateStatement`] for the full documentation. //! //! ``` //! use sea_query::{*, tests_cfg::*}; //! //! let table = Table::truncate() //! .table(Font::Table) //! .to_owned(); //! //! assert_eq!( //! table.to_string(MysqlQueryBuilder), //! r#"TRUNCATE TABLE `font`"# //! ); //! assert_eq!( //! table.to_string(PostgresQueryBuilder), //! r#"TRUNCATE TABLE "font""# //! ); //! assert_eq!( //! table.to_string(SqliteQueryBuilder), //! r#"TRUNCATE TABLE `font`"# //! ); //! ``` //! //! ## Foreign Key Create //! //! See [`ForeignKeyCreateStatement`] for the full documentation. //! //! ``` //! use sea_query::{*, tests_cfg::*}; //! //! let foreign_key = ForeignKey::create() //! .name("FK_character_font") //! .table(Char::Table, Font::Table) //! .col(Char::FontId, Font::Id) //! .on_delete(ForeignKeyAction::Cascade) //! .on_update(ForeignKeyAction::Cascade) //! .to_owned(); //! //! assert_eq!( //! foreign_key.to_string(MysqlQueryBuilder), //! vec![ //! r#"ALTER TABLE `character`"#, //! r#"ADD CONSTRAINT `FK_character_font`"#, //! r#"FOREIGN KEY `FK_character_font` (`font_id`) REFERENCES `font` (`id`)"#, //! r#"ON DELETE CASCADE ON UPDATE CASCADE"#, //! ].join(" ") //! ); //! assert_eq!( //! foreign_key.to_string(PostgresQueryBuilder), //! vec![ //! r#"ALTER TABLE "character" ADD CONSTRAINT "FK_character_font""#, //! r#"FOREIGN KEY ("font_id") REFERENCES "font" ("id")"#, //! r#"ON DELETE CASCADE ON UPDATE CASCADE"#, //! ].join(" ") //! ); //! // Sqlite does not support modification of foreign key constraints to existing tables //! ``` //! //! ## Foreign Key Drop //! //! See [`ForeignKeyDropStatement`] for the full documentation. //! //! ``` //! use sea_query::{*, tests_cfg::*}; //! //! let foreign_key = ForeignKey::drop() //! .name("FK_character_font") //! .table(Char::Table) //! .to_owned(); //! //! assert_eq!( //! foreign_key.to_string(MysqlQueryBuilder), //! r#"ALTER TABLE `character` DROP FOREIGN KEY `FK_character_font`"# //! ); //! assert_eq!( //! foreign_key.to_string(PostgresQueryBuilder), //! r#"ALTER TABLE "character" DROP CONSTRAINT "FK_character_font""# //! ); //! // Sqlite does not support modification of foreign key constraints to existing tables //! ``` //! //! ## Index Create //! //! See [`IndexCreateStatement`] for the full documentation. //! //! ``` //! use sea_query::{*, tests_cfg::*}; //! //! let index = Index::create() //! .name("idx-glyph-aspect") //! .table(Glyph::Table) //! .col(Glyph::Aspect) //! .to_owned(); //! //! assert_eq!( //! index.to_string(MysqlQueryBuilder), //! r#"CREATE INDEX `idx-glyph-aspect` ON `glyph` (`aspect`)"# //! ); //! assert_eq!( //! index.to_string(PostgresQueryBuilder), //! r#"CREATE INDEX "idx-glyph-aspect" ON "glyph" ("aspect")"# //! ); //! assert_eq!( //! index.to_string(SqliteQueryBuilder), //! r#"CREATE INDEX `idx-glyph-aspect` ON `glyph` (`aspect`)"# //! ); //! ``` //! //! ## Index Drop //! //! See [`IndexDropStatement`] for the full documentation. //! //! ``` //! use sea_query::{*, tests_cfg::*}; //! //! let index = Index::drop() //! .name("idx-glyph-aspect") //! .table(Glyph::Table) //! .to_owned(); //! //! assert_eq!( //! index.to_string(MysqlQueryBuilder), //! r#"DROP INDEX `idx-glyph-aspect` ON `glyph`"# //! ); //! assert_eq!( //! index.to_string(PostgresQueryBuilder), //! r#"DROP INDEX "idx-glyph-aspect""# //! ); //! assert_eq!( //! index.to_string(SqliteQueryBuilder), //! r#"DROP INDEX `idx-glyph-aspect` ON `glyph`"# //! ); //! ``` //! //! # Work in Progress //! //! - Sqlite pub mod backend; pub mod driver; pub mod extension; pub mod foreign_key; pub mod index; pub mod query; pub mod table; pub mod expr; pub mod func; pub mod prepare; pub mod tests_cfg; pub mod token; pub mod types; pub mod value; pub use backend::*; pub use driver::*; //pub use extension::*; pub use foreign_key::*; pub use index::*; pub use query::*; pub use table::*; pub use expr::*; pub use func::*; pub use prepare::*; pub use types::*; pub use token::*; pub use value::*; #[cfg(feature = "derive")] pub use sea_query_derive::Iden;