sql_query_builder 2.6.2

Write SQL queries in a simple and composable way
Documentation
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
mod full_api {
  use pretty_assertions::assert_eq;
  use sql_query_builder as sql;

  #[test]
  fn sql_standard_with_all_methods() {
    let query = sql::Select::new()
      // required
      .select("login, name, status")
      // optional
      .from("users")
      .group_by("login")
      .having("status != 'disabled'")
      .cross_join("addresses")
      .inner_join("addresses on addresses.user_login = users.login")
      .left_join("addresses on addresses.user_login = users.login")
      .right_join("addresses on addresses.user_login = users.login")
      .order_by("login asc")
      .where_clause("login = $1")
      .where_and("login in ($2)")
      .where_or("login in ($3)")
      .window("win as (partition by department)")
      .as_string();

    let expected_query = "\
      SELECT login, name, status \
      FROM users \
      CROSS JOIN addresses \
      INNER JOIN addresses on addresses.user_login = users.login \
      LEFT JOIN addresses on addresses.user_login = users.login \
      RIGHT JOIN addresses on addresses.user_login = users.login \
      WHERE login = $1 \
      AND login in ($2) \
      OR login in ($3) \
      GROUP BY login \
      HAVING status != 'disabled' \
      WINDOW win as (partition by department) \
      ORDER BY login asc\
    ";

    assert_eq!(expected_query, query);
  }

  #[cfg(feature = "postgresql")]
  #[test]
  fn postgres_with_all_methods() {
    let query = sql::Select::new()
      // required
      .select("login, name, status")
      // optional
      .from("users")
      .group_by("login")
      .having("status != 'disabled'")
      .cross_join("addresses")
      .inner_join("addresses on addresses.user_login = users.login")
      .left_join("addresses on addresses.user_login = users.login")
      .right_join("addresses on addresses.user_login = users.login")
      .order_by("login asc")
      .where_clause("login = $1")
      .where_and("login in ($2)")
      .where_or("login in ($3)")
      .window("win as (partition by department)")
      .limit("1")
      .offset("10")
      .except(sql::Select::new().select("login, name, status"))
      .intersect(sql::Select::new().select("login, name, status"))
      .union(sql::Select::new().select("login, name, status"))
      .with("foo", sql::Select::new().select("login, name, status"))
      .as_string();

    let expected_query = "\
      (((\
      WITH foo AS (SELECT login, name, status) \
      SELECT login, name, status \
      FROM users \
      CROSS JOIN addresses \
      INNER JOIN addresses on addresses.user_login = users.login \
      LEFT JOIN addresses on addresses.user_login = users.login \
      RIGHT JOIN addresses on addresses.user_login = users.login \
      WHERE login = $1 \
      AND login in ($2) \
      OR login in ($3) \
      GROUP BY login \
      HAVING status != 'disabled' \
      WINDOW win as (partition by department) \
      ORDER BY login asc \
      LIMIT 1 \
      OFFSET 10\
      ) \
      EXCEPT \
      (SELECT login, name, status)\
      ) \
      INTERSECT \
      (SELECT login, name, status)\
      ) \
      UNION \
      (SELECT login, name, status)\
    ";

    assert_eq!(expected_query, query);
  }

  #[cfg(feature = "sqlite")]
  #[test]
  fn sqlite_with_all_methods() {
    let query = sql::Select::new()
      // required
      .select("login, name, status")
      // optional
      .from("users")
      .group_by("login")
      .having("status != 'disabled'")
      .cross_join("addresses")
      .inner_join("addresses on addresses.user_login = users.login")
      .left_join("addresses on addresses.user_login = users.login")
      .right_join("addresses on addresses.user_login = users.login")
      .order_by("login asc")
      .where_clause("login = $1")
      .where_and("login in ($2)")
      .where_or("login in ($3)")
      .window("win as (partition by department)")
      .limit("1")
      .offset("10")
      .except(sql::Select::new().select("login, name, status"))
      .intersect(sql::Select::new().select("login, name, status"))
      .union(sql::Select::new().select("login, name, status"))
      .with("foo", sql::Select::new().select("login, name, status"))
      .as_string();

    let expected_query = "\
      (((\
      WITH foo AS (SELECT login, name, status) \
      SELECT login, name, status \
      FROM users \
      CROSS JOIN addresses \
      INNER JOIN addresses on addresses.user_login = users.login \
      LEFT JOIN addresses on addresses.user_login = users.login \
      RIGHT JOIN addresses on addresses.user_login = users.login \
      WHERE login = $1 \
      AND login in ($2) \
      OR login in ($3) \
      GROUP BY login \
      HAVING status != 'disabled' \
      WINDOW win as (partition by department) \
      ORDER BY login asc \
      LIMIT 1 \
      OFFSET 10\
      ) \
      EXCEPT \
      (SELECT login, name, status)\
      ) \
      INTERSECT \
      (SELECT login, name, status)\
      ) \
      UNION \
      (SELECT login, name, status)\
    ";

    assert_eq!(expected_query, query);
  }

