rqb 0.1.3

sqlx-first typed Postgres query builder.
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
use sqlx::postgres::PgHasArrayType;

use crate::{BindValue, Param};

use super::{BoolExpr, Field, FieldRef, ValueExpr};

impl<T> Field<Vec<T>> {
    /// Builds an array overlap predicate (`&&`) from a SQL array expression.
    ///
    /// Use the `_expr` variants when the right-hand array is built in SQL.
    /// Bind-value variants require sqlx [`PgHasArrayType`].
    pub fn overlaps_expr(self, values: impl Into<ValueExpr>) -> BoolExpr {
        self.reference().overlaps_expr(values)
    }

    /// Builds an array contains-all predicate (`@>`) from a SQL array expression.
    pub fn contains_expr(self, values: impl Into<ValueExpr>) -> BoolExpr {
        self.reference().contains_expr(values)
    }

    /// Builds an array contained-by predicate (`<@`) from a SQL array expression.
    pub fn contained_by_expr(self, values: impl Into<ValueExpr>) -> BoolExpr {
        self.reference().contained_by_expr(values)
    }

    /// Builds `value = ANY(array)` from a SQL value expression.
    pub fn has_expr(self, value: impl Into<ValueExpr>) -> BoolExpr {
        self.reference().has_expr(value)
    }

    /// Builds the negated `ANY` membership predicate from a SQL value expression.
    pub fn not_has_expr(self, value: impl Into<ValueExpr>) -> BoolExpr {
        self.reference().not_has_expr(value)
    }
}

impl<T> Field<Vec<T>>
where
    T: BindValue + PgHasArrayType,
{
    /// Builds an array overlap predicate (`&&`) from a Rust bind value.
    ///
    /// This requires sqlx array encoding support for `T`. Use
    /// [`Field::overlaps_expr`] for server-owned array expressions.
    pub fn overlaps(self, values: Vec<T>) -> BoolExpr {
        self.reference().overlaps(values)
    }

    /// Builds an array contains-all predicate (`@>`).
    pub fn contains(self, values: Vec<T>) -> BoolExpr {
        self.reference().contains(values)
    }

    /// Builds an array contained-by predicate (`<@`).
    pub fn contained_by(self, values: Vec<T>) -> BoolExpr {
        self.reference().contained_by(values)
    }

    /// Builds `value = ANY(array)`.
    pub fn has(self, value: T) -> BoolExpr {
        self.reference().has(value)
    }

    /// Builds the negated `ANY` membership predicate.
    pub fn not_has(self, value: T) -> BoolExpr {
        self.reference().not_has(value)
    }

    /// Builds an empty-array predicate.
    pub fn is_empty(self) -> BoolExpr {
        self.reference().is_empty()
    }

    /// Builds a non-empty-array predicate.
    pub fn is_not_empty(self) -> BoolExpr {
        self.reference().is_not_empty()
    }

    /// Builds an array subscript expression.
    pub fn element(self, index: i32) -> ValueExpr {
        self.reference().element(index)
    }

    /// Builds an array slice expression.
    pub fn slice(self, start: Option<i32>, end: Option<i32>) -> ValueExpr {
        self.reference().slice(start, end)
    }
}

impl<T> FieldRef<Vec<T>> {
    /// Builds an array overlap predicate (`&&`) from a SQL array expression.
    pub fn overlaps_expr(self, values: impl Into<ValueExpr>) -> BoolExpr {
        self.array_expr_infix("&&", values, false)
    }

    /// Builds an array contains-all predicate (`@>`) from a SQL array expression.
    pub fn contains_expr(self, values: impl Into<ValueExpr>) -> BoolExpr {
        self.array_expr_infix("@>", values, false)
    }

    /// Builds an array contained-by predicate (`<@`) from a SQL array expression.
    pub fn contained_by_expr(self, values: impl Into<ValueExpr>) -> BoolExpr {
        self.array_expr_infix("<@", values, false)
    }

