chain-builder 1.0.2

A query builder for MySQL for Rust is designed to be flexible and easy to use.
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
//! Common query functionality for WHERE clauses and other query parts

use crate::query::QueryBuilder;
use crate::types::Common;
use serde_json::Value;

fn build_placeholders(len: usize) -> String {
    if len == 0 {
        return String::new();
    }
    let mut s = String::with_capacity(len * 3 - 2);
    s.push('?');
    for _ in 1..len {
        s.push_str(", ?");
    }
    s
}

/// Trait for common query operations
pub trait QueryCommon {
    /// Add a WITH clause
    fn with(&mut self, alias: &str, chain_builder: crate::builder::ChainBuilder);

    /// Add a recursive WITH clause
    fn with_recursive(&mut self, alias: &str, chain_builder: crate::builder::ChainBuilder);

    /// Add a UNION clause
    fn union(&mut self, chain_builder: crate::builder::ChainBuilder);

    /// Add a UNION ALL clause
    fn union_all(&mut self, chain_builder: crate::builder::ChainBuilder);

    /// Add a LIMIT clause
    fn limit(&mut self, limit: usize);

    /// Add an OFFSET clause
    fn offset(&mut self, offset: usize);

    /// Add a GROUP BY clause
    fn group_by(&mut self, columns: Vec<String>);

    /// Add a raw GROUP BY clause
    fn group_by_raw(&mut self, sql: &str, binds: Option<Vec<Value>>);

    /// Add an ORDER BY clause
    fn order_by(&mut self, column: &str, order: &str);

    /// Add a raw ORDER BY clause
    fn order_by_raw(&mut self, sql: &str, binds: Option<Vec<Value>>);
}

impl QueryCommon for QueryBuilder {
    fn with(&mut self, alias: &str, chain_builder: crate::builder::ChainBuilder) {
        self.query_common
            .push(Common::With(alias.to_string(), false, chain_builder));
    }

    fn with_recursive(&mut self, alias: &str, chain_builder: crate::builder::ChainBuilder) {
        self.query_common
            .push(Common::With(alias.to_string(), true, chain_builder));
    }

    fn union(&mut self, chain_builder: crate::builder::ChainBuilder) {
        self.query_common.push(Common::Union(false, chain_builder));
    }

    fn union_all(&mut self, chain_builder: crate::builder::ChainBuilder) {
        self.query_common.push(Common::Union(true, chain_builder));
    }

    fn limit(&mut self, limit: usize) {
        self.query_common.push(Common::Limit(limit));
    }

    fn offset(&mut self, offset: usize) {
        self.query_common.push(Common::Offset(offset));
    }

    fn group_by(&mut self, columns: Vec<String>) {
        self.query_common.push(Common::GroupBy(columns));
    }

    fn group_by_raw(&mut self, sql: &str, binds: Option<Vec<Value>>) {
        self.query_common
            .push(Common::GroupByRaw(sql.to_string(), binds));
    }

    fn order_by(&mut self, column: &str, order: &str) {
        self.query_common
            .push(Common::OrderBy(column.to_string(), order.to_string()));
    }

    fn order_by_raw(&mut self, sql: &str, binds: Option<Vec<Value>>) {
        self.query_common
            .push(Common::OrderByRaw(sql.to_string(), binds));
    }
}

/// Trait for HAVING clause operations
pub trait HavingClauses {
    /// Add a HAVING condition
    fn having(&mut self, column: &str, operator: &str, value: Value);

    /// Add a HAVING condition with raw SQL
    fn having_raw(&mut self, sql: &str, binds: Option<Vec<Value>>);

    /// Add a HAVING BETWEEN condition
    fn having_between(&mut self, column: &str, values: [Value; 2]);

    /// Add a HAVING IN condition
    fn having_in(&mut self, column: &str, values: Vec<Value>);

    /// Add a HAVING NOT IN condition
    fn having_not_in(&mut self, column: &str, values: Vec<Value>);
}

impl HavingClauses for QueryBuilder {
    fn having(&mut self, column: &str, operator: &str, value: Value) {
        // NOTE: HAVING operands are expression-oriented (e.g. `COUNT(*)`), so the
        // column is treated as a raw expression and is NOT identifier-escaped.
        // Do not pass untrusted input here; use bound `value`s for data.
        let sql = format!("{} {} ?", column, operator);
        self.query_common
            .push(Common::Having(sql, Some(vec![value])));
    }

    fn having_raw(&mut self, sql: &str, binds: Option<Vec<Value>>) {
        self.query_common
            .push(Common::Having(sql.to_string(), binds));
    }

