qians_xql 0.2.9

SQL 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
use crate::clause;
use crate::item::Ident;
use crate::item::Row;
use crate::item::TableRef;

macro_rules! stmt_common {
    ($stmt:ident) => {
        impl<'a> std::convert::From<$stmt<'a>> for $crate::stmt::Stmt<'a> {
            #[inline]
            fn from(val: $stmt<'a>) -> Self {
                $crate::stmt::Stmt::$stmt(val)
            }
        }

        impl<'a> $stmt<'a> {
            /// Add [`With`](crate::clause::With) clause to the statement.
            ///
            /// ```sql
            /// WITH name AS (stmt) ...
            /// ```
            pub fn with<N, S>(mut self, name: N, stmt: S) -> $stmt<'a>
            where
                N: Into<$crate::item::Ident<'a>>,
                S: Into<$crate::stmt::Stmt<'a>>,
            {
                self.with = match self.with.take() {
                    Some(mut with) => {
                        with.1.push($crate::item::Cte {
                            name: name.into(),
                            columns: Vec::new(),
                            stmt: stmt.into(),
                        });
                        Some(with)
                    }
                    None => Some(
                        [$crate::item::Cte {
                            name: name.into(),
                            columns: Vec::new(),
                            stmt: stmt.into(),
                        }]
                        .into(),
                    ),
                };
                self
            }

            /// Add [`With`](crate::clause::With) clause to the statement.
            ///
            /// ```sql
            /// WITH name(fields ...) AS (stmt) ...
            /// ```
            pub fn with_labeled<N, C, I, S>(mut self, name: N, fields: I, stmt: S) -> $stmt<'a>
            where
                N: Into<$crate::item::Ident<'a>>,
                C: Into<$crate::item::Ident<'a>>,
                I: IntoIterator<Item = C>,
                S: Into<$crate::stmt::Stmt<'a>>,
            {
                self.with = match self.with.take() {
                    Some(mut with) => {
                        with.1.push($crate::item::Cte {
                            name: name.into(),
                            columns: fields.into_iter().map(Into::into).collect(),
                            stmt: stmt.into(),
                        });
                        Some(with)
                    }
                    None => Some(
                        [$crate::item::Cte {
                            name: name.into(),
                            columns: fields.into_iter().map(Into::into).collect(),
                            stmt: stmt.into(),
                        }]
                        .into(),
                    ),
                };
                self
            }

            /// Turns the [`With`](crate::clause::With) into recursive.
            ///
            /// ```sql
            /// WITH name AS (stmt) ...
            /// ```
            ///
            /// become:
            ///
            /// ```sql
            /// WITH RECUSRIVE name AS (stmt) ...
            /// ```
            pub fn recursive(mut self) -> $stmt<'a> {
                if let Some(mut with) = self.with {
                    with.0 = true;
                    self.with = Some(with);
                }
                self
            }

            /// Turns the recursive [`With`](crate::clause::With) into non recursive.
            ///
            /// ```sql
            /// WITH RECURSIVE name AS (stmt) ...
            /// ```
            ///
            /// become:
            ///
            /// ```sql
            /// WITH name AS (stmt) ...
            /// ```
            pub fn no_recursive(mut self) -> $stmt<'a> {
                if let Some(mut with) = self.with {
                    with.0 = false;
                    self.with = Some(with);
                }
                self
            }
        }
    };
}

pub mod binary;
pub mod data;
pub mod delete;
pub mod insert;
pub mod result;
pub mod select;
pub mod update;
pub mod values;

