sz-orm-core 1.1.0

Core ORM engine: Model trait, ActiveRecord, QueryBuilder, Pool, Transaction, migration, and SQL dialect abstraction
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
//! 快捷查询(Db::name 风格)
//!
//! 对应 think-orm 的 `Db::name('user')->where(...)->select()` API。
//! 无需定义 Model 即可直接基于表名查询/插入/更新/删除。
//!
//! # 与 QueryBuilder 的关系
//!
//! `QueryBuilder<M>` 要求泛型参数 `M: Model`,适合已知 Model 类型的场景。
//! `QuickQuery` 则用 `()` 占位 Model,仅依赖表名,避免为临时查询定义 Model。
//!
//! # 用法
//!
//! ```no_run
//! use sz_orm_core::quick_query::Db;
//! use sz_orm_core::{get_dialect, DbType, Value};
//!
//! let dialect = get_dialect(DbType::MySQL).unwrap();
//! // SELECT * FROM users WHERE age > 18 ORDER BY id DESC LIMIT 10
//! let sql = Db::new(dialect).name("users")
//!     .where_cond("age > 18")
//!     .order_desc("id")
//!     .limit(10)
//!     .build_select();
//! ```

use crate::dialect::Dialect;
use crate::query::QueryBuilder;
use crate::value::Value;
use std::collections::HashMap;

/// 内部占位 Model:仅用于满足 `QueryBuilder<M>` 的泛型约束,不携带任何行为
#[derive(Clone)]
struct AnonymousModel;

impl crate::model::Model for AnonymousModel {
    type PrimaryKey = i64;
    fn table_name() -> &'static str {
        ""
    }
    fn pk(&self) -> Self::PrimaryKey {
        0
    }
    fn set_pk(&mut self, _pk: Self::PrimaryKey) {}
}

/// 快捷查询入口(think-orm `Db::name()` 风格)
///
/// 不要求定义 Model,仅靠表名 + 方言即可生成 SQL。
pub struct Db {
    qb: QueryBuilder<AnonymousModel>,
}

impl Db {
    /// 创建快捷查询入口
    pub fn new(dialect: Box<dyn Dialect>) -> Self {
        Self {
            qb: QueryBuilder::new(dialect),
        }
    }

    /// 指定表名(等价于 think-orm 的 `Db::name('user')`)
    #[must_use]
    pub fn name(mut self, table: impl Into<String>) -> Self {
        self.qb = self.qb.table(table);
        self
    }

    /// 选择列
    #[must_use]
    pub fn select(mut self, columns: Vec<&str>) -> Self {
        self.qb = self.qb.select(columns);
        self
    }

    /// WHERE 条件(AND)
    #[must_use]
    pub fn where_cond(mut self, condition: impl Into<String>) -> Self {
        self.qb = self.qb.where_cond(condition);
        self
    }

    /// WHERE 条件(OR)
    #[must_use]
    pub fn or_where(mut self, condition: impl Into<String>) -> Self {
        self.qb = self.qb.or_where(condition);
        self
    }

    /// WHERE IN
    #[must_use]
    pub fn where_in(mut self, field: impl Into<String>, values: Vec<Value>) -> Self {
        self.qb = self.qb.where_in(field, values);
        self
    }

    /// WHERE NOT IN
    #[must_use]
    pub fn where_not_in(mut self, field: impl Into<String>, values: Vec<Value>) -> Self {
        self.qb = self.qb.where_not_in(field, values);
        self
    }

    /// WHERE BETWEEN
    #[must_use]
    pub fn where_between(mut self, field: impl Into<String>, start: Value, end: Value) -> Self {
        self.qb = self.qb.where_between(field, start, end);
        self
    }

    /// WHERE IS NULL
    #[must_use]
    pub fn where_null(mut self, field: impl Into<String>) -> Self {
        self.qb = self.qb.where_null(field);
        self
    }

    /// WHERE IS NOT NULL
    #[must_use]
    pub fn where_not_null(mut self, field: impl Into<String>) -> Self {
        self.qb = self.qb.where_not_null(field);
        self
    }

    /// ORDER BY field ASC
    #[must_use]
    pub fn order_by(mut self, field: impl Into<String>) -> Self {
        self.qb = self.qb.order_by(field);
        self
    }