  #[cfg(feature = "mysql")]
  #[test]
  fn mysql_with_all_methods() {
    let query = sql::Select::new()
      // required
      .select("login, name, status")
      // optional
      .from("users")
      .group_by("login")
      .having("status != 'disabled'")
      .cross_join("addresses")
      .inner_join("addresses on addresses.user_login = users.login")
      .left_join("addresses on addresses.user_login = users.login")
      .right_join("addresses on addresses.user_login = users.login")
      .partition("p1")
      .order_by("login asc")
      .where_clause("login = $1")
      .where_and("login in ($2)")
      .where_or("login in ($3)")
      .window("win as (partition by department)")
      .limit("1")
      .offset("10")
      .except(sql::Select::new().select("login, name, status"))
      .intersect(sql::Select::new().select("login, name, status"))
      .union(sql::Select::new().select("login, name, status"))
      .with("foo", sql::Select::new().select("login, name, status"))
      .as_string();

    let expected_query = "\
      (((\
      WITH foo AS (SELECT login, name, status) \
      SELECT login, name, status \
      FROM users \
      CROSS JOIN addresses \
      INNER JOIN addresses on addresses.user_login = users.login \
      LEFT JOIN addresses on addresses.user_login = users.login \
      RIGHT JOIN addresses on addresses.user_login = users.login \
      PARTITION (p1) \
      WHERE login = $1 \
      AND login in ($2) \
      OR login in ($3) \
      GROUP BY login \
      HAVING status != 'disabled' \
      WINDOW win as (partition by department) \
      ORDER BY login asc \
      LIMIT 1 \
      OFFSET 10\
      ) \
      EXCEPT \
      (SELECT login, name, status)\
      ) \
      INTERSECT \
      (SELECT login, name, status)\
      ) \
      UNION \
      (SELECT login, name, status)\
    ";

    assert_eq!(expected_query, query);
  }
}
mod builder_features {
  use pretty_assertions::assert_eq;
  use sql_query_builder as sql;

  #[test]
  fn select_builder_should_be_displayable() {
    let select = sql::Select::new().select("id, login").from("users");

    println!("{}", select);

    let query = select.as_string();
    let expected_query = "SELECT id, login FROM users";

    assert_eq!(query, expected_query);
  }

  #[test]
  fn select_builder_should_be_debuggable() {
    let select = sql::Select::new().select("*").from("orders").where_clause("id = $1");

    println!("{:?}", select);

    let expected_query = "SELECT * FROM orders WHERE id = $1";
    let query = select.as_string();

    assert_eq!(query, expected_query);
  }

  #[test]
  fn select_builder_should_be_cloneable() {
    let select_zipcode = sql::Select::new()
      .raw("/* test raw */")
      .select("zipcode")
      .from("addresses")
      .raw_before(sql::SelectClause::Where, "/* test raw_before */")
      .where_clause("login = $1")
      .raw_after(sql::SelectClause::Where, "/* test raw_after */");

    let select_city = select_zipcode.clone().select("city");

    let query_zipcode = select_zipcode.as_string();
    let query_city = select_city.as_string();

    let expected_query_zipcode = "\
      /* test raw */ \
      SELECT zipcode \
      FROM addresses \
      /* test raw_before */ \
      WHERE login = $1 \
      /* test raw_after */\
    ";
    let expected_query_city = "\
      /* test raw */ \
      SELECT zipcode, city \
      FROM addresses \
      /* test raw_before */ \
      WHERE login = $1 \
      /* test raw_after */\
    ";

    assert_eq!(query_zipcode, expected_query_zipcode);
    assert_eq!(query_city, expected_query_city);
  }

  #[test]
  fn select_builder_should_be_able_to_conditionally_add_clauses() {
    let mut select = sql::Select::new().select("zipcode").from("addresses");

    if true {
      select = select.where_clause("login = $1");
    }

    let query = select.as_string();
    let expected_query = "SELECT zipcode FROM addresses WHERE login = $1";

    assert_eq!(query, expected_query);
  }