    /// Builds `value = ANY(array)` from a SQL value expression.
    pub fn has_expr(self, value: impl Into<ValueExpr>) -> BoolExpr {
        self.any_expr_predicate(value, false)
    }

    /// Builds the negated `ANY` membership predicate from a SQL value expression.
    pub fn not_has_expr(self, value: impl Into<ValueExpr>) -> BoolExpr {
        self.any_expr_predicate(value, true)
    }

    fn array_expr_infix(
        self,
        op: &'static str,
        values: impl Into<ValueExpr>,
        negated: bool,
    ) -> BoolExpr {
        BoolExpr::infix(self.expr(), op, values.into(), negated)
    }

    fn any_expr_predicate(self, value: impl Into<ValueExpr>, negated: bool) -> BoolExpr {
        BoolExpr::any(value.into(), self.expr(), negated)
    }
}

impl<T> FieldRef<Vec<T>>
where
    T: BindValue + PgHasArrayType,
{
    /// Builds an array overlap predicate (`&&`).
    pub fn overlaps(self, values: Vec<T>) -> BoolExpr {
        self.array_infix("&&", values, false)
    }

    /// Builds an array contains-all predicate (`@>`).
    pub fn contains(self, values: Vec<T>) -> BoolExpr {
        self.array_infix("@>", values, false)
    }

    /// Builds an array contained-by predicate (`<@`).
    pub fn contained_by(self, values: Vec<T>) -> BoolExpr {
        self.array_infix("<@", values, false)
    }

    /// Builds `value = ANY(array)`.
    pub fn has(self, value: T) -> BoolExpr {
        self.any_predicate(value, false)
    }

    /// Builds the negated `ANY` membership predicate.
    pub fn not_has(self, value: T) -> BoolExpr {
        self.any_predicate(value, true)
    }

    /// Builds an empty-array predicate.
    pub fn is_empty(self) -> BoolExpr {
        BoolExpr::array_is_empty(self.expr(), false)
    }

    /// Builds a non-empty-array predicate.
    pub fn is_not_empty(self) -> BoolExpr {
        BoolExpr::array_is_empty(self.expr(), true)
    }

    /// Builds an array subscript expression.
    pub fn element(self, index: i32) -> ValueExpr {
        ValueExpr::subscript(self.expr(), ValueExpr::Param(Param::typed(index)))
    }

    /// Builds an array slice expression.
    pub fn slice(self, start: Option<i32>, end: Option<i32>) -> ValueExpr {
        ValueExpr::slice(
            self.expr(),
            start.map(|value| ValueExpr::Param(Param::typed(value))),
            end.map(|value| ValueExpr::Param(Param::typed(value))),
        )
    }

    fn array_infix(self, op: &'static str, values: Vec<T>, negated: bool) -> BoolExpr {
        BoolExpr::infix(
            self.expr(),
            op,
            ValueExpr::Param(Param::typed(values)),
            negated,
        )
    }

    fn any_predicate(self, value: T, negated: bool) -> BoolExpr {
        BoolExpr::any(ValueExpr::Param(Param::typed(value)), self.expr(), negated)
    }
}

impl Field<serde_json::Value> {
    /// Builds a JSONB containment predicate (`@>`).
    #[inline]
    pub fn contains(self, value: serde_json::Value) -> BoolExpr {
        self.reference().contains(value)
    }

    /// Builds a JSONB contained-by predicate (`<@`).
    #[inline]
    pub fn contained_by(self, value: serde_json::Value) -> BoolExpr {
        self.reference().contained_by(value)
    }

    /// Builds a JSONB key-exists predicate (`?`).
    pub fn has_key(self, key: impl Into<String>) -> BoolExpr {
        self.reference().has_key(key)
    }

    /// Builds a JSONB any-key-exists predicate (`?|`).
    #[inline]
    pub fn has_any_keys(self, keys: Vec<String>) -> BoolExpr {
        self.reference().has_any_keys(keys)
    }