    /// ORDER BY field DESC
    #[must_use]
    pub fn order_desc(mut self, field: impl Into<String>) -> Self {
        self.qb = self.qb.order_desc(field);
        self
    }

    /// GROUP BY
    #[must_use]
    pub fn group_by(mut self, field: impl Into<String>) -> Self {
        self.qb = self.qb.group_by(field);
        self
    }

    /// HAVING
    #[must_use]
    pub fn having(mut self, condition: impl Into<String>) -> Self {
        self.qb = self.qb.having(condition);
        self
    }

    /// LIMIT
    #[must_use]
    pub fn limit(mut self, limit: usize) -> Self {
        self.qb = self.qb.limit(limit);
        self
    }

    /// OFFSET
    #[must_use]
    pub fn offset(mut self, offset: usize) -> Self {
        self.qb = self.qb.offset(offset);
        self
    }

    /// 分页(page 从 1 开始)
    #[must_use]
    pub fn page(mut self, page: usize, page_size: usize) -> Self {
        self.qb = self.qb.page(page, page_size);
        self
    }

    /// INNER JOIN
    #[must_use]
    pub fn join_inner(
        mut self,
        table: impl Into<String>,
        on_left: impl Into<String>,
        on_right: impl Into<String>,
    ) -> Self {
        self.qb = self.qb.join_inner(table, on_left, on_right);
        self
    }

    /// LEFT JOIN
    #[must_use]
    pub fn join_left(
        mut self,
        table: impl Into<String>,
        on_left: impl Into<String>,
        on_right: impl Into<String>,
    ) -> Self {
        self.qb = self.qb.join_left(table, on_left, on_right);
        self
    }

    /// RIGHT JOIN
    #[must_use]
    pub fn join_right(
        mut self,
        table: impl Into<String>,
        on_left: impl Into<String>,
        on_right: impl Into<String>,
    ) -> Self {
        self.qb = self.qb.join_right(table, on_left, on_right);
        self
    }

    /// 构建 SELECT SQL
    pub fn build_select(&self) -> String {
        self.qb.build_select()
    }

    /// 构建 INSERT SQL
    pub fn build_insert(&self, data: &HashMap<String, Value>) -> String {
        self.qb.build_insert(data)
    }

    /// 构建 UPDATE SQL
    pub fn build_update(&self, data: &HashMap<String, Value>) -> String {
        self.qb.build_update(data)
    }

    /// 构建 DELETE SQL
    pub fn build_delete(&self) -> String {
        self.qb.build_delete()
    }

    /// 构建 COUNT SQL
    pub fn build_count(&self) -> String {
        self.qb.build_count()
    }

    /// 构建 EXISTS SQL
    pub fn build_exists(&self) -> String {
        self.qb.build_exists()
    }

    /// 构建 MAX SQL
    pub fn build_max(&self, field: &str) -> String {
        self.qb.build_max(field)
    }

    /// 构建 MIN SQL
    pub fn build_min(&self, field: &str) -> String {
        self.qb.build_min(field)
    }

    /// 构建 SUM SQL
    pub fn build_sum(&self, field: &str) -> String {
        self.qb.build_sum(field)
    }