  #[test]
  fn select_builder_should_be_composable() {
    fn project(select: sql::Select) -> sql::Select {
      select
        .select("u.id, u.name as user_name, u.login")
        .select("a.name as addresses_name")
        .select("o.name as product_name")
    }

    fn joins(select: sql::Select) -> sql::Select {
      select
        .from("users u")
        .inner_join("addresses a ON a.user_login = u.login")
        .inner_join("orders o ON o.user_login = u.login")
    }

    fn conditions(select: sql::Select) -> sql::Select {
      select.where_clause("u.login = $1").where_clause("o.id = $2")
    }

    fn as_string(select: sql::Select) -> String {
      select.as_string()
    }

    let query = Some(sql::Select::new())
      .map(project)
      .map(joins)
      .map(conditions)
      .map(as_string)
      .unwrap();

    let expected_query = "\
      SELECT u.id, u.name as user_name, u.login, a.name as addresses_name, o.name as product_name \
      FROM users u \
      INNER JOIN addresses a ON a.user_login = u.login \
      INNER JOIN orders o ON o.user_login = u.login \
      WHERE u.login = $1 AND o.id = $2\
    ";

    assert_eq!(query, expected_query);
  }

  #[test]
  fn all_standard_clauses_concatenated_in_order() {
    let query = sql::Select::new()
      .raw("/* all clauses in order */")
      .select("*")
      .from("users")
      .inner_join("orders ON users.login = orders.login")
      .where_clause("user.login = $1")
      .group_by("login")
      .having("active = true")
      .order_by("created_at desc")
      .as_string();

    let expected_query = "\
      /* all clauses in order */ \
      SELECT * \
      FROM users \
      INNER JOIN orders ON users.login = orders.login \
      WHERE user.login = $1 \
      GROUP BY login \
      HAVING active = true \
      ORDER BY created_at desc\
    ";

    assert_eq!(query, expected_query);
  }

  /** This test can fail only at compile time
   * [More context](https://github.com/belchior/sql_query_builder/pull/53)
   */
  #[test]
  fn select_builder_should_impl_send_and_sync() {
    fn assert_impl_sync_send(_builder: impl Sync + Send) {}
    assert_impl_sync_send(sql::Select::new());
  }
}

mod builder_methods {
  use pretty_assertions::assert_eq;
  use sql_query_builder as sql;

  #[test]
  fn method_new_should_initialize_as_empty_string() {
    let query = sql::Select::new().as_string();
    let expected_query = "";

    assert_eq!(query, expected_query);
  }

  #[test]
  fn method_as_string_should_convert_the_current_state_into_string() {
    let query = sql::Select::new().as_string();
    let expected_query = "";

    assert_eq!(query, expected_query);
  }

  #[test]
  fn method_debug_should_print_at_console_in_a_human_readable_format() {
    let query = sql::Select::new()
      .raw("/* all clauses in order */")
      .select("id as user_id")
      .from("user_list")
      .inner_join("orders ON users.login = orders.login")
      .where_clause("user.created_at::date >= $1")
      .where_clause("user.login not in ($2)")
      .group_by("login")
      .having("active = true")
      .order_by("login asc, created_at desc")
      .debug()
      .as_string();

    let expected_query = "\
      /* all clauses in order */ \
      SELECT id as user_id \
      FROM user_list \
      INNER JOIN orders ON users.login = orders.login \
      WHERE user.created_at::date >= $1 \
      AND user.login not in ($2) \
      GROUP BY login \
      HAVING active = true \
      ORDER BY login asc, created_at desc\
    ";

    assert_eq!(query, expected_query);
  }

  #[test]
  fn method_print_should_print_in_one_line_the_current_state_of_builder() {
    let query = sql::Select::new().select("1 + 2").print().as_string();
    let expected_query = "SELECT 1 + 2";

    assert_eq!(query, expected_query);
  }

  #[test]
  fn method_raw_should_add_raw_sql() {
    let query = sql::Select::new().raw("select id from users").as_string();
    let expected_query = "select id from users";

    assert_eq!(query, expected_query);
  }

  #[test]
  fn method_raw_should_accumulate_values_on_consecutive_calls() {
    let query = sql::Select::new().raw("select id").raw("from users").as_string();
    let expected_query = "select id from users";

    assert_eq!(query, expected_query);
  }

  #[test]
  fn method_raw_should_not_accumulate_values_when_expression_is_empty() {
    let query = sql::Select::new()
      .raw("")
      .raw("select id")
      .raw("from users")
      .raw("")
      .as_string();
    let expected_query = "select id from users";

    assert_eq!(query, expected_query);
  }