    /// Builds a JSONB all-keys-exist predicate (`?&`).
    #[inline]
    pub fn has_all_keys(self, keys: Vec<String>) -> BoolExpr {
        self.reference().has_all_keys(keys)
    }

    /// Builds a JSON value access expression (`->`).
    pub fn get(self, key: impl Into<String>) -> ValueExpr {
        self.reference().get(key)
    }

    /// Builds a JSON text access expression (`->>`).
    pub fn get_text(self, key: impl Into<String>) -> ValueExpr {
        self.reference().get_text(key)
    }

    /// Builds a JSON path access expression (`#>`).
    #[inline]
    pub fn path(self, path: Vec<String>) -> ValueExpr {
        self.reference().path(path)
    }

    /// Builds a JSON path text access expression (`#>>`).
    #[inline]
    pub fn path_text(self, path: Vec<String>) -> ValueExpr {
        self.reference().path_text(path)
    }
}

impl<T> Field<sqlx::postgres::types::PgRange<T>>
where
    T: BindValue,
    sqlx::postgres::types::PgRange<T>: BindValue,
{
    /// Builds a range contains element predicate (`@>`).
    pub fn range_contains(self, value: T) -> BoolExpr {
        self.reference().range_contains(value)
    }

    /// Builds a range contains range predicate (`@>`).
    pub fn contains_range(self, value: sqlx::postgres::types::PgRange<T>) -> BoolExpr {
        self.reference().contains_range(value)
    }

    /// Builds a range contained-by predicate (`<@`).
    pub fn contained_by(self, value: sqlx::postgres::types::PgRange<T>) -> BoolExpr {
        self.reference().contained_by(value)
    }

    /// Builds a range overlap predicate (`&&`).
    pub fn overlaps(self, value: sqlx::postgres::types::PgRange<T>) -> BoolExpr {
        self.reference().overlaps(value)
    }

    /// Builds a range adjacency predicate (`-|-`).
    pub fn adjacent_to(self, value: sqlx::postgres::types::PgRange<T>) -> BoolExpr {
        self.reference().adjacent_to(value)
    }

    /// Builds a strictly-left range predicate (`<<`).
    pub fn strictly_left_of(self, value: sqlx::postgres::types::PgRange<T>) -> BoolExpr {
        self.reference().strictly_left_of(value)
    }

    /// Builds a strictly-right range predicate (`>>`).
    pub fn strictly_right_of(self, value: sqlx::postgres::types::PgRange<T>) -> BoolExpr {
        self.reference().strictly_right_of(value)
    }

    /// Builds a does-not-extend-right range predicate (`&<`).
    pub fn does_not_extend_right_of(self, value: sqlx::postgres::types::PgRange<T>) -> BoolExpr {
        self.reference().does_not_extend_right_of(value)
    }

    /// Builds a does-not-extend-left range predicate (`&>`).
    pub fn does_not_extend_left_of(self, value: sqlx::postgres::types::PgRange<T>) -> BoolExpr {
        self.reference().does_not_extend_left_of(value)
    }
}

