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
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
//! [`SelectBuilder`] — typed `SELECT` query builder.
use super::{
column::{AggExpr, Column, OrderExpr},
expr::Expr,
table::Table,
window::WinExpr,
};
use crate::core::condition::SqlValue;
// ── Join helpers ──────────────────────────────────────────────────────────────
/// JOIN type for [`SelectBuilder`].
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum JoinKind {
/// `INNER JOIN`
Inner,
/// `LEFT JOIN`
Left,
/// `RIGHT JOIN`
Right,
/// `CROSS JOIN` (no ON clause)
Cross,
}
/// A single JOIN clause.
#[derive(Debug, Clone)]
pub struct Join {
pub(crate) kind: JoinKind,
pub(crate) table: String,
/// `None` for CROSS JOIN.
pub(crate) on: Option<Expr>,
}
// ── SelectBuilder ─────────────────────────────────────────────────────────────
/// A composable `SELECT` query.
///
/// Created by [`db::select()`](super::db::select).
///
/// ```rust,ignore
/// let users: Vec<User> = db::select()
/// .from(User::table())
/// .where_(User::ACTIVE.eq(true))
/// .order_by(User::NAME.asc())
/// .limit(25)
/// .fetch_all::<User>(&pool)
/// .await?;
/// ```
/// The FROM source for a [`SelectBuilder`]: a table name, a subquery, or a CTE name.
#[derive(Debug, Clone)]
enum FromSource {
Table(String),
Subquery { sql: String, alias: String },
Cte(String),
}
/// A CTE (Common Table Expression) definition.
#[derive(Debug, Clone)]
pub struct Cte {
pub(crate) name: String,
pub(crate) sql: String,
}
/// A set operation combining two queries.
#[derive(Debug, Clone)]
enum SetOp {
Union(String),
UnionAll(String),
Intersect(String),
Except(String),
}
/// PostgreSQL row-level locking clause.
///
/// Used with [`SelectBuilder::lock`] to control concurrent access.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum Lock {
/// `FOR UPDATE` — block until unlocked, then lock for write
ForUpdate,
/// `FOR NO KEY UPDATE` — weaker than `FOR UPDATE`, allows concurrent key-locking reads
ForNoKeyUpdate,
/// `FOR SHARE` — shared lock, allows concurrent shared locks
ForShare,
/// `FOR KEY SHARE` — weakest, allows concurrent non-key-locking writes
ForKeyShare,
}
impl Lock {
fn to_sql(self) -> &'static str {
match self {
Lock::ForUpdate => "FOR UPDATE",
Lock::ForNoKeyUpdate => "FOR NO KEY UPDATE",
Lock::ForShare => "FOR SHARE",
Lock::ForKeyShare => "FOR KEY SHARE",
}
}
}
/// Conflict-resolution strategy when locking a row.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum LockConflict {
/// `… SKIP LOCKED` — skip rows that can't be locked immediately
SkipLocked,
/// `… NOWAIT` — fail immediately if row is locked
NoWait,
}
#[derive(Debug)]
#[must_use]
pub struct SelectBuilder {
from: Option<FromSource>,
columns: Vec<String>,
joins: Vec<Join>,
wheres: Vec<Expr>,
or_wheres: Vec<Expr>,
group_by: Vec<String>,
havings: Vec<Expr>,
orders: Vec<OrderExpr>,
limit: Option<u64>,
offset: Option<u64>,
distinct: bool,
distinct_on: Vec<String>,
lock: Option<(Lock, Option<LockConflict>)>,
ctes: Vec<Cte>,
set_ops: Vec<SetOp>,
}
impl SelectBuilder {
pub(crate) fn new() -> Self {
Self {
from: None,
columns: Vec::new(),
joins: Vec::new(),
wheres: Vec::new(),
or_wheres: Vec::new(),
group_by: Vec::new(),
havings: Vec::new(),
orders: Vec::new(),
limit: None,
offset: None,
distinct: false,
distinct_on: Vec::new(),
lock: None,
ctes: Vec::new(),
set_ops: Vec::new(),
}
}
// ── Source ────────────────────────────────────────────────────────────────
/// Set the table to select from.
pub fn from<T: Table>(mut self, _table: T) -> Self {
self.from = Some(FromSource::Table(T::table_name().to_owned()));
self
}
/// Set the table by name — used by the Active Record → DSL bridge.
pub fn from_table_name(mut self, name: impl Into<String>) -> Self {
self.from = Some(FromSource::Table(name.into()));
self
}
/// Use a subquery as the FROM source: `SELECT … FROM (subquery) AS alias`.
///
/// ```rust,ignore
/// db::select()
/// .from_subquery(
/// db::select().from(User::table()).where_(User::ACTIVE.eq(true)),
/// "active_users",
/// )
/// .fetch_all::<ActiveUser>(&pool).await?;
/// ```
pub fn from_subquery(mut self, subquery: SelectBuilder, alias: impl Into<String>) -> Self {
let (sql, _params) = subquery.to_sql_pg();
self.from = Some(FromSource::Subquery {
sql,
alias: alias.into(),
});
self
}
/// Select from a named CTE defined via `.with_cte()`.
pub fn from_cte(mut self, name: impl Into<String>) -> Self {
self.from = Some(FromSource::Cte(name.into()));
self
}
/// Add a CTE (`WITH name AS (subquery) …`).
///
/// ```rust,ignore
/// db::select()
/// .with_cte("top_users",
/// db::select().from(User::table()).order_by(User::SCORE.desc()).limit(100)
/// )
/// .from_cte("top_users")
/// .fetch_all::<User>(&pool).await?;
/// ```
pub fn with_cte(mut self, name: impl Into<String>, query: SelectBuilder) -> Self {
let (sql, _params) = query.to_sql_pg();
self.ctes.push(Cte {
name: name.into(),
sql,
});
self
}
// ── Projection ────────────────────────────────────────────────────────────
/// Restrict to specific columns by name (default: `SELECT *`).
pub fn columns(mut self, cols: impl IntoIterator<Item = &'static str>) -> Self {
self.columns
.extend(cols.into_iter().map(|c| format!("\"{c}\"")));
self
}
/// Restrict to specific typed columns. Accepts `Column<T,V>` constants.
pub fn select<T, V>(mut self, cols: impl IntoIterator<Item = Column<T, V>>) -> Self {
self.columns
.extend(cols.into_iter().map(|c| format!("\"{}\"", c.name)));
self
}
/// Add an aggregate expression to the projection (e.g. `SUM(col) AS total`).
pub fn agg_col(mut self, expr: AggExpr) -> Self {
self.columns.push(expr.to_projection_sql());
self
}
/// `SELECT DISTINCT`
pub fn distinct(mut self) -> Self {
self.distinct = true;
self
}
/// Add a window function expression to the SELECT projection.
///
/// See [`WinExpr`] for construction via [`rank()`](super::window::rank),
/// [`row_number()`](super::window::row_number), [`Column::lag()`], etc.
pub fn win_col(mut self, expr: WinExpr) -> Self {
self.columns.push(expr.to_projection_sql());
self
}
/// `SELECT DISTINCT ON (col1, col2, …)` — PostgreSQL only.
///
/// Implies `distinct`. Each call appends to the ON list.
pub fn distinct_on(mut self, cols: impl IntoIterator<Item = impl Into<String>>) -> Self {
self.distinct = true;
self.distinct_on
.extend(cols.into_iter().map(|c| format!("\"{}\"", c.into())));
self
}
/// Apply a PostgreSQL row-level locking clause.
///
/// See [`Lock`] for available strengths.
pub fn lock(mut self, lock: Lock) -> Self {
self.lock = Some((lock, None));
self
}
/// Apply a conflict-resolution strategy for the active lock clause.
///
/// Must be called after [`lock`](SelectBuilder::lock).
pub fn lock_conflict(mut self, conflict: LockConflict) -> Self {
if let Some((lock, _)) = self.lock {
self.lock = Some((lock, Some(conflict)));
}
self
}
// ── Filtering ─────────────────────────────────────────────────────────────
/// Add a `WHERE` predicate (multiple calls are `AND`-ed together).
pub fn where_(mut self, expr: Expr) -> Self {
self.wheres.push(expr);
self
}
/// Add an `OR WHERE` predicate.
pub fn or_where(mut self, expr: Expr) -> Self {
self.or_wheres.push(expr);
self
}
// ── Joins ─────────────────────────────────────────────────────────────────
/// `INNER JOIN table ON expr`
pub fn inner_join<TJ: Table>(mut self, _table: TJ, on: Expr) -> Self {
self.joins.push(Join {
kind: JoinKind::Inner,
table: TJ::table_name().to_owned(),
on: Some(on),
});
self
}
/// `LEFT JOIN table ON expr`
pub fn left_join<TJ: Table>(mut self, _table: TJ, on: Expr) -> Self {
self.joins.push(Join {
kind: JoinKind::Left,
table: TJ::table_name().to_owned(),
on: Some(on),
});
self
}
/// `RIGHT JOIN table ON expr`
pub fn right_join<TJ: Table>(mut self, _table: TJ, on: Expr) -> Self {
self.joins.push(Join {
kind: JoinKind::Right,
table: TJ::table_name().to_owned(),
on: Some(on),
});
self
}
/// `CROSS JOIN table` (no ON clause)
pub fn cross_join<TJ: Table>(mut self, _table: TJ) -> Self {
self.joins.push(Join {
kind: JoinKind::Cross,
table: TJ::table_name().to_owned(),
on: None,
});
self
}
// ── Grouping ──────────────────────────────────────────────────────────────
/// Add `GROUP BY` columns.
pub fn group_by<T, V>(mut self, cols: impl IntoIterator<Item = Column<T, V>>) -> Self {
self.group_by
.extend(cols.into_iter().map(|c| c.qualified()));
self
}
/// Add a `HAVING` predicate (usually an [`AggExpr`] comparison).
pub fn having(mut self, expr: Expr) -> Self {
self.havings.push(expr);
self
}
// ── Sorting ───────────────────────────────────────────────────────────────
/// Add an `ORDER BY` clause.
pub fn order_by(mut self, ord: OrderExpr) -> Self {
self.orders.push(ord);
self
}
// ── Pagination ────────────────────────────────────────────────────────────
/// `LIMIT n`
pub fn limit(mut self, n: u64) -> Self {
self.limit = Some(n);
self
}
/// `OFFSET n`
pub fn offset(mut self, n: u64) -> Self {
self.offset = Some(n);
self
}
// ── Debug helpers ─────────────────────────────────────────────────────────
/// Print the rendered SQL and bound parameters to `stderr` without breaking the chain.
///
/// Useful for quick debugging — insert `.inspect()` anywhere in a builder chain.
/// When the `tracing` feature is enabled, also emits a `tracing::debug!` event.
///
/// ```rust,ignore
/// let rows = db::select()
/// .from(users::table)
/// .where_(users::active.eq(true))
/// .inspect() // ← prints to stderr here
/// .fetch_all::<User>(&pool)
/// .await?;
/// ```
pub fn inspect(self) -> Self {
let (sql, params) = self.to_sql_pg();
eprintln!("[rok-fluent] {sql}");
if !params.is_empty() {
eprintln!("[rok-fluent] params: {params:?}");
}
#[cfg(feature = "tracing")]
tracing::debug!(sql = %sql, ?params, "rok-fluent select");
self
}
// ── SQL rendering ─────────────────────────────────────────────────────────
/// Render to `(sql, params)` using PostgreSQL `$N` placeholders.
pub fn to_sql_pg(&self) -> (String, Vec<SqlValue>) {
self.render('$')
}
/// Render to `(sql, params)` using `?` placeholders (MySQL / SQLite).
pub fn to_sql_qmark(&self) -> (String, Vec<SqlValue>) {
self.render('?')
}
fn build_from_clause(&self) -> String {
match &self.from {
None => "\"unknown\"".to_string(),
Some(FromSource::Table(t)) => format!("\"{t}\""),
Some(FromSource::Subquery { sql, alias }) => format!("({sql}) AS \"{alias}\""),
Some(FromSource::Cte(name)) => format!("\"{name}\""),
}
}
fn cte_prefix(&self) -> String {
if self.ctes.is_empty() {
return String::new();
}
let parts: Vec<String> = self
.ctes
.iter()
.map(|c| format!("\"{}\" AS ({})", c.name, c.sql))
.collect();
format!("WITH {} ", parts.join(", "))
}
fn render(&self, ph: char) -> (String, Vec<SqlValue>) {
let cols = if self.columns.is_empty() {
"*".to_string()
} else {
self.columns.join(", ")
};
let distinct = if self.distinct {
if self.distinct_on.is_empty() {
"DISTINCT ".to_string()
} else {
format!("DISTINCT ON ({}) ", self.distinct_on.join(", "))
}
} else {
String::new()
};
let from = self.build_from_clause();
let cte_pfx = self.cte_prefix();
let mut sql = format!("{cte_pfx}SELECT {distinct}{cols} FROM {from}");
let mut params: Vec<SqlValue> = Vec::new();
// JOINs
for join in &self.joins {
let kind = match join.kind {
JoinKind::Inner => "INNER JOIN",
JoinKind::Left => "LEFT JOIN",
JoinKind::Right => "RIGHT JOIN",
JoinKind::Cross => "CROSS JOIN",
};
sql.push_str(&format!(" {kind} \"{}\"", join.table));
if let Some(on_expr) = &join.on {
let (on_sql, on_params) = if ph == '?' {
on_expr.to_sql_qmark(params.len() + 1)
} else {
on_expr.to_sql_pg(params.len() + 1)
};
sql.push_str(&format!(" ON {on_sql}"));
params.extend(on_params);
}
}
// WHERE
if !self.wheres.is_empty() || !self.or_wheres.is_empty() {
let mut all_frags: Vec<String> = Vec::new();
for expr in &self.wheres {
let (s, p) = if ph == '?' {
expr.to_sql_qmark(params.len() + 1)
} else {
expr.to_sql_pg(params.len() + 1)
};
all_frags.push(s);
params.extend(p);
}
let and_part = all_frags.join(" AND ");
if self.or_wheres.is_empty() {
sql.push_str(&format!(" WHERE {and_part}"));
} else {
let mut or_frags: Vec<String> = Vec::new();
for expr in &self.or_wheres {
let (s, p) = if ph == '?' {
expr.to_sql_qmark(params.len() + 1)
} else {
expr.to_sql_pg(params.len() + 1)
};
or_frags.push(s);
params.extend(p);
}
let or_part = or_frags.join(" OR ");
if and_part.is_empty() {
sql.push_str(&format!(" WHERE {or_part}"));
} else {
sql.push_str(&format!(" WHERE ({and_part}) OR ({or_part})"));
}
}
}
// GROUP BY
if !self.group_by.is_empty() {
sql.push_str(&format!(" GROUP BY {}", self.group_by.join(", ")));
}
// HAVING
if !self.havings.is_empty() {
let mut frags = Vec::new();
for expr in &self.havings {
let (s, p) = if ph == '?' {
expr.to_sql_qmark(params.len() + 1)
} else {
expr.to_sql_pg(params.len() + 1)
};
frags.push(s);
params.extend(p);
}
sql.push_str(&format!(" HAVING {}", frags.join(" AND ")));
}
// ORDER BY
if !self.orders.is_empty() {
let ord: Vec<String> = self.orders.iter().map(|o| o.to_sql()).collect();
sql.push_str(&format!(" ORDER BY {}", ord.join(", ")));
}
if let Some(n) = self.limit {
sql.push_str(&format!(" LIMIT {n}"));
}
if let Some(n) = self.offset {
sql.push_str(&format!(" OFFSET {n}"));
}
// Lock clause
if let Some((lock, conflict)) = self.lock {
sql.push_str(&format!(" {}", lock.to_sql()));
if let Some(c) = conflict {
match c {
LockConflict::SkipLocked => sql.push_str(" SKIP LOCKED"),
LockConflict::NoWait => sql.push_str(" NOWAIT"),
}
}
}
// Set operations
for op in &self.set_ops {
match op {
SetOp::Union(s) => sql.push_str(&format!(" UNION ({s})")),
SetOp::UnionAll(s) => sql.push_str(&format!(" UNION ALL ({s})")),
SetOp::Intersect(s) => sql.push_str(&format!(" INTERSECT ({s})")),
SetOp::Except(s) => sql.push_str(&format!(" EXCEPT ({s})")),
}
}
(sql, params)
}
/// Build a COUNT(*) SQL string from the current WHERE clauses.
fn count_sql(&self, ph: char) -> (String, Vec<SqlValue>) {
let from = self.build_from_clause();
let cte_pfx = self.cte_prefix();
let mut sql = format!("{cte_pfx}SELECT COUNT(*) FROM {from}");
let mut params: Vec<SqlValue> = Vec::new();
for join in &self.joins {
let kind = match join.kind {
JoinKind::Inner => "INNER JOIN",
JoinKind::Left => "LEFT JOIN",
JoinKind::Right => "RIGHT JOIN",
JoinKind::Cross => "CROSS JOIN",
};
sql.push_str(&format!(" {kind} \"{}\"", join.table));
if let Some(on_expr) = &join.on {
let (on_sql, on_params) = if ph == '?' {
on_expr.to_sql_qmark(params.len() + 1)
} else {
on_expr.to_sql_pg(params.len() + 1)
};
sql.push_str(&format!(" ON {on_sql}"));
params.extend(on_params);
}
}
if !self.wheres.is_empty() {
let mut frags = Vec::new();
for expr in &self.wheres {
let (s, p) = if ph == '?' {
expr.to_sql_qmark(params.len() + 1)
} else {
expr.to_sql_pg(params.len() + 1)
};
frags.push(s);
params.extend(p);
}
sql.push_str(&format!(" WHERE {}", frags.join(" AND ")));
}
(sql, params)
}
// ── Set operations ────────────────────────────────────────────────────────
/// `… UNION (other_query)` — duplicate rows removed.
pub fn union(mut self, other: SelectBuilder) -> Self {
let (sql, _) = other.to_sql_pg();
self.set_ops.push(SetOp::Union(sql));
self
}
/// `… UNION ALL (other_query)` — duplicate rows kept.
pub fn union_all(mut self, other: SelectBuilder) -> Self {
let (sql, _) = other.to_sql_pg();
self.set_ops.push(SetOp::UnionAll(sql));
self
}
/// `… INTERSECT (other_query)`
pub fn intersect(mut self, other: SelectBuilder) -> Self {
let (sql, _) = other.to_sql_pg();
self.set_ops.push(SetOp::Intersect(sql));
self
}
/// `… EXCEPT (other_query)`
pub fn except(mut self, other: SelectBuilder) -> Self {
let (sql, _) = other.to_sql_pg();
self.set_ops.push(SetOp::Except(sql));
self
}
}
// ── PostgreSQL async terminals ────────────────────────────────────────────────
#[cfg(feature = "postgres")]
impl SelectBuilder {
/// Execute and return all matching rows.
pub async fn fetch_all<T>(self, pool: &sqlx::PgPool) -> Result<Vec<T>, sqlx::Error>
where
T: for<'r> sqlx::FromRow<'r, sqlx::postgres::PgRow> + Send + Unpin,
{
let (sql, params) = self.to_sql_pg();
crate::core::sqlx::pg::fetch_all_as::<T>(pool, &sql, params).await
}
/// Execute and return the first row, or `None` if no rows match.
pub async fn fetch_optional<T>(self, pool: &sqlx::PgPool) -> Result<Option<T>, sqlx::Error>
where
T: for<'r> sqlx::FromRow<'r, sqlx::postgres::PgRow> + Send + Unpin,
{
let had_limit = self.limit.is_some();
let (mut sql, params) = self.to_sql_pg();
if !had_limit {
sql.push_str(" LIMIT 1");
}
crate::core::sqlx::pg::fetch_optional_as::<T>(pool, &sql, params).await
}
/// Execute and return exactly one row; errors if no rows match.
pub async fn fetch_one<T>(self, pool: &sqlx::PgPool) -> Result<T, sqlx::Error>
where
T: for<'r> sqlx::FromRow<'r, sqlx::postgres::PgRow> + Send + Unpin,
{
self.fetch_optional::<T>(pool)
.await?
.ok_or(sqlx::Error::RowNotFound)
}
/// Return `true` if at least one row matches.
pub async fn exists(self, pool: &sqlx::PgPool) -> Result<bool, sqlx::Error> {
let (inner_sql, params) = self.to_sql_pg();
let sql = format!("SELECT EXISTS ({inner_sql})");
let row = crate::core::sqlx::pg::build_query(&sql, params)
.fetch_one(pool)
.await?;
use sqlx::Row;
row.try_get::<bool, _>(0)
}
/// Return the number of matching rows (`SELECT COUNT(*)`).
pub async fn count(self, pool: &sqlx::PgPool) -> Result<i64, sqlx::Error> {
let (count_sql, params) = self.count_sql('$');
let row = crate::core::sqlx::pg::build_query(&count_sql, params)
.fetch_one(pool)
.await?;
use sqlx::Row;
row.try_get::<i64, _>(0)
}
/// Offset pagination — runs a `COUNT(*)` query and a data query.
///
/// Returns a [`Page<T>`](crate::orm::pagination::Page) with full metadata.
pub async fn paginate<T>(
self,
page: u32,
per_page: u32,
pool: &sqlx::PgPool,
) -> Result<crate::orm::pagination::Page<T>, sqlx::Error>
where
T: for<'r> sqlx::FromRow<'r, sqlx::postgres::PgRow> + Send + Unpin + serde::Serialize,
{
let page = page.max(1);
let per_page = per_page.max(1);
// COUNT query
let (count_sql, count_params) = self.count_sql('$');
let count_row = crate::core::sqlx::pg::build_query(&count_sql, count_params)
.fetch_one(pool)
.await?;
use sqlx::Row;
let total: i64 = count_row.try_get::<i64, _>(0)?;
// Data query
let offset = (page - 1) as u64 * per_page as u64;
let (mut data_sql, data_params) = self.to_sql_pg();
data_sql.push_str(&format!(" LIMIT {per_page} OFFSET {offset}"));
let data = crate::core::sqlx::pg::fetch_all_as::<T>(pool, &data_sql, data_params).await?;
Ok(crate::orm::pagination::Page::new(
data, total, per_page, page,
))
}
/// Simple pagination — no `COUNT(*)` query; detects next page by fetching `per_page + 1`.
pub async fn simple_paginate<T>(
self,
page: u32,
per_page: u32,
pool: &sqlx::PgPool,
) -> Result<crate::orm::pagination::SimplePage<T>, sqlx::Error>
where
T: for<'r> sqlx::FromRow<'r, sqlx::postgres::PgRow> + Send + Unpin + serde::Serialize,
{
let page = page.max(1);
let per_page = per_page.max(1);
let offset = (page - 1) as u64 * per_page as u64;
let (mut sql, params) = self.to_sql_pg();
// Fetch one extra to detect whether a next page exists.
sql.push_str(&format!(" LIMIT {} OFFSET {offset}", per_page + 1));
let data = crate::core::sqlx::pg::fetch_all_as::<T>(pool, &sql, params).await?;
Ok(crate::orm::pagination::SimplePage::new(
data, per_page, page,
))
}
/// Cursor pagination — stable, efficient for infinite scroll.
///
/// `cursor` is the opaque string returned by the previous page's
/// [`CursorPage::next_cursor`](crate::orm::pagination::CursorPage::next_cursor).
/// Pass `None` for the first page.
pub async fn cursor_paginate<T, ST, SV>(
mut self,
cursor_col: Column<ST, SV>,
cursor: Option<&str>,
per_page: u32,
pool: &sqlx::PgPool,
) -> Result<crate::orm::pagination::CursorPage<T>, sqlx::Error>
where
T: for<'r> sqlx::FromRow<'r, sqlx::postgres::PgRow> + Send + Unpin + serde::Serialize,
SV: Into<SqlValue>,
{
use base64::Engine;
use sqlx::Row;
let per_page = per_page.max(1);
let prev_cursor = cursor.map(|c| c.to_owned());
// Decode cursor → append WHERE cursor_col > last_value
if let Some(c) = cursor {
if let Ok(decoded) = base64::engine::general_purpose::STANDARD.decode(c) {
if let Ok(val_str) = std::str::from_utf8(&decoded) {
let sql_val = if let Ok(n) = val_str.parse::<i64>() {
SqlValue::Integer(n)
} else {
SqlValue::Text(val_str.to_owned())
};
self = self.where_(Expr::Gt(cursor_col.qualified(), sql_val));
}
}
}
// Fetch per_page + 1 raw rows so we can extract the cursor value before
// deserializing into T (generic T has no typed cursor field accessor).
let col_name = cursor_col.name();
let (mut sql, params) = self.to_sql_pg();
sql.push_str(&format!(
" ORDER BY {} ASC LIMIT {}",
cursor_col.qualified(),
per_page + 1
));
let raw_rows = crate::core::sqlx::pg::build_query(&sql, params)
.fetch_all(pool)
.await?;
let has_more = raw_rows.len() > per_page as usize;
// Extract the cursor value from the last *kept* row.
let next_cursor = if has_more {
raw_rows.get(per_page as usize - 1).and_then(|row| {
if let Ok(v) = row.try_get::<i64, _>(col_name) {
Some(base64::engine::general_purpose::STANDARD.encode(v.to_string()))
} else if let Ok(v) = row.try_get::<String, _>(col_name) {
Some(base64::engine::general_purpose::STANDARD.encode(&v))
} else {
None
}
})
} else {
None
};
// Deserialize kept rows into T.
let data: Vec<T> = raw_rows
.iter()
.take(per_page as usize)
.map(T::from_row)
.collect::<Result<Vec<T>, _>>()?;
Ok(crate::orm::pagination::CursorPage::new(
data,
per_page,
next_cursor,
prev_cursor,
))
}
/// Run `EXPLAIN` on this query and return the query plan as a formatted string.
///
/// Each line of the plan is joined with newlines. Useful for inspecting index usage.
///
/// ```rust,ignore
/// let plan = db::select()
/// .from(users::table)
/// .where_(users::active.eq(true))
/// .explain(&pool)
/// .await?;
/// println!("{plan}");
/// ```
pub async fn explain(self, pool: &sqlx::PgPool) -> Result<String, sqlx::Error> {
let (inner_sql, params) = self.to_sql_pg();
let sql = format!("EXPLAIN {inner_sql}");
let rows = crate::core::sqlx::pg::build_query(&sql, params)
.fetch_all(pool)
.await?;
use sqlx::Row;
let lines: Vec<String> = rows
.into_iter()
.filter_map(|r| r.try_get::<String, _>(0).ok())
.collect();
Ok(lines.join("\n"))
}
/// Run `EXPLAIN (FORMAT JSON)` and return the structured query plan.
///
/// Returns the root array element from PostgreSQL's JSON plan output.
///
/// ```rust,ignore
/// let plan = db::select()
/// .from(users::table)
/// .explain_json(&pool)
/// .await?;
/// let node_type = &plan[0]["Plan"]["Node Type"];
/// ```
pub async fn explain_json(self, pool: &sqlx::PgPool) -> Result<serde_json::Value, sqlx::Error> {
let (inner_sql, params) = self.to_sql_pg();
let sql = format!("EXPLAIN (FORMAT JSON) {inner_sql}");
let row = crate::core::sqlx::pg::build_query(&sql, params)
.fetch_one(pool)
.await?;
use sqlx::Row;
let plan: serde_json::Value = row.try_get(0)?;
Ok(plan)
}
/// Stream matching rows, yielding each row as it is deserialized.
///
/// Internally runs a single query and yields rows one at a time without
/// accumulating the full result set in a `Vec`. Suitable for large result
/// sets where you want to process rows as they arrive.
///
/// ```rust,ignore
/// use futures::TryStreamExt;
///
/// let mut stream = db::select()
/// .from(User::table())
/// .stream::<User>(&pool);
///
/// while let Some(user) = stream.try_next().await? {
/// process(user);
/// }
/// ```
pub fn stream<'pool, T>(
self,
pool: &'pool sqlx::PgPool,
) -> impl futures::Stream<Item = Result<T, sqlx::Error>> + 'pool
where
T: for<'r> sqlx::FromRow<'r, sqlx::postgres::PgRow> + Send + Unpin + 'pool,
{
use futures::StreamExt;
let (sql, params) = self.to_sql_pg();
// Run the query inside a future that owns the SQL string, then yield
// each row individually. The SQL string lives for the duration of
// the future inside `once`, so no lifetime extension is needed.
futures::stream::once(async move {
crate::core::sqlx::pg::fetch_all_as::<T>(pool, &sql, params).await
})
.flat_map(|result| {
futures::stream::iter(match result {
Ok(rows) => rows.into_iter().map(Ok).collect::<Vec<_>>(),
Err(e) => vec![Err(e)],
})
})
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::core::condition::SqlValue;
use crate::dsl::expr::Expr;
fn make(table: &'static str) -> SelectBuilder {
SelectBuilder {
from: Some(FromSource::Table(table.to_owned())),
columns: vec![],
joins: vec![],
wheres: vec![],
or_wheres: vec![],
group_by: vec![],
havings: vec![],
orders: vec![],
limit: None,
offset: None,
distinct: false,
distinct_on: vec![],
lock: None,
ctes: vec![],
set_ops: vec![],
}
}
#[test]
fn basic_select_all() {
let (sql, params) = make("users").to_sql_pg();
assert_eq!(sql, "SELECT * FROM \"users\"");
assert!(params.is_empty());
}
#[test]
fn select_with_where_and_limit() {
let b = make("posts")
.where_(Expr::Eq(
"\"posts\".\"user_id\"".into(),
SqlValue::Integer(42),
))
.limit(10)
.offset(20);
let (sql, params) = b.to_sql_pg();
assert_eq!(
sql,
"SELECT * FROM \"posts\" WHERE \"posts\".\"user_id\" = $1 LIMIT 10 OFFSET 20"
);
assert_eq!(params.len(), 1);
}
#[test]
fn inner_join_renders() {
let b = make("users").inner_join_raw(
"posts",
Expr::ColEq("\"posts\".\"user_id\"".into(), "\"users\".\"id\"".into()),
);
let (sql, params) = b.to_sql_pg();
assert_eq!(
sql,
"SELECT * FROM \"users\" INNER JOIN \"posts\" ON \"posts\".\"user_id\" = \"users\".\"id\""
);
assert!(params.is_empty());
}
#[test]
fn group_by_having_renders() {
let b = make("orders")
.group_by_raw(vec!["\"orders\".\"user_id\"".to_string()])
.having(Expr::AggCmp(
"COUNT(\"orders\".\"id\")".into(),
">",
SqlValue::Integer(3),
));
let (sql, params) = b.to_sql_pg();
assert_eq!(
sql,
"SELECT * FROM \"orders\" GROUP BY \"orders\".\"user_id\" HAVING COUNT(\"orders\".\"id\") > $1"
);
assert_eq!(params.len(), 1);
}
}
// ── Test helpers (raw string versions for unit tests) ────────────────────────
impl SelectBuilder {
#[cfg(test)]
fn inner_join_raw(mut self, table: &'static str, on: Expr) -> Self {
self.joins.push(Join {
kind: JoinKind::Inner,
table: table.to_owned(),
on: Some(on),
});
self
}
#[cfg(test)]
fn group_by_raw(mut self, cols: Vec<String>) -> Self {
self.group_by.extend(cols);
self
}
}