rust-queries-builder 1.0.6

A powerful, type-safe query builder library for Rust that leverages key-paths for SQL-like operations on in-memory collections
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
# SQL to Rust Query Builder Comparison

This document provides a comprehensive mapping between SQL queries (HSQLDB-style) and their equivalent Rust Query Builder implementations.

## Table of Contents

1. [Basic Queries]#basic-queries
2. [Aggregations]#aggregations
3. [Grouping and Ordering]#grouping-and-ordering
4. [Joins]#joins
5. [Advanced Patterns]#advanced-patterns

## Basic Queries

### SELECT with WHERE

**SQL:**
```sql
SELECT * FROM employees WHERE department = 'Engineering';
```

**Rust Query Builder:**
```rust
let query = Query::new(&employees)
    .where_(Employee::department_r(), |dept| dept == "Engineering");
let engineering = query.all();
```

### SELECT Specific Columns (Projection)

**SQL:**
```sql
SELECT name FROM employees WHERE salary > 80000;
```

**Rust Query Builder:**
```rust
let high_earners: Vec<String> = Query::new(&employees)
    .where_(Employee::salary_r(), |&salary| salary > 80000.0)
    .select(Employee::name_r());
```

### Multiple WHERE Conditions (AND)

**SQL:**
```sql
SELECT * FROM employees 
WHERE salary > 70000 AND age < 35;
```

**Rust Query Builder:**
```rust
let query = Query::new(&employees)
    .where_(Employee::salary_r(), |&salary| salary > 70000.0)
    .where_(Employee::age_r(), |&age| age < 35);
let results = query.all();
```

### Complex Conditions (BETWEEN, OR)

**SQL:**
```sql
SELECT * FROM employees
WHERE department IN ('Engineering', 'Sales')
  AND salary BETWEEN 80000 AND 100000
  AND age >= 30
ORDER BY salary DESC;
```

**Rust Query Builder:**
```rust
let results = Query::new(&employees)
    .where_(Employee::department_r(), |dept| 
        dept == "Engineering" || dept == "Sales")
    .where_(Employee::salary_r(), |&sal| 
        sal >= 80000.0 && sal <= 100000.0)
    .where_(Employee::age_r(), |&age| age >= 30)
    .order_by_float_desc(Employee::salary_r());
```

## Aggregations

### COUNT

**SQL:**
```sql
SELECT COUNT(*) FROM employees WHERE age < 30;
```

**Rust Query Builder:**
```rust
let count = Query::new(&employees)
    .where_(Employee::age_r(), |&age| age < 30)
    .count();
```

### SUM

**SQL:**
```sql
SELECT SUM(salary) FROM employees WHERE department = 'Engineering';
```

**Rust Query Builder:**
```rust
let total: f64 = Query::new(&employees)
    .where_(Employee::department_r(), |dept| dept == "Engineering")
    .sum(Employee::salary_r());
```

### AVG, MIN, MAX

**SQL:**
```sql
SELECT 
    AVG(salary) as avg_salary,
    MIN(salary) as min_salary,
    MAX(salary) as max_salary
FROM employees 
WHERE department = 'Engineering';
```

**Rust Query Builder:**
```rust
let eng_query = Query::new(&employees)
    .where_(Employee::department_r(), |dept| dept == "Engineering");

let avg = eng_query.avg(Employee::salary_r()).unwrap_or(0.0);
let min = eng_query.min_float(Employee::salary_r()).unwrap_or(0.0);
let max = eng_query.max_float(Employee::salary_r()).unwrap_or(0.0);
```

## Grouping and Ordering

### GROUP BY

**SQL:**
```sql
SELECT 
    department,
    COUNT(*) as emp_count,
    AVG(salary) as avg_salary
FROM employees
GROUP BY department;
```

**Rust Query Builder:**
```rust
let by_dept = Query::new(&employees).group_by(Employee::department_r());

for (dept, emps) in &by_dept {
    let dept_query = Query::new(emps);
    let count = emps.len();
    let avg = dept_query.avg(Employee::salary_r()).unwrap_or(0.0);
    println!("{}: {} employees, avg ${:.2}", dept, count, avg);
}
```