impl<T> FieldRef<sqlx::postgres::types::PgRange<T>>
where
    T: BindValue,
    sqlx::postgres::types::PgRange<T>: BindValue,
{
    /// Builds a range contains element predicate (`@>`).
    pub fn range_contains(self, value: T) -> BoolExpr {
        BoolExpr::infix(
            self.expr(),
            "@>",
            ValueExpr::Param(Param::typed(value)),
            false,
        )
    }

    /// Builds a range contains range predicate (`@>`).
    pub fn contains_range(self, value: sqlx::postgres::types::PgRange<T>) -> BoolExpr {
        self.range_infix("@>", value)
    }

    /// Builds a range contained-by predicate (`<@`).
    pub fn contained_by(self, value: sqlx::postgres::types::PgRange<T>) -> BoolExpr {
        self.range_infix("<@", value)
    }

    /// Builds a range overlap predicate (`&&`).
    pub fn overlaps(self, value: sqlx::postgres::types::PgRange<T>) -> BoolExpr {
        self.range_infix("&&", value)
    }

    /// Builds a range adjacency predicate (`-|-`).
    pub fn adjacent_to(self, value: sqlx::postgres::types::PgRange<T>) -> BoolExpr {
        self.range_infix("-|-", value)
    }

    /// Builds a strictly-left range predicate (`<<`).
    pub fn strictly_left_of(self, value: sqlx::postgres::types::PgRange<T>) -> BoolExpr {
        self.range_infix("<<", value)
    }

    /// Builds a strictly-right range predicate (`>>`).
    pub fn strictly_right_of(self, value: sqlx::postgres::types::PgRange<T>) -> BoolExpr {
        self.range_infix(">>", value)
    }

    /// Builds a does-not-extend-right range predicate (`&<`).
    pub fn does_not_extend_right_of(self, value: sqlx::postgres::types::PgRange<T>) -> BoolExpr {
        self.range_infix("&<", value)
    }

    /// Builds a does-not-extend-left range predicate (`&>`).
    pub fn does_not_extend_left_of(self, value: sqlx::postgres::types::PgRange<T>) -> BoolExpr {
        self.range_infix("&>", value)
    }

    fn range_infix(self, op: &'static str, value: sqlx::postgres::types::PgRange<T>) -> BoolExpr {
        BoolExpr::infix(
            self.expr(),
            op,
            ValueExpr::Param(Param::typed(value)),
            false,
        )
    }
}

impl FieldRef<serde_json::Value> {
    /// Builds a JSONB containment predicate (`@>`).
    #[inline]
    pub fn contains(self, value: serde_json::Value) -> BoolExpr {
        self.json_infix("@>", Param::typed(value))
    }

    /// Builds a JSONB contained-by predicate (`<@`).
    #[inline]
    pub fn contained_by(self, value: serde_json::Value) -> BoolExpr {
        self.json_infix("<@", Param::typed(value))
    }

    /// Builds a JSONB key-exists predicate (`?`).
    pub fn has_key(self, key: impl Into<String>) -> BoolExpr {
        self.json_infix("?", Param::typed(key.into()))
    }

    /// Builds a JSONB any-key-exists predicate (`?|`).
    #[inline]
    pub fn has_any_keys(self, keys: Vec<String>) -> BoolExpr {
        self.json_infix("?|", Param::typed(keys))
    }

    /// Builds a JSONB all-keys-exist predicate (`?&`).
    #[inline]
    pub fn has_all_keys(self, keys: Vec<String>) -> BoolExpr {
        self.json_infix("?&", Param::typed(keys))
    }

    /// Builds a JSON value access expression (`->`).
    pub fn get(self, key: impl Into<String>) -> ValueExpr {
        self.json_value_infix("->", Param::typed(key.into()))
    }

    /// Builds a JSON text access expression (`->>`).
    pub fn get_text(self, key: impl Into<String>) -> ValueExpr {
        self.json_value_infix("->>", Param::typed(key.into()))
    }

    /// Builds a JSON path access expression (`#>`).
    #[inline]
    pub fn path(self, path: Vec<String>) -> ValueExpr {
        self.json_value_infix("#>", Param::typed(path))
    }

    /// Builds a JSON path text access expression (`#>>`).
    #[inline]
    pub fn path_text(self, path: Vec<String>) -> ValueExpr {
        self.json_value_infix("#>>", Param::typed(path))
    }

    fn json_infix(self, op: &'static str, param: Param) -> BoolExpr {
        BoolExpr::infix(self.expr(), op, ValueExpr::Param(param), false)
    }

    fn json_value_infix(self, op: &'static str, param: Param) -> ValueExpr {
        ValueExpr::binary(
            self.expr(),
            super::ValueOp::Custom(op),
            ValueExpr::Param(param),
        )
    }
}