    fn having_between(&mut self, column: &str, values: [Value; 2]) {
        // Expression-oriented; see `having` for the escaping rationale.
        let sql = format!("{} BETWEEN ? AND ?", column);
        self.query_common
            .push(Common::Having(sql, Some(values.to_vec())));
    }

    fn having_in(&mut self, column: &str, values: Vec<Value>) {
        if values.is_empty() {
            self.query_common
                .push(Common::Having("1 = 0".to_string(), None));
            return;
        }
        let placeholders = build_placeholders(values.len());
        let sql = format!("{} IN ({})", column, placeholders);
        self.query_common.push(Common::Having(sql, Some(values)));
    }

    fn having_not_in(&mut self, column: &str, values: Vec<Value>) {
        if values.is_empty() {
            self.query_common
                .push(Common::Having("1 = 1".to_string(), None));
            return;
        }
        let placeholders = build_placeholders(values.len());
        let sql = format!("{} NOT IN ({})", column, placeholders);
        self.query_common.push(Common::Having(sql, Some(values)));
    }
}

/// Trait for WHERE clause operations
pub trait WhereClauses {
    /// Add an equality condition
    fn where_eq(&mut self, column: &str, value: Value);

    /// Add a not equality condition
    fn where_ne(&mut self, column: &str, value: Value);

    /// Add an IN condition
    fn where_in(&mut self, column: &str, values: Vec<Value>);

    /// Add a NOT IN condition
    fn where_not_in(&mut self, column: &str, values: Vec<Value>);

    /// Add an IS NULL condition
    fn where_null(&mut self, column: &str);

    /// Add an IS NOT NULL condition
    fn where_not_null(&mut self, column: &str);

    /// Add a BETWEEN condition
    fn where_between(&mut self, column: &str, values: [Value; 2]);

    /// Add a NOT BETWEEN condition
    fn where_not_between(&mut self, column: &str, values: [Value; 2]);

    /// Add a LIKE condition
    fn where_like(&mut self, column: &str, value: Value);

    /// Add a NOT LIKE condition
    fn where_not_like(&mut self, column: &str, value: Value);

    /// Add a case-insensitive LIKE condition (ILIKE for Postgres, LOWER() for MySQL)
    fn where_ilike(&mut self, column: &str, value: Value);

    /// Add a greater than condition
    fn where_gt(&mut self, column: &str, value: Value);

    /// Add a greater than or equal condition
    fn where_gte(&mut self, column: &str, value: Value);

    /// Add a less than condition
    fn where_lt(&mut self, column: &str, value: Value);

    /// Add a less than or equal condition
    fn where_lte(&mut self, column: &str, value: Value);

    /// Add a column-to-column comparison
    fn where_column(&mut self, lhs: &str, operator: &str, rhs: &str);

    /// Add an EXISTS condition
    fn where_exists(&mut self, query: impl FnOnce(&mut crate::builder::ChainBuilder));

    /// Add a NOT EXISTS condition
    fn where_not_exists(&mut self, query: impl FnOnce(&mut crate::builder::ChainBuilder));

    /// Add a JSON contains condition (MySQL JSON_CONTAINS)
    fn where_json_contains(&mut self, column: &str, value: Value);

    /// Add a subquery condition
    fn where_subquery(&mut self, query: impl FnOnce(&mut QueryBuilder));

    /// Add an OR condition
    fn or(&mut self) -> &mut QueryBuilder;

    /// Add a raw WHERE condition
    fn where_raw(&mut self, sql: &str, binds: Option<Vec<Value>>);
}

impl WhereClauses for QueryBuilder {
    fn where_eq(&mut self, column: &str, value: Value) {
        self.statement.push(crate::types::Statement::Value(
            column.to_string(),
            crate::query::Operator::Equal,
            value,
        ));
    }

    fn where_ne(&mut self, column: &str, value: Value) {
        self.statement.push(crate::types::Statement::Value(
            column.to_string(),
            crate::query::Operator::NotEqual,
            value,
        ));
    }

    fn where_in(&mut self, column: &str, values: Vec<Value>) {
        self.statement.push(crate::types::Statement::Value(
            column.to_string(),
            crate::query::Operator::In,
            Value::Array(values),
        ));
    }

    fn where_not_in(&mut self, column: &str, values: Vec<Value>) {
        self.statement.push(crate::types::Statement::Value(
            column.to_string(),
            crate::query::Operator::NotIn,
            Value::Array(values),
        ));
    }

    fn where_null(&mut self, column: &str) {
        self.statement.push(crate::types::Statement::Value(
            column.to_string(),
            crate::query::Operator::IsNull,
            Value::Null,
        ));
    }