    /// 构建 AVG SQL
    pub fn build_avg(&self, field: &str) -> String {
        self.qb.build_avg(field)
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::db_type::DbType;
    use crate::dialect::get_dialect;

    fn mysql() -> Box<dyn Dialect> {
        get_dialect(DbType::MySQL).expect("MySQL dialect")
    }

    fn pg() -> Box<dyn Dialect> {
        get_dialect(DbType::PostgreSQL).expect("PG dialect")
    }

    #[test]
    fn db_name_basic_select() {
        let sql = Db::new(mysql()).name("users").build_select();
        assert_eq!(sql, "SELECT * FROM `users`");
    }

    #[test]
    fn db_name_with_where_and_limit() {
        let sql = Db::new(mysql())
            .name("users")
            .where_cond("age > 18")
            .order_desc("id")
            .limit(10)
            .build_select();
        assert!(sql.contains("SELECT * FROM `users`"));
        assert!(sql.contains("WHERE age > 18"));
        assert!(sql.contains("ORDER BY `id` DESC"));
        assert!(sql.contains("LIMIT 10"));
    }

    #[test]
    fn db_name_insert() {
        let mut data = HashMap::new();
        data.insert("name".to_string(), Value::String("Alice".to_string()));
        data.insert("age".to_string(), Value::I64(30));
        let sql = Db::new(mysql()).name("users").build_insert(&data);
        assert!(sql.starts_with("INSERT INTO `users`"));
        assert!(sql.contains("`name`"));
        assert!(sql.contains("`age`"));
        assert!(sql.contains("'Alice'"));
        assert!(sql.contains("30"));
    }

    #[test]
    fn db_name_update_with_where() {
        let mut data = HashMap::new();
        data.insert("name".to_string(), Value::String("Bob".to_string()));
        let sql = Db::new(mysql())
            .name("users")
            .where_cond("id = 1")
            .build_update(&data);
        assert!(sql.starts_with("UPDATE `users` SET"));
        assert!(sql.contains("`name` = 'Bob'"));
        assert!(sql.contains("WHERE id = 1"));
    }

    #[test]
    fn db_name_delete_with_where() {
        let sql = Db::new(mysql())
            .name("users")
            .where_cond("id = 1")
            .build_delete();
        assert_eq!(sql, "DELETE FROM `users` WHERE id = 1");
    }

    #[test]
    fn db_name_count() {
        let sql = Db::new(mysql())
            .name("users")
            .where_cond("age > 18")
            .build_count();
        assert!(sql.contains("SELECT COUNT(*)"));
        assert!(sql.contains("FROM `users`"));
        assert!(sql.contains("WHERE age > 18"));
    }

    #[test]
    fn db_name_with_in_clause() {
        let sql = Db::new(mysql())
            .name("users")
            .where_in("id", vec![Value::I64(1), Value::I64(2), Value::I64(3)])
            .build_select();
        assert!(sql.contains("WHERE `id` IN (1, 2, 3)"));
    }

    #[test]
    fn db_name_with_between() {
        let sql = Db::new(mysql())
            .name("orders")
            .where_between("amount", Value::I64(100), Value::I64(1000))
            .build_select();
        assert!(sql.contains("`amount` BETWEEN 100 AND 1000"));
    }

    #[test]
    fn db_name_pg_dialect() {
        let sql = Db::new(pg()).name("users").build_select();
        assert_eq!(sql, "SELECT * FROM \"users\"");
    }

    #[test]
    fn db_name_join_inner() {
        let sql = Db::new(mysql())
            .name("orders")
            .join_inner("users", "orders.user_id", "users.id")
            .build_select();
        assert!(sql.contains("INNER JOIN `users` ON `orders.user_id` = `users.id`"));
    }

    #[test]
    fn db_name_pagination() {
        let sql = Db::new(mysql()).name("users").page(3, 20).build_select();
        // 第 3 页,每页 20 条 → LIMIT 20 OFFSET 40
        assert!(sql.contains("LIMIT 20"));
        assert!(sql.contains("OFFSET 40"));
    }

    #[test]
    fn db_name_aggregate_functions() {
        let db = Db::new(mysql())
            .name("orders")
            .where_cond("status = 'paid'");
        assert!(db.build_sum("amount").contains("SUM(`amount`)"));
        assert!(db.build_max("amount").contains("MAX(`amount`)"));
        assert!(db.build_min("amount").contains("MIN(`amount`)"));
        assert!(db.build_avg("amount").contains("AVG(`amount`)"));
        assert!(db.build_exists().contains("SELECT EXISTS("));
    }

    #[test]
    fn db_name_chained_or_where() {
        let sql = Db::new(mysql())
            .name("users")
            .where_cond("age < 18")
            .or_where("age > 65")
            .build_select();
        assert!(sql.contains("WHERE (age < 18 OR age > 65)"));
    }

    #[test]
    fn db_name_group_having() {
        let sql = Db::new(mysql())
            .name("orders")
            .select(vec!["user_id", "COUNT(*) as cnt"])
            .group_by("user_id")
            .having("COUNT(*) > 5")
            .build_select();
        assert!(sql.contains("GROUP BY `user_id`"));
        assert!(sql.contains("HAVING COUNT(*) > 5"));
    }
}