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
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
//! # SZ-ORM — 鲜视达 ORM
//!
//! Rust 异步 ORM 工作空间(原型阶段),兼容 ThinkORM 风格。
//!
//! ## 架构概览
//!
//! SZ-ORM 工作空间由 **39 个成员** 组成(37 个 sz-orm-* lib + cli + examples):
//!
//! ### 核心引擎 (sz-orm-core)
//! | 模块 | 功能 |
//! |------|------|
//! | `model` | `Model` trait — 定义表名、主键、时间戳、软删除、关联关系 |
//! | `query` | `QueryBuilder<M>` — 链式 API,支持 SELECT/INSERT/UPDATE/DELETE/聚合/分页/JOIN |
//! | `dialect` | 多数据库方言 — MySQL (反引号)、PostgreSQL (双引号)、SQLite、Oracle 23ai |
//! | `pool` | 异步连接池 — 可配置大小、超时、空闲回收、健康检查、最大生命周期 |
//! | `transaction` | ACID 事务 — 隔离级别、保存点、`TransactionManager` 多事务管理 |
//! | `migration` | 文件迁移系统 — up/down/rollback/reset/refresh,含 `SchemaBuilder` |
//! | `cache` | 多级缓存 — `MemoryCache`、`MultiLevelCache`,支持 TTL |
//! | `value` | 统一值类型 — 20 种变体 (整数/浮点/字符串/字节/UUID/日期/JSON/数组) |
//! | `db_type` | 数据库类型枚举 — MySQL、PostgreSQL、SQLite、Oracle、Redis、MongoDB 等 11 种 |
//! | `error` | 错误类型体系 — `DbError`(20 变体)、`PoolError`、`CacheError`、`TxError` |
//!
//! ### 数据库适配器
//! - **sz-orm-sqlx** — sqlx 适配器,连接真实 MySQL/PostgreSQL/SQLite/Oracle
//! - **sz-orm-sql-validator** — SQL 校验与注入检测
//!
//! ### 扩展生态包 (18 个)
//! | 包名 | 功能 |
//! |------|------|
//! | sz-orm-crypto | 加密原语 (AES-256-GCM, PBKDF2, HMAC-SHA256) |
//! | sz-orm-auth | JWT 鉴权 (HS256) |
//! | sz-orm-scheduler | Cron 定时任务调度 |
//! | sz-orm-mqtt | MQTT 客户端 (rumqttc) |
//! | sz-orm-websocket | WebSocket 服务端 (tokio-tungstenite) |
//! | sz-orm-queue | 消息队列 (RabbitMQ/lapin, Kafka, NATS, ActiveMQ, RocketMQ, Pulsar) |
//! | sz-orm-storage | 对象存储 (S3/阿里云/腾讯云/华为云/七牛/又拍云/本地) |
//! | sz-orm-ai | AI 集成 (Embedding, RAG, Vector) |
//! | sz-orm-grpc | gRPC 服务/客户端 |
//! | sz-orm-graphql | GraphQL 查询支持 |
//! | sz-orm-es | Elasticsearch 集成 |
//! | sz-orm-tracing | 分布式追踪 |
//! | sz-orm-logger | 日志系统 |
//! | sz-orm-swagger | API 文档生成 |
//! | sz-orm-masking | 数据脱敏 |
//! | sz-orm-health | 健康检查 |
//! | sz-orm-audit | 审计日志 |
//! | sz-orm-batch | 批量操作 |
//!
//! ### 高级特性包 (6 个)
//! | 包名 | 功能 |
//! |------|------|
//! | sz-orm-dtx | 分布式事务 |
//! | sz-orm-rw | 读写分离 |
//! | sz-orm-sharding | 分库分表 |
//! | sz-orm-limit | 限流控制 |
//! | sz-orm-config | 配置管理 |
//! | sz-orm-mig | 迁移管理增强 |
//!
//! ### 平台支持
//! - **sz-orm-wasm** — WebAssembly 编译目标
//! - **sz-orm-lc** — 本地/边缘计算
//! - **sz-orm-back** — 备份与恢复
//!
//! ## 快速入门
//!
//! ```rust,ignore
//! use sz_orm_core::*;
//!
//! // 1. 定义模型
//! #[derive(Clone)]
//! struct User {
//! id: i64,
//! name: String,
//! email: String,
//! }
//!
//! impl Model for User {
//! type PrimaryKey = i64;
//! fn table_name() -> &'static str { "users" }
//! fn pk(&self) -> Self::PrimaryKey { self.id }
//! fn set_pk(&mut self, pk: Self::PrimaryKey) { self.id = pk; }
//! }
//!
//! // 2. 构建查询
//! let dialect = get_dialect(DbType::MySQL).unwrap();
//! let sql = QueryBuilder::<User>::new(dialect)
//! .table("users")
//! .select(vec!["id", "name", "email"])
//! .where_cond("status = 'active'")
//! .order_by("created_at")
//! .order_desc("id")
//! .limit(10)
//! .build_select();
//!
//! // 3. 执行前校验
//! QueryBuilder::<User>::new(get_dialect(DbType::MySQL).unwrap())
//! .table("users")
//! .select(vec!["id", "name"])
//! .validate()?; // 校验 SQL 语法、注入、括号平衡
//!
//! // 4. 其他操作
//! let mut data = std::collections::HashMap::new();
//! data.insert("name".to_string(), Value::String("Alice".to_string()));
//! data.insert("age".to_string(), Value::I64(25));
//!
//! let insert_sql = QueryBuilder::<User>::new(dialect)
//! .table("users")
//! .build_insert(&data);
//!
//! let update_sql = QueryBuilder::<User>::new(get_dialect(DbType::MySQL).unwrap())
//! .table("users")
//! .where_cond("id = 1")
//! .build_update(&data);
//!
//! let delete_sql = QueryBuilder::<User>::new(get_dialect(DbType::MySQL).unwrap())
//! .table("users")
//! .where_cond("id = 1")
//! .build_delete();
//! ```
//!
//! ## 支持的数据库
//!
//! | 数据库 | 方言实现 | 真实连接 | 引用方式 |
//! |--------|---------|---------|---------|
//! | MySQL | `MySqlDialect` (`` ` `` 反引号) | sz-orm-sqlx | ✅ |
//! | PostgreSQL | `PostgreSqlDialect` (`"` 双引号) | sz-orm-sqlx | ✅ |
//! | SQLite 3.35+ | `SqliteDialect` (`"` 双引号) | sz-orm-sqlx | ✅ |
//! | Oracle 23ai | `OracleDialect` (类型自动映射) | sz-orm-sqlx | ✅ |
//!
//! 通过 `get_dialect(DbType::MySQL)` 获取方言实例。每个方言处理:
//! - 标识符引用风格
//! - 字符串转义规则
//! - 分页语法 (LIMIT/OFFSET vs OFFSET/FETCH)
//! - JSON 提取函数 (JSON_EXTRACT vs #>> vs json_extract vs JSON_VALUE)
//! - 全文搜索 (MATCH AGAINST vs to_tsvector vs CONTAINS)
//! - 布尔转整数 (IF/CASE)
//! - 自增关键字 (AUTO_INCREMENT/GENERATED BY DEFAULT AS IDENTITY)
//!
//! ## 核心功能详解
//!
//! ### QueryBuilder API
//!
//! 所有查询方法返回 `Self`,支持链式调用:
//!
//! ```rust,ignore
//! // 基础查询
//! QueryBuilder::<M>::new(dialect)
//! .table("users")
//! .select(vec!["id", "name"])
//! .where_cond("status = 'active'") // AND
//! .or_where("role = 'admin'") // OR
//! .where_in("id", vec![Value::I64(1), Value::I64(2)])
//! .where_between("age", Value::I64(18), Value::I64(30))
//! .where_null("deleted_at")
//! .order_by("created_at")
//! .order_desc("id")
//! .group_by("status")
//! .having("COUNT(*) > 5")
//! .limit(20)
//! .offset(40)
//! .page(3, 20) // page=3, page_size=20
//! .join_inner("posts", "users.id", "posts.user_id")
//! .join_left("profiles", "users.id", "profiles.user_id")
//! .build_select();
//!
//! // 聚合函数
//! builder.build_count(); // SELECT COUNT(*)
//! builder.build_exists(); // SELECT EXISTS(...)
//! builder.build_max("score");
//! builder.build_min("price");
//! builder.build_sum("amount");
//! builder.build_avg("value");
//! ```
//!
//! ### SQL 校验
//!
//! ```rust,ignore
//! // 编译时 + 运行时双重校验
//! builder.validate()?; // 校验 SELECT
//! builder.validate_insert(&data)?; // 校验 INSERT(含空数据检测)
//! builder.validate_update(&data)?; // 校验 UPDATE(含空数据检测)
//! builder.validate_delete()?; // 校验 DELETE
//!
//! // 校验内容包括:SQL 语法、注入检测、括号平衡、
//! // 表名/列名合法性、JOIN 列名校验
//! ```
//!
//! ### Model Trait
//!
//! ```rust,ignore
//! pub trait Model: Send + Sync + Sized + 'static {
//! type PrimaryKey: Send + Sync + Debug + Display + Clone + Default;
//!
//! fn table_name() -> &'static str; // 表名(必需)
//! fn pk_name() -> &'static str { "id" } // 主键列名
//! fn pk(&self) -> Self::PrimaryKey; // 获取主键值
//! fn set_pk(&mut self, pk: Self::PrimaryKey); // 设置主键值
//! fn foreign_key(relation: &str) -> String; // 外键命名 "user_id"
//! fn timestamp_fields() -> Option<TimestampFields>; // 自动时间戳
//! fn soft_delete_field() -> Option<&'static str>; // 软删除字段
//! }
//!
//! // ModelExt 扩展
//! pub trait ModelExt: Model {
//! fn columns() -> Vec<&'static str>; // 所有列
//! fn fillable() -> Vec<&'static str>; // 可填充列
//! fn guarded() -> Vec<&'static str>; // 保护列(默认含主键)
//! fn hidden() -> Vec<&'static str>; // 隐藏列(不序列化)
//! fn relations() -> HashMap<&str, Relation>; // 关联关系
//! fn fill(&mut self, data: HashMap<String, Value>); // 批量赋值
//! fn to_json(&self) -> serde_json::Value; // 序列化
//! }
//!
//! // 四种关联关系
//! // BelongsTo — 多对一(Order → User)
//! // HasMany — 一对多(User → Orders)
//! // HasOne — 一对一(User → Profile)
//! // BelongsToMany — 多对多(User ↔ Role,通过中间表)
//! ```
//!
//! ### 连接池
//!
//! ```rust,ignore
//! // 通过 Builder 配置
//! let config = PoolConfigBuilder::new()
//! .max_size(100) // 最大连接数
//! .min_idle(10) // 最小空闲连接
//! .acquire_timeout(30) // 获取超时(秒)
//! .idle_timeout(600) // 空闲超时(秒)
//! .max_lifetime(1800) // 最大生命周期(秒)
//! .build()?;
//!
//! let pool = Pool::new(config, factory)?;
//! let conn = pool.acquire().await?; // 获取连接(带超时)
//! pool.release(conn).await; // 归还连接
//! pool.status().await; // PoolStatus { idle, active, max, min }
//! pool.reap_idle().await; // 回收空闲连接
//! pool.close_all().await; // 关闭所有连接
//! ```
//!
//! ### 事务
//!
//! ```rust,ignore
//! // 事务选项
//! let opts = TransactOptions::default()
//! .with_isolation(IsolationLevel::Serializable)
//! .read_only()
//! .with_timeout(Duration::from_secs(30));
//!
//! let mut tx = Transaction::new(conn, opts);
//! tx.execute("INSERT INTO users VALUES (1)").await?;
//! tx.query("SELECT * FROM users").await?;
//!
//! // 保存点(嵌套事务)
//! let sp = tx.savepoint().await?; // SAVEPOINT sp_N
//! tx.rollback_to_savepoint(&sp).await?; // ROLLBACK TO SAVEPOINT sp_N
//! tx.release_savepoint(&sp).await?; // RELEASE SAVEPOINT sp_N
//!
//! tx.commit().await?;
//! // tx.rollback().await?;
//!
//! // TransactionManager:管理多个命名事务
//! let mgr = TransactionManager::new();
//! mgr.begin("tx1", conn, opts).await?;
//! mgr.commit("tx1").await?;
//! mgr.list().await; // ["tx1"]
//! mgr.state("tx1").await; // Some(TransactionState::Committed)
//! ```
//!
//! ### 迁移系统
//!
//! ```rust,ignore
//! // 文件命名:<version>_<name>_up.sql / <version>_<name>_down.sql
//! // 示例:001_create_users_up.sql, 001_create_users_down.sql
//!
//! let resolver = FileMigrationResolver::new(PathBuf::from("./migrations"));
//! let migrations = resolver.resolve(DbType::MySQL)?;
//!
//! let mut migrator = Migrator::new(MigrationContext::default())
//! .add_migrations(migrations);
//!
//! migrator.migrate().await?; // 执行所有待迁移
//! migrator.up(Some("003")).await?; // 执行到指定版本
//! migrator.down(Some("001")).await?; // 回滚到指定版本
//! migrator.rollback("002").await?; // 回滚单个迁移
//! migrator.reset().await?; // 全部回滚 + 重新执行
//! migrator.refresh().await?; // 同 reset
//! migrator.progress(); // MigrationProgress { total, applied, pending }
//!
//! // SchemaBuilder:程序化建表
//! let sql = SchemaBuilder::new("users")
//! .add_column(ColumnDef::new("id", "INT").not_null().auto_increment())
//! .add_column(ColumnDef::new("name", "VARCHAR").length(255).not_null())
//! .add_index(IndexDef::new("idx_name", vec!["name"]).unique())
//! .add_foreign_key(
//! ForeignKeyDef::new("fk_role", "role_id", "roles", "id")
//! .on_delete("CASCADE")
//! )
//! .build(DbType::MySQL);
//! ```
//!
//! ### 值类型 (Value)
//!
//! ```rust,ignore
//! // 20 种变体,覆盖所有数据库类型
//! Value::Null | Bool(bool) | I8..I64 | U8..U64 | F32 | F64
//! | String(String) | Bytes(Vec<u8>) | Uuid(String) | Date(String)
//! | DateTime(String) | Time(String) | Json(String) | Array(Vec<Value>)
//!
//! // 类型转换
//! value.as_str() // Option<&str>
//! value.as_i64() // Option<i64>(支持 F32/F64/Bool/String→i64 转换)
//! value.as_f64() // Option<f64>
//! value.as_bool() // Option<bool>(支持 "true"/"1"/"yes"/"on" 等)
//! value.as_bytes() // Option<&[u8]>
//! value.to_param() // Cow<str> — SQL 参数格式
//!
//! // From 实现
//! let v: Value = 42i64.into();
//! let v: Value = "hello".into();
//! let v: Value = vec![1u8, 2u8].into();
//! ```
//!
//! ## 错误处理
//!
//! 统一错误类型体系,每种错误携带唯一错误码:
//!
//! ```rust,ignore
//! // DbError — 20 种变体,错误码 DB001-DB020
//! DbError::QueryError("...")
//! DbError::ConnectionRefused("...")
//! DbError::ConnectionTimeout("...")
//! DbError::NotFound("...")
//! DbError::ConstraintViolation("...")
//! // ... 等
//!
//! // PoolError — 6 种变体,错误码 PL001-PL006
//! PoolError::Exhausted | Timeout | AlreadyAcquired | InvalidConfig | ...
//!
//! // CacheError — 6 种变体,错误码 CH001-CH006
//! // TxError — 6 种变体(NotStarted, CommitFailed, SavepointError 等)
//!
//! // 便捷方法
//! DbError::query("test failed") // 创建查询错误
//! DbError::connection("timeout") // 创建连接错误
//! DbError::not_found("user #42") // 创建未找到错误
//! err.is_retryable() // 是否可重试
//! err.error_code() // "DB001"
//! ```
//!
//! ## 验证方法
//!
//! SZ-ORM 通过 **7 线验证体系** 保证质量:
//!
//! | 验证方法 | 描述 | 测试文件 |
//! |---------|------|---------|
//! | **TDD** | 核心模块 115+ 单元测试 | `core.rs` |
//! | **集成** | 真实 MySQL/PG/SQLite/Oracle 端到端 | `integration_mysql.rs`, `integration_pg.rs`, `integration_sqlite.rs` |
//! | **Jepsen** | 29 并发正确性测试 + 10 真实 DB Jepsen | `jepsen.rs`, `real_db_jepsen.rs` |
//! | **Fuzz** | 11 边界/边缘案例发现 | `fuzz.rs` |
//! | **Stress** | 77 性能基准测试 | `stress.rs`, `core_bench.rs` |
//! | **Chaos** | 16 故障鲁棒性测试 | `chaos.rs` |
//! | **Formal** | 14 形式化验证不变量 | `formal.rs` |
//!
//! **总计:2,271 测试,0 失败**(1,635 `#[test]` + 636 `#[tokio::test]`;部分需真实服务)
//!
//! ## 类型别名与常量
//!
//! ```rust,ignore
//! // 类型别名
//! pub type Shared<T> = Arc<T>;
//! pub type Boxed<T> = Box<T>;
//! pub type DbResult<T> = Result<T, DbError>;
//! pub type PoolResult<T> = Result<T, PoolError>;
//! pub type CacheResult<T> = Result<T, CacheError>;
//! pub type TxResult<T> = Result<T, TxError>;
//!
//! // 默认常量
//! pub const DEFAULT_BATCH_SIZE: usize = 1000;
//! pub const DEFAULT_ACQUIRE_TIMEOUT: u64 = 30; // 秒
//! pub const DEFAULT_IDLE_TIMEOUT: u64 = 600; // 秒
//! pub const DEFAULT_MAX_LIFETIME: u64 = 1800; // 秒
//! pub const DEFAULT_MIN_IDLE: u32 = 5;
//! pub const DEFAULT_MAX_SIZE: u32 = 100;
//! ```
//!
//! ## 导出清单
//!
//! `use sz_orm_core::*;` 将导入以下模块的全部公共符号:
//!
//! - `async_trait` (重导出)、`bytes::Bytes`、`chrono::{DateTime, Utc}`、`serde::{Deserialize, Serialize}`
//! - `cache::*` — `Cache`, `MemoryCache`, `MultiLevelCache`, `CacheStats`
//! - `db_type::*` — `DbType` 枚举 (11 种数据库)
//! - `dialect::*` — `Dialect`, `MySqlDialect`, `PostgreSqlDialect`, `SqliteDialect`, `OracleDialect`, `get_dialect()`
//! - `error::*` — `DbError`, `PoolError`, `CacheError`, `TxError`
//! - `migration::*` — `Migration`, `Migrator`, `SchemaBuilder`, `ColumnDef`, `IndexDef`, `ForeignKeyDef`
//! - `model::*` — `Model`, `ModelExt`, `Relation`, `BelongsTo`, `HasMany`, `HasOne`, `BelongsToMany`
//! - `pool::*` — `Pool`, `PoolConfig`, `PoolConfigBuilder`, `Connection`, `ConnectionFactory`, `PoolStatus`
//! - `query::*` — `QueryBuilder<M>` (链式 SQL 构造器)
//! - `transaction::*` — `Transaction`, `TransactionManager`, `TransactOptions`, `IsolationLevel`
//! - `value::*` — `Value` 枚举 (20 种变体)
// 文档完整性:docs.rs 构建文档时启用 missing_docs lint
// 本地和 CI clippy 不触发,避免 313 个 pub API 缺文档阻塞开发
// 待文档逐步补齐后再改为全局 #![warn(missing_docs)]
use Arc;
/// Re-export async traits
pub use async_trait;
/// Re-export common types
pub use Bytes;
pub use ;
pub use ;
// Re-export proc macros
pub use sql_string;
pub use typed_query;
pub use *;
pub use *;
pub use *;
pub use *;
pub use *;
pub use *;
pub use *;
pub use *;
pub use *;
pub use *;
/// Alias for `Arc<T>`
pub type Shared<T> = ;
/// Alias for `Box<T>`
pub type Boxed<T> = ;
/// Alias for Result<T, DbError>
pub type DbResult<T> = ;
/// Result type for pool operations
pub type PoolResult<T> = ;
/// Result type for cache operations
pub type CacheResult<T> = ;
/// Result type for transaction operations
pub type TxResult<T> = ;
/// Default batch size for bulk operations
pub const DEFAULT_BATCH_SIZE: usize = 1000;
/// Default connection timeout in seconds
pub const DEFAULT_ACQUIRE_TIMEOUT: u64 = 30;
/// Default idle timeout in seconds
pub const DEFAULT_IDLE_TIMEOUT: u64 = 600;
/// Default max lifetime in seconds
pub const DEFAULT_MAX_LIFETIME: u64 = 1800;
/// Default minimum idle connections
pub const DEFAULT_MIN_IDLE: u32 = 5;
/// Default maximum pool size
pub const DEFAULT_MAX_SIZE: u32 = 100;