  #[test]
  fn method_raw_should_be_the_first_to_be_concatenated() {
    let query = sql::Select::new().raw("select *").from("users").as_string();
    let expected_query = "select * FROM users";

    assert_eq!(query, expected_query);
  }

  #[test]
  fn method_raw_should_trim_space_of_the_argument() {
    let query = sql::Select::new().raw("  update users  ").as_string();
    let expected_query = "update users";

    assert_eq!(query, expected_query);
  }

  #[test]
  fn method_raw_should_not_accumulate_arguments_with_the_same_content() {
    let query = sql::Select::new()
      .raw("select login, name")
      .raw("select login, name")
      .as_string();
    let expected_query = "select login, name";

    assert_eq!(query, expected_query);
  }

  #[test]
  fn method_raw_after_should_trim_space_of_the_argument() {
    let query = sql::Select::new()
      .raw_after(sql::SelectClause::Select, "  from orders  ")
      .as_string();
    let expected_query = "from orders";

    assert_eq!(query, expected_query);
  }

  #[test]
  fn method_raw_before_should_trim_space_of_the_argument() {
    let query = sql::Select::new()
      .raw_before(sql::SelectClause::Where, "  from addresses  ")
      .as_string();
    let expected_query = "from addresses";

    assert_eq!(query, expected_query);
  }
}

#[cfg(feature = "mysql")]
mod partition_method {
  use pretty_assertions::assert_eq;
  use sql_query_builder as sql;

  #[test]
  fn method_partition_should_define_the_partition_clause() {
    let query = sql::Select::new().partition("p0").as_string();
    let expected_query = "PARTITION (p0)";

    assert_eq!(expected_query, query);
  }

  #[test]
  fn method_partition_should_not_defined_the_clause_without_partition_names() {
    let query = sql::Select::new().partition("").as_string();
    let expected_query = "";

    assert_eq!(expected_query, query);
  }

  #[test]
  fn method_partition_should_accumulate_names_on_consecutive_calls() {
    let query = sql::Select::new().partition("p0").partition("p1").as_string();

    let expected_query = "PARTITION (p0, p1)";

    assert_eq!(expected_query, query);
  }

  #[test]
  fn method_partition_should_not_accumulate_values_when_expression_is_empty() {
    let query = sql::Select::new()
      .partition("")
      .partition("p0")
      .partition("")
      .as_string();

    let expected_query = "PARTITION (p0)";

    assert_eq!(expected_query, query);
  }

  #[test]
  fn method_partition_should_not_accumulate_names_with_the_same_content() {
    let query = sql::Select::new().partition("p0").partition("p0").as_string();
    let expected_query = "PARTITION (p0)";

    assert_eq!(expected_query, query);
  }

  #[test]
  fn method_partition_should_trim_space_of_the_argument() {
    let query = sql::Select::new().partition("  p0  ").as_string();
    let expected_query = "PARTITION (p0)";

    assert_eq!(expected_query, query);
  }

  #[test]
  fn method_partition_should_be_defined_after_from_clause() {
    let query = sql::Select::new().from("employees").partition("p0").as_string();
    let expected_query = "FROM employees PARTITION (p0)";

    assert_eq!(expected_query, query);
  }

  #[test]
  fn method_partition_should_be_defined_after_join_clauses() {
    let query = sql::Select::new()
      .from("employees")
      .inner_join("addresses ON employees.login = addresses.login")
      .partition("p0")
      .as_string();

    let expected_query = "\
      FROM employees \
      INNER JOIN addresses ON employees.login = addresses.login \
      PARTITION (p0)\
    ";

    assert_eq!(expected_query, query);
  }

  #[test]
  fn method_raw_after_should_add_raw_sql_after_partition_parameter() {
    let query = sql::Select::new()
      .partition("name")
      .raw_after(sql::SelectClause::Partition, "/* uncommon parameter */")
      .as_string();

    let expected_query = "PARTITION (name) /* uncommon parameter */";

    assert_eq!(expected_query, query);
  }

  #[test]
  fn method_raw_before_should_add_raw_sql_before_partition_parameter() {
    let query = sql::Select::new()
      .raw_before(sql::SelectClause::Partition, "/* uncommon parameter */")
      .partition("name")
      .as_string();

    let expected_query = "/* uncommon parameter */ PARTITION (name)";

    assert_eq!(expected_query, query);
  }
}