#[derive(Clone, Debug, PartialEq, Eq)]
pub enum Stmt<'a> {
    Insert(insert::Insert<'a>),
    Select(select::Select<'a>),
    Update(update::Update<'a>),
    Delete(delete::Delete<'a>),
    Values(values::Values<'a>),
    Binary(binary::Binary<'a>),
    Result(result::Result<'a>),
}

crate::macros::gen_display!(Stmt<'_>);

/// Construct a `SELECT` statement.
///
/// # Examples
///
/// ```
/// use qians_xql::select;
///
/// assert_eq!(
///     select(("id", "name")).from("book").to_string(),
///     "SELECT id, name FROM book",
/// );
/// ```
#[inline]
pub fn select<'a, F>(fields: F) -> select::Select<'a>
where
    F: Into<clause::Select<'a>>,
{
    select::Select {
        fields: fields.into(),
        ..Default::default()
    }
}

/// Construct a `VALUES` statement.
///
/// # Examples
///
/// ```
/// use qians_xql::values;
///
/// assert_eq!(
///     values([
///         (1, &"Dune".to_string()),
///         (2, &"The Fellowship of the Ring".to_string()),
///     ]).to_string(),
///     "VALUES (1, 'Dune'), (2, 'The Fellowship of the Ring')",
/// );
/// ```
#[inline]
pub fn values<'a, I, R>(values: I) -> values::Values<'a>
where
    R: Into<Row<'a>>,
    I: IntoIterator<Item = R>,
{
    values::Values {
        rows: clause::Values(values.into_iter().map(Into::into).collect()),
        ..Default::default()
    }
}

/// Construct an `INSERT` statement.
///
/// # Examples
///
/// ```
/// use qians_xql::insert;
///
/// assert_eq!(
///     insert("book", ["id", "name"])
///         .values([
///             (1, &"Dune".to_string()),
///             (2, &"The Fellowship of the Ring".to_string()),
///         ])
///         .to_string(),
///     "INSERT INTO book(id, name) VALUES (1, 'Dune'), (2, 'The Fellowship of the Ring')",
/// );
/// ```
#[inline]
pub fn insert<'a, T, I, C>(table: T, columns: I) -> insert::Insert<'a>
where
    T: Into<TableRef<'a>>,
    C: Into<Ident<'a>>,
    I: IntoIterator<Item = C>,
{
    insert::Insert {
        table: clause::Insert(table.into(), columns.into_iter().map(Into::into).collect()),
        ..Default::default()
    }
}

/// Construct a `DELETE` statement.
///
/// # Examples
///
/// ```
/// use qians_xql::delete;
/// use qians_xql::eq;
///
/// assert_eq!(
///     delete("book")
///         .filter(eq("id", 1))
///         .returning(["id", "name"])
///         .to_string(),
///     "DELETE FROM book WHERE id = 1 RETURNING id, name",
/// );
/// ```
#[inline]
pub fn delete<'a, T>(table: T) -> delete::Delete<'a>
where
    T: Into<clause::Delete<'a>>,
{
    delete::Delete {
        table: table.into(),
        ..Default::default()
    }
}

/// Construct an `UPDATE` statement.
///
/// # Examples
///
/// ```
/// use qians_xql::update;
/// use qians_xql::eq;
///
/// assert_eq!(
///     update("book")
///         .set("name", &"The Two Towers".to_string())
///         .filter(eq("id", 2))
///         .returning(["id", "name"])
///         .to_string(),
///     "UPDATE book SET name = 'The Two Towers' WHERE id = 2 RETURNING id, name",
/// );
/// ```
#[inline]
pub fn update<'a, T>(table: T) -> update::Update<'a>
where
    T: Into<clause::Update<'a>>,
{
    update::Update {
        table: table.into(),
        ..Default::default()
    }
}

macro_rules! generate_binary_funcs {
    ($(#[$comment:meta])* $fn:ident $op:expr) => {
        $(#[$comment])*
        #[inline]
        pub fn $fn<'a, L, R>(left: L, right: R) -> $crate::stmt::binary::Binary<'a>
        where
            L: Into<$crate::stmt::result::Result<'a>>,
            R: Into<$crate::stmt::result::Result<'a>>,
        {
            $crate::stmt::binary::Binary {
                with: None,
                op: $op,
                left: ::std::boxed::Box::new(left.into()),
                right: ::std::boxed::Box::new(right.into()),
            }
        }
    };
}

generate_binary_funcs!(
    /// Construct a `UNION` operation on a statement.
    /// 
    /// # Examples
    /// 
    /// ```
    /// use qians_xql::union;
    /// use qians_xql::select;
    /// 
    /// assert_eq!(
    ///     union(select([1]), select([2])).to_string(),
    ///     "SELECT 1 UNION SELECT 2",
    /// );
    /// ```
    union "UNION");
generate_binary_funcs!(
    /// Construct a `UNION ALL` operation on a statement.
    /// 
    /// # Examples
    /// 
    /// ```
    /// use qians_xql::union_all;
    /// use qians_xql::select;
    /// 
    /// assert_eq!(
    ///     union_all(select([1]), select([2])).to_string(),
    ///     "SELECT 1 UNION ALL SELECT 2",
    /// );
    /// ```
    union_all "UNION ALL");
generate_binary_funcs!(
    /// Construct a `EXCEPT` operation on a statement.
    /// 
    /// # Examples
    /// 
    /// ```
    /// use qians_xql::except;
    /// use qians_xql::select;
    /// 
    /// assert_eq!(
    ///     except(select([1]), select([2])).to_string(),
    ///     "SELECT 1 EXCEPT SELECT 2",
    /// );
    /// ```
    except "EXCEPT");
generate_binary_funcs!(
    /// Construct a `EXCEPT ALL` operation on a statement.
    /// 
    /// # Examples
    /// 
    /// ```
    /// use qians_xql::except_all;
    /// use qians_xql::select;
    /// 
    /// assert_eq!(
    ///     except_all(select([1]), select([2])).to_string(),
    ///     "SELECT 1 EXCEPT ALL SELECT 2",
    /// );
    /// ```
    except_all "EXCEPT ALL");
generate_binary_funcs!(
    /// Construct a `INTERSECT` operation on a statement.
    /// 
    /// # Examples
    /// 
    /// ```
    /// use qians_xql::intersect;
    /// use qians_xql::select;
    /// 
    /// assert_eq!(
    ///     intersect(select([1]), select([2])).to_string(),
    ///     "SELECT 1 INTERSECT SELECT 2",
    /// );
    /// ```
    intersect "INTERSECT");
generate_binary_funcs!(
    /// Construct a `INTERSECT ALL` operation on a statement.
    /// 
    /// # Examples
    /// 
    /// ```
    /// use qians_xql::intersect_all;
    /// use qians_xql::select;
    /// 
    /// assert_eq!(
    ///     intersect_all(select([1]), select([2])).to_string(),
    ///     "SELECT 1 INTERSECT ALL SELECT 2",
    /// );
    /// ```
    intersect_all "INTERSECT ALL");

#[cfg(test)]
mod tests {
    #[test]
    fn cte() {
        let tbl1 = &"tbl1".to_string();
        let tbl2 = &"tbl2".to_string();
        let query = crate::stmt::select(["name"])
            .from(["tbl1", "tbl2"])
            .with_labeled("tbl1", ["name"], crate::stmt::values([(tbl1,)]))
            .with(
                "tbl2",
                crate::stmt::select([crate::ops::as_field(tbl2, "name")]),
            );

        assert_eq!(
            query.to_string(),
            "WITH tbl1(name) AS (VALUES ('tbl1')), tbl2 AS (SELECT 'tbl2' AS name) SELECT name FROM tbl1, tbl2"
        );
    }
}