    fn where_not_null(&mut self, column: &str) {
        self.statement.push(crate::types::Statement::Value(
            column.to_string(),
            crate::query::Operator::IsNotNull,
            Value::Null,
        ));
    }

    fn where_between(&mut self, column: &str, values: [Value; 2]) {
        self.statement.push(crate::types::Statement::Value(
            column.to_string(),
            crate::query::Operator::Between,
            Value::Array(values.to_vec()),
        ));
    }

    fn where_not_between(&mut self, column: &str, values: [Value; 2]) {
        self.statement.push(crate::types::Statement::Value(
            column.to_string(),
            crate::query::Operator::NotBetween,
            Value::Array(values.to_vec()),
        ));
    }

    fn where_like(&mut self, column: &str, value: Value) {
        self.statement.push(crate::types::Statement::Value(
            column.to_string(),
            crate::query::Operator::Like,
            value,
        ));
    }

    fn where_not_like(&mut self, column: &str, value: Value) {
        self.statement.push(crate::types::Statement::Value(
            column.to_string(),
            crate::query::Operator::NotLike,
            value,
        ));
    }

    fn where_gt(&mut self, column: &str, value: Value) {
        self.statement.push(crate::types::Statement::Value(
            column.to_string(),
            crate::query::Operator::GreaterThan,
            value,
        ));
    }

    fn where_gte(&mut self, column: &str, value: Value) {
        self.statement.push(crate::types::Statement::Value(
            column.to_string(),
            crate::query::Operator::GreaterThanOrEqual,
            value,
        ));
    }

    fn where_lt(&mut self, column: &str, value: Value) {
        self.statement.push(crate::types::Statement::Value(
            column.to_string(),
            crate::query::Operator::LessThan,
            value,
        ));
    }

    fn where_lte(&mut self, column: &str, value: Value) {
        self.statement.push(crate::types::Statement::Value(
            column.to_string(),
            crate::query::Operator::LessThanOrEqual,
            value,
        ));
    }

    fn where_subquery(&mut self, query: impl FnOnce(&mut QueryBuilder)) {
        let mut sub_query = QueryBuilder::new(self.client.clone());
        query(&mut sub_query);
        self.statement
            .push(crate::types::Statement::SubChain(Box::new(sub_query)));
    }

    fn or(&mut self) -> &mut QueryBuilder {
        let or_query = QueryBuilder::new(self.client.clone());
        self.statement
            .push(crate::types::Statement::OrChain(Box::new(or_query)));
        self.statement.last_mut().unwrap().to_query_builder()
    }

    fn where_raw(&mut self, sql: &str, binds: Option<Vec<Value>>) {
        self.statement
            .push(crate::types::Statement::Raw((sql.to_string(), binds)));
    }

    fn where_ilike(&mut self, column: &str, value: Value) {
        // For MySQL, use LOWER() function
        let column = crate::dialect::escape_identifier(column, &self.client);
        let sql = format!("LOWER({}) LIKE LOWER(?)", column);
        self.statement
            .push(crate::types::Statement::Raw((sql, Some(vec![value]))));
    }

    fn where_column(&mut self, lhs: &str, operator: &str, rhs: &str) {
        let lhs = crate::dialect::escape_identifier(lhs, &self.client);
        let rhs = crate::dialect::escape_identifier(rhs, &self.client);
        let sql = format!("{} {} {}", lhs, operator, rhs);
        self.statement
            .push(crate::types::Statement::Raw((sql, None)));
    }

    fn where_exists(&mut self, query: impl FnOnce(&mut crate::builder::ChainBuilder)) {
        let mut sub_builder = crate::builder::ChainBuilder::new(self.client.clone());
        query(&mut sub_builder);
        let (sub_sql, sub_binds) = sub_builder.to_sql();
        let sql = format!("EXISTS ({})", sub_sql);
        self.statement
            .push(crate::types::Statement::Raw((sql, Some(sub_binds))));
    }

    fn where_not_exists(&mut self, query: impl FnOnce(&mut crate::builder::ChainBuilder)) {
        let mut sub_builder = crate::builder::ChainBuilder::new(self.client.clone());
        query(&mut sub_builder);
        let (sub_sql, sub_binds) = sub_builder.to_sql();
        let sql = format!("NOT EXISTS ({})", sub_sql);
        self.statement
            .push(crate::types::Statement::Raw((sql, Some(sub_binds))));
    }

    fn where_json_contains(&mut self, column: &str, value: Value) {
        let column = crate::dialect::escape_identifier(column, &self.client);
        let sql = format!("JSON_CONTAINS({}, ?)", column);
        self.statement
            .push(crate::types::Statement::Raw((sql, Some(vec![value]))));
    }
}