### GROUP BY with HAVING

**SQL:**
```sql
SELECT 
    city, 
    COUNT(*) as emp_count, 
    AVG(salary) as avg_salary
FROM employees
GROUP BY city
HAVING COUNT(*) > 1;
```

**Rust Query Builder:**
```rust
let by_city = Query::new(&employees).group_by(Employee::city_r());

let filtered: Vec<_> = by_city
    .iter()
    .filter(|(_, emps)| emps.len() > 1)  // HAVING equivalent
    .map(|(city, emps)| {
        let avg = Query::new(emps).avg(Employee::salary_r()).unwrap_or(0.0);
        (city.clone(), emps.len(), avg)
    })
    .collect();
```

### ORDER BY

**SQL:**
```sql
SELECT name, salary 
FROM employees
WHERE department = 'Sales'
ORDER BY salary DESC;
```

**Rust Query Builder:**
```rust
let sorted = Query::new(&employees)
    .where_(Employee::department_r(), |dept| dept == "Sales")
    .order_by_float_desc(Employee::salary_r());
```

### ORDER BY Multiple Columns

While SQL supports `ORDER BY col1, col2`, you can achieve this in Rust by sorting after the query:

**SQL:**
```sql
SELECT * FROM employees ORDER BY department, salary DESC;
```

**Rust Query Builder:**
```rust
let mut results = Query::new(&employees).all().into_iter()
    .cloned()
    .collect::<Vec<_>>();

results.sort_by(|a, b| {
    a.department.cmp(&b.department)
        .then(b.salary.partial_cmp(&a.salary).unwrap())
});
```

## Joins

### INNER JOIN

**SQL:**
```sql
SELECT e.name, d.name as dept_name, d.budget
FROM employees e
INNER JOIN departments d ON e.department = d.name;
```

**Rust Query Builder:**
```rust
let results = JoinQuery::new(&employees, &departments).inner_join(
    Employee::department_r(),
    Department::name_r(),
    |emp, dept| (emp.name.clone(), dept.name.clone(), dept.budget)
);
```

### LEFT JOIN

**SQL:**
```sql
SELECT u.name, o.id as order_id, o.total
FROM users u
LEFT JOIN orders o ON u.id = o.user_id;
```

**Rust Query Builder:**
```rust
let results = JoinQuery::new(&users, &orders).left_join(
    User::id_r(),
    Order::user_id_r(),
    |user, order| match order {
        Some(o) => (user.name.clone(), Some(o.id), Some(o.total)),
        None => (user.name.clone(), None, None),
    }
);
```

### JOIN with WHERE

**SQL:**
```sql
SELECT e.name, o.total
FROM employees e
INNER JOIN orders o ON e.id = o.employee_id
WHERE o.total > 100;
```

**Rust Query Builder:**
```rust
let results = JoinQuery::new(&employees, &orders).inner_join_where(
    Employee::id_r(),
    Order::employee_id_r(),
    |_emp, order| order.total > 100.0,  // WHERE condition
    |emp, order| (emp.name.clone(), order.total)
);
```

### Three-Way JOIN

**SQL:**
```sql
SELECT e.name, p.name as project, d.name as department
FROM employees e
INNER JOIN projects p ON e.id = p.employee_id
INNER JOIN departments d ON p.department_id = d.id;
```

**Rust Query Builder:**
```rust
// First join
let emp_proj = JoinQuery::new(&employees, &projects).inner_join(
    Employee::id_r(),
    Project::employee_id_r(),
    |emp, proj| (emp.clone(), proj.clone())
);

// Second join
let results: Vec<_> = emp_proj
    .iter()
    .flat_map(|(emp, proj)| {
        departments.iter()
            .filter(|d| d.id == proj.department_id)
            .map(move |dept| {
                (emp.name.clone(), proj.name.clone(), dept.name.clone())
            })
    })
    .collect();
```

## Advanced Patterns

### LIMIT and OFFSET (Pagination)

**SQL:**
```sql
SELECT * FROM employees ORDER BY name LIMIT 10 OFFSET 20;
```

**Rust Query Builder:**
```rust
let page_3: Vec<_> = Query::new(&employees)
    .order_by(Employee::name_r())
    .into_iter()
    .skip(20)
    .take(10)
    .collect();
```

### TOP N

**SQL:**
```sql
SELECT TOP 5 name, salary 
FROM employees 
ORDER BY salary DESC;
```

**Rust Query Builder:**
```rust
let top_5: Vec<_> = Query::new(&employees)
    .order_by_float_desc(Employee::salary_r())
    .into_iter()
    .take(5)
    .collect();
```

### Subqueries

**SQL:**
```sql
SELECT * FROM employees
WHERE salary > (SELECT AVG(salary) FROM employees);
```

**Rust Query Builder:**
```rust
let avg_salary = Query::new(&employees)
    .avg(Employee::salary_r())
    .unwrap_or(0.0);

let query = Query::new(&employees)
    .where_(Employee::salary_r(), move |&sal| sal > avg_salary);
let above_avg = query.all();
```

### EXISTS

**SQL:**
```sql
SELECT EXISTS(SELECT 1 FROM employees WHERE department = 'Engineering');
```

**Rust Query Builder:**
```rust
let has_engineers = Query::new(&employees)
    .where_(Employee::department_r(), |dept| dept == "Engineering")
    .exists();
```

### DISTINCT (Approximate)

While there's no built-in DISTINCT, you can use HashSet:

**SQL:**
```sql
SELECT DISTINCT department FROM employees;
```

**Rust Query Builder:**
```rust
use std::collections::HashSet;

let departments: HashSet<String> = Query::new(&employees)
    .select(Employee::department_r())
    .into_iter()
    .collect();
```

### CASE/WHEN Equivalent

**SQL:**
```sql
SELECT 
    name,
    salary,
    CASE 
        WHEN salary > 100000 THEN 'High'
        WHEN salary > 70000 THEN 'Medium'
        ELSE 'Low'
    END as salary_grade
FROM employees;
```

**Rust Query Builder:**
```rust
let query = Query::new(&employees);
let all_employees = query.all();

let results: Vec<_> = all_employees
    .iter()
    .map(|emp| {
        let grade = if emp.salary > 100000.0 {
            "High"
        } else if emp.salary > 70000.0 {
            "Medium"
        } else {
            "Low"
        };
        (emp.name.clone(), emp.salary, grade)
    })
    .collect();
```

## Type Safety Advantages

Unlike SQL, the Rust Query Builder provides **compile-time type safety**:

```rust
// ✅ Compiles - correct types
query.where_(Employee::salary_r(), |&sal| sal > 80000.0)

// ❌ Won't compile - type mismatch
query.where_(Employee::salary_r(), |sal| sal == "80000")

// ❌ Won't compile - wrong field
query.where_(Employee::name_r(), |&name| name > 80000.0)

// ✅ Compiles - IDE autocomplete works
query.select(Employee::department_r())

// ❌ Won't compile - field doesn't exist
query.select(Employee::nonexistent_field_r())
```

## Performance Comparison

| Operation | SQL (Database) | Rust Query Builder |
|-----------|---------------|-------------------|
| Simple WHERE | Index-dependent | O(n) scan |
| JOIN | Index-dependent, O(n log n) - O(n²) | O(n + m) hash-based |
| ORDER BY | O(n log n) | O(n log n) |
| GROUP BY | Hash/Sort based | O(n) hash-based |
| Aggregation | O(n) | O(n) |
| Memory | Depends on result set | In-memory only |

**Advantages of Rust Query Builder:**
- Zero network latency
- Compile-time type safety
- No SQL injection vulnerabilities
- Works with any Rust struct
- No database setup required
- Direct memory access

**When to use SQL Database:**
- Large datasets (> memory)
- Persistent storage needed
- Concurrent access required
- Complex transactions
- Multi-user applications

## Running the Examples

```bash
# See complete SQL comparison with 15 examples
cargo run --example sql_comparison
```

## Conclusion

The Rust Query Builder provides a type-safe, compile-time checked alternative to SQL queries for in-memory data operations. While it doesn't replace databases for persistent storage, it excels at querying, filtering, and transforming data structures in Rust applications.