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 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799
use crate::{
behavior::{push_unique, Concat, TransactionQuery, WithQuery},
fmt,
structure::{LogicalOperator, Select, SelectClause},
};
impl TransactionQuery for Select {}
impl WithQuery for Select {}
impl Select {
/// Gets the current state of the [Select] and returns it as string
///
/// # Example
///
/// ```
/// # use sql_query_builder as sql;
/// let select_query = sql::Select::new()
/// .select("id")
/// .from("users")
/// .where_clause("login = 'foo'")
/// .as_string();
///
/// # let expected = "SELECT id FROM users WHERE login = 'foo'";
/// # assert_eq!(select_query, expected);
/// ```
///
/// Output
///
/// ```sql
/// SELECT id FROM users WHERE login = 'foo'
/// ```
pub fn as_string(&self) -> String {
let fmts = fmt::one_line();
self.concat(&fmts)
}
/// Prints the current state of the [Select] to the standard output in a more ease to read version.
/// This method is useful to debug complex queries or just print the generated SQL while you type
///
/// # Example
///
/// ```
/// # use sql_query_builder as sql;
/// let select = sql::Select::new()
/// .select("*")
/// .from("users")
/// .where_clause("login = foo")
/// .where_clause("active = true")
/// .debug();
/// ```
///
/// Prints to the standard output
///
/// ```sql
/// -- ------------------------------------------------------------------------------
/// SELECT *
/// FROM users
/// WHERE login = foo AND active = true
/// -- ------------------------------------------------------------------------------
/// ```
///
/// You can debug different parts of the select putting it in another position
///
/// # Example
///
/// ```
/// # use sql_query_builder as sql;
/// let select_query = sql::Select::new()
/// .select("*")
/// .from("users")
/// .debug()
/// .where_clause("login = foo")
/// .where_clause("active = true")
/// .as_string();
/// ```
///
/// Prints to the standard output
///
/// ```sql
/// -- ------------------------------------------------------------------------------
/// SELECT *
/// FROM users
/// -- ------------------------------------------------------------------------------
/// ```
pub fn debug(self) -> Self {
let fmts = fmt::multiline();
println!("{}", fmt::format(self.concat(&fmts), &fmts));
self
}
/// The `from` clause
///
/// # Example
///
/// ```
/// # use sql_query_builder as sql;
/// let select = sql::Select::new()
/// .from("users");
///
/// # let expected = "FROM users";
/// # assert_eq!(select.as_string(), expected);
/// ```
pub fn from(mut self, tables: &str) -> Self {
push_unique(&mut self._from, tables.trim().to_string());
self
}
/// The `group by` clause
///
/// # Example
///
/// ```
/// # use sql_query_builder as sql;
/// let select = sql::Select::new()
/// .group_by("id");
///
/// # let expected = "GROUP BY id";
/// # assert_eq!(select.as_string(), expected);
/// ```
pub fn group_by(mut self, column: &str) -> Self {
push_unique(&mut self._group_by, column.trim().to_string());
self
}
/// The `having` clause
///
/// # Example
///
/// ```
/// # use sql_query_builder as sql;
/// let select_query = sql::Select::new()
/// .group_by("status")
/// .having("status != 'disabled'")
/// .as_string();
///
/// # let expected = "GROUP BY status HAVING status != 'disabled'";
/// # assert_eq!(select_query, expected);
/// ```
///
/// Output
///
/// ```sql
/// GROUP BY status HAVING status != 'disabled'
/// ```
pub fn having(mut self, condition: &str) -> Self {
push_unique(&mut self._having, condition.trim().to_string());
self
}
/// The `cross join` clause
///
/// # Example
///
/// ```
/// # use sql_query_builder as sql;
/// let select_query = sql::Select::new()
/// .from("users")
/// .cross_join("addresses")
/// .as_string();
///
/// # let expected = "FROM users CROSS JOIN addresses";
/// # assert_eq!(select_query, expected);
/// ```
///
/// Output
///
/// ```sql
/// FROM users CROSS JOIN addresses
/// ```
pub fn cross_join(mut self, table: &str) -> Self {
let table = table.trim();
let table = format!("CROSS JOIN {table}");
push_unique(&mut self._join, table);
self
}
/// The `inner join` clause
///
/// # Example
///
/// ```
/// # use sql_query_builder as sql;
/// let select_query = sql::Select::new()
/// .from("users")
/// .inner_join("addresses on addresses.user_login = users.login")
/// .as_string();
///
/// # let expected = "FROM users INNER JOIN addresses on addresses.user_login = users.login";
/// # assert_eq!(select_query, expected);
/// ```
///
/// Output
///
/// ```sql
/// FROM users INNER JOIN addresses on addresses.user_login = users.login
/// ```
pub fn inner_join(mut self, table: &str) -> Self {
let table = table.trim();
let table = format!("INNER JOIN {table}");
push_unique(&mut self._join, table);
self
}
/// The `left join` clause
///
/// # Example
///
/// ```
/// # use sql_query_builder as sql;
/// let select_query = sql::Select::new()
/// .from("users")
/// .left_join("addresses on addresses.user_login = users.login")
/// .as_string();
///
/// # let expected = "FROM users LEFT JOIN addresses on addresses.user_login = users.login";
/// # assert_eq!(select_query, expected);
/// ```
///
/// Output
///
/// ```sql
/// FROM users LEFT JOIN addresses on addresses.user_login = users.login
/// ```
pub fn left_join(mut self, table: &str) -> Self {
let table = table.trim();
let table = format!("LEFT JOIN {table}");
push_unique(&mut self._join, table);
self
}
/// The `right join` clause
///
/// # Example
///
/// ```
/// # use sql_query_builder as sql;
/// let select_query = sql::Select::new()
/// .from("users")
/// .right_join("addresses on addresses.user_login = users.login")
/// .as_string();
///
/// # let expected = "FROM users RIGHT JOIN addresses on addresses.user_login = users.login";
/// # assert_eq!(select_query, expected);
/// ```
///
/// Output
///
/// ```sql
/// FROM users RIGHT JOIN addresses on addresses.user_login = users.login
/// ```
pub fn right_join(mut self, table: &str) -> Self {
let table = table.trim();
let table = format!("RIGHT JOIN {table}");
push_unique(&mut self._join, table);
self
}
/// Creates instance of the Select command
pub fn new() -> Self {
Self::default()
}
/// The `order by` clause
///
/// # Example
///
/// ```
/// # use sql_query_builder as sql;
/// let select = sql::Select::new()
/// .select("name, login")
/// .order_by("login asc");
///
/// # let expected = "SELECT name, login ORDER BY login asc";
/// # assert_eq!(select.as_string(), expected);
/// ```
pub fn order_by(mut self, column: &str) -> Self {
push_unique(&mut self._order_by, column.trim().to_string());
self
}
/// Prints the current state of the [Select] to the standard output similar to debug method,
/// the difference is that this method prints in one line.
pub fn print(self) -> Self {
let fmts = fmt::one_line();
println!("{}", fmt::format(self.concat(&fmts), &fmts));
self
}
/// Adds at the beginning a raw SQL query.
///
/// # Example
///
/// ```
/// # use sql_query_builder as sql;
/// let raw_query = "select * from users";
///
/// let select_query = sql::Select::new()
/// .raw(raw_query)
/// .where_clause("users.login = 'foo'")
/// .as_string();
///
/// # let expected = "select * from users WHERE users.login = 'foo'";
/// # assert_eq!(select_query, expected);
/// ```
///
/// Output
///
/// ```sql
/// select * from users WHERE users.login = 'foo'
/// ```
pub fn raw(mut self, raw_sql: &str) -> Self {
push_unique(&mut self._raw, raw_sql.trim().to_string());
self
}
/// Adds a raw SQL query after a specified clause.
///
/// # Example
///
/// ```
/// # use sql_query_builder as sql;
/// let raw_join = "inner join addresses addr on u.login = addr.owner_login";
///
/// let select_query = sql::Select::new()
/// .from("users u")
/// .raw_after(sql::SelectClause::From, raw_join)
/// .where_clause("u.login = foo")
/// .as_string();
///
/// # let expected = "\
/// # FROM users u \
/// # inner join addresses addr on u.login = addr.owner_login \
/// # WHERE u.login = foo\
/// # ";
/// # assert_eq!(select_query, expected);
/// ```
///
/// Output
///
/// ```sql
/// FROM users u
/// inner join addresses addr on u.login = addr.owner_login
/// WHERE u.login = foo
/// ```
pub fn raw_after(mut self, clause: SelectClause, raw_sql: &str) -> Self {
self._raw_after.push((clause, raw_sql.trim().to_string()));
self
}
/// Adds a raw SQL query before a specified clause.
///
/// # Example
///
/// ```
/// # use sql_query_builder as sql;
/// let raw_query = "from users";
///
/// let select_query = sql::Select::new()
/// .raw_before(sql::SelectClause::Where, raw_query)
/// .where_clause("users.login = 'foo'")
/// .as_string();
///
/// # let expected = "\
/// # from users \
/// # WHERE users.login = 'foo'\
/// # ";
/// # assert_eq!(select_query, expected);
/// ```
///
/// Output
///
/// ```sql
/// from users
/// WHERE users.login = 'foo'
/// ```
pub fn raw_before(mut self, clause: SelectClause, raw_sql: &str) -> Self {
self._raw_before.push((clause, raw_sql.trim().to_string()));
self
}
/// The `select` clause
///
/// # Example
///
/// ```
/// # use sql_query_builder as sql;
/// let select = sql::Select::new()
/// .select("count(id)");
///
/// # let expected = "SELECT count(id)";
/// # assert_eq!(select.as_string(), expected);
/// ```
pub fn select(mut self, column: &str) -> Self {
push_unique(&mut self._select, column.trim().to_string());
self
}
/// This method is un alias of `where_clause`. The `where_and` will concatenate mulltiples calls using the `and` operator.
/// The intention is to enable more idiomatic concatenation of conditions.
///
/// # Example
///
/// ```
/// # use sql_query_builder as sql;
/// let select_query = sql::Select::new()
/// .from("carts")
/// .where_clause("login = $1")
/// .where_and("session_id = $2")
/// .where_and("created_at >= current_date")
/// .as_string();
///
/// # let expected = "FROM carts WHERE login = $1 AND session_id = $2 AND created_at >= current_date";
/// # assert_eq!(select_query, expected);
/// ```
///
/// Outputs
///
/// ```sql
/// FROM carts
/// WHERE
/// login = $1
/// AND session_id = $2
/// AND created_at >= current_date
/// ```
pub fn where_and(self, condition: &str) -> Self {
self.where_clause(condition)
}
/// The `where` clause, this method will concatenate mulltiples calls using the `and` operator.
/// If you intended to use the `or` operator you should use the [where_or](Select::where_or) method
///
/// # Example
///
/// ```
/// # use sql_query_builder as sql;
/// let select_query = sql::Select::new()
/// .where_clause("login = $1")
/// .where_clause("status = 'active'")
/// .as_string();
///
/// # let expected = "WHERE login = $1 AND status = 'active'";
/// # assert_eq!(select_query, expected);
/// ```
///
/// Outputs
///
/// ```sql
/// WHERE
/// login = $1
/// AND status = 'active'
/// ```
pub fn where_clause(mut self, condition: &str) -> Self {
push_unique(&mut self._where, (LogicalOperator::And, condition.trim().to_string()));
self
}
/// The `where` clause that concatenate multiples calls using the OR operator.
/// If you intended to use the `and` operator you should use the [where_clause](Select::where_clause) method
///
/// # Example
///
/// ```
/// # use sql_query_builder as sql;
/// let select_query = sql::Select::new()
/// .where_clause("login = 'foo'")
/// .where_or("login = 'bar'")
/// .as_string();
///
/// # let expected = "WHERE login = 'foo' OR login = 'bar'";
/// # assert_eq!(select_query, expected);
/// ```
///
/// Output
///
/// ```sql
/// WHERE
/// login = 'foo'
/// OR login = 'bar'
/// ```
///
/// # Example
///
/// ```
/// # use sql_query_builder as sql;
/// let select_query = sql::Select::new()
/// .where_clause("login = 'foo'")
/// .where_or("login = 'bar'")
/// .where_clause("login = 'joe'")
/// .as_string();
///
/// # let expected = "\
/// # WHERE \
/// # login = 'foo' \
/// # OR login = 'bar' \
/// # AND login = 'joe'\
/// # ";
/// # assert_eq!(select_query, expected);
/// ```
/// Output
///
/// ```sql
/// WHERE
/// login = 'foo'
/// OR login = 'bar'
/// AND login = 'joe'
/// ```
///
/// # Example
///
/// If the `where_or` was the first clause then the operator will be ignored
///
/// ```
/// # use sql_query_builder as sql;
/// let select_query = sql::Select::new()
/// .where_or("login = 'joe'")
/// .where_clause("login = 'foo'")
/// .as_string();
///
/// # let expected = "WHERE login = 'joe' AND login = 'foo'";
/// # assert_eq!(select_query, expected);
/// ```
///
/// Output
///
/// ```sql
/// WHERE
/// login = 'joe'
/// AND login = 'foo'
/// ```
pub fn where_or(mut self, condition: &str) -> Self {
push_unique(&mut self._where, (LogicalOperator::Or, condition.trim().to_string()));
self
}
/// The `window` clause
///
/// # Example
///
/// ```
/// # use sql_query_builder as sql;
/// let select_query = sql::Select::new()
/// .window("win as (partition by department)")
/// .as_string();
///
/// # let expected = "WINDOW win as (partition by department)";
/// # assert_eq!(select_query, expected);
/// ```
///
/// Output
///
/// ```sql
/// WINDOW win as (partition by department)
/// ```
pub fn window(mut self, name: &str) -> Self {
push_unique(&mut self._window, name.trim().to_string());
self
}
}
#[cfg(any(doc, feature = "postgresql", feature = "sqlite"))]
#[cfg_attr(docsrs, doc(cfg(feature = "postgresql")))]
#[cfg_attr(docsrs, doc(cfg(feature = "sqlite")))]
impl Select {
/// The `except` clause
///
/// # Example
///
/// ```
/// # #[cfg(any(feature = "postgresql", feature = "sqlite"))]
/// # {
/// # use sql_query_builder as sql;
/// let select_users = sql::Select::new()
/// .select("login")
/// .from("users");
///
/// let select_inactives = sql::Select::new()
/// .select("login")
/// .from("users")
/// .where_clause("status = 'inactive'");
///
/// let select_query = select_users.except(select_inactives).as_string();
///
/// # let expected = "\
/// # (SELECT login FROM users) \
/// # EXCEPT \
/// # (SELECT login FROM users WHERE status = 'inactive')\
/// # ";
/// # assert_eq!(select_query, expected);
/// # }
/// ```
///
/// Output
///
/// ```sql
/// (SELECT login FROM users)
/// EXCEPT
/// (SELECT login FROM users WHERE status = 'inactive')
/// ```
pub fn except(mut self, select: Self) -> Self {
self._except.push(select);
self
}
/// The `intersect` clause
///
/// # Example
///
/// ```
/// # #[cfg(any(feature = "postgresql", feature = "sqlite"))]
/// # {
/// # use sql_query_builder as sql;
/// let select_users = sql::Select::new()
/// .select("login")
/// .from("users");
///
/// let select_inactives = sql::Select::new()
/// .select("login")
/// .from("users")
/// .where_clause("status = 'inactive'");
///
/// let select_query = select_users.intersect(select_inactives).as_string();
///
/// # let expected = "\
/// # (SELECT login FROM users) \
/// # INTERSECT \
/// # (SELECT login FROM users WHERE status = 'inactive')\
/// # ";
/// # assert_eq!(select_query, expected);
/// # }
/// ```
///
/// Output
///
/// ```sql
/// (SELECT login FROM users)
/// INTERSECT
/// (SELECT login FROM users WHERE status = 'inactive')
/// ```
pub fn intersect(mut self, select: Self) -> Self {
self._intersect.push(select);
self
}
/// The `limit` clause, this method overrides the previous value
///
/// # Example
///
/// ```
/// # #[cfg(any(feature = "postgresql", feature = "sqlite"))]
/// # {
/// # use sql_query_builder as sql;
/// let select = sql::Select::new()
/// .limit("123");
///
/// let select = sql::Select::new()
/// .limit("1000")
/// .limit("123");
///
/// # let expected = "LIMIT 123";
/// # assert_eq!(select.as_string(), expected);
/// # }
/// ```
pub fn limit(mut self, num: &str) -> Self {
self._limit = num.trim().to_string();
self
}
/// The `offset` clause, this method overrides the previous value
///
/// # Example
///
/// ```
/// # #[cfg(any(feature = "postgresql", feature = "sqlite"))]
/// # {
/// # use sql_query_builder as sql;
/// let select = sql::Select::new()
/// .offset("1500");
///
/// let select = sql::Select::new()
/// .offset("1000")
/// .offset("1500");
///
/// # let expected = "OFFSET 1500";
/// # assert_eq!(select.as_string(), expected);
/// # }
/// ```
pub fn offset(mut self, num: &str) -> Self {
self._offset = num.trim().to_string();
self
}
/// The `union` clause
///
/// # Example
///
/// ```
/// # #[cfg(any(feature = "postgresql", feature = "sqlite"))]
/// # {
/// # use sql_query_builder as sql;
/// let select_users = sql::Select::new()
/// .select("login")
/// .from("users");
///
/// let select_inactives = sql::Select::new()
/// .select("login")
/// .from("users")
/// .where_clause("status = 'inactive'");
///
/// let select_query = select_users.union(select_inactives).as_string();
///
/// # let expected = "\
/// # (SELECT login FROM users) \
/// # UNION \
/// # (SELECT login FROM users WHERE status = 'inactive')\
/// # ";
/// # assert_eq!(select_query, expected);
/// # }
/// ```
///
/// Output
///
/// ```sql
/// (SELECT login FROM users)
/// UNION
/// (SELECT login FROM users WHERE status = 'inactive')
/// ```
pub fn union(mut self, select: Self) -> Self {
self._union.push(select);
self
}
/// The `with` clause
///
/// # Example
///
/// ```
/// # #[cfg(any(feature = "postgresql", feature = "sqlite"))]
/// # {
/// # use sql_query_builder as sql;
/// let logins = sql::Select::new()
/// .select("login")
/// .from("users")
/// .where_clause("id in ($1)");
///
/// let select = sql::Select::new()
/// .with("logins", logins)
/// .select("name, price")
/// .from("orders")
/// .where_clause("owner_login in (select * from logins)")
/// .debug();
///
/// # let expected = "\
/// # WITH logins AS (\
/// # SELECT login \
/// # FROM users \
/// # WHERE id in ($1)\
/// # ) \
/// # SELECT name, price \
/// # FROM orders \
/// # WHERE owner_login in (select * from logins)\
/// # ";
/// # assert_eq!(select.as_string(), expected);
/// # }
/// ```
///
/// Prints to the standard output
///
/// ```sql
/// -- ------------------------------------------------------------------------------
/// WITH
/// logins AS (
/// SELECT login
/// FROM users
/// WHERE id in ($1)
/// )
/// SELECT name, price
/// FROM orders
/// WHERE owner_login in (select * from logins)
/// -- ------------------------------------------------------------------------------
/// ```
pub fn with(mut self, name: &str, query: impl WithQuery + 'static) -> Self {
self._with.push((name.trim().to_string(), std::sync::Arc::new(query)));
self
}
}
impl std::fmt::Display for Select {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
write!(f, "{}", self.as_string())
}
}
impl std::fmt::Debug for Select {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
let fmts = fmt::multiline();
write!(f, "{}", fmt::format(self.concat(&fmts), &fmts))
}
}