rbatis_plus_sqlparser/dialect/sql_dialect.rs
1//! SQL 方言 trait(对标 Java `IDialect`,mybatis-plus-jsqlparser-support)。
2//!
3//! 每种数据库实现自己的分页 SQL 改写逻辑。
4//!
5//! 对应 Java:
6//! - `com.baomidou.mybatisplus.extension.plugins.pagination.dialect.IDialect`(`mybatis-plus-jsqlparser-support/.../dialects/IDialect.java`)
7
8use super::{mysql, postgresql, sqlite};
9
10/// SQL 方言 trait(对标 Java `IDialect`)。
11///
12/// 每种数据库实现自己的分页 SQL 改写逻辑。
13///
14/// ```rust
15/// use rbatis_plus_sqlparser::dialect::SqlDialect;
16/// use rbatis_plus_sqlparser::dialect::mysql::MysqlDialect;
17///
18/// let dialect = MysqlDialect;
19/// let sql = dialect.build_pagination_sql("SELECT * FROM users", 0, 10);
20/// assert!(sql.contains("LIMIT"));
21/// ```
22pub trait SqlDialect: Send + Sync {
23 /// 方言名称。
24 fn name(&self) -> &str;
25
26 /// 改写 SQL 添加分页(对标 `IDialect.buildPaginationSql()`)。
27 ///
28 /// # 参数
29 /// - `sql`: 原始 SQL
30 /// - `offset`: 偏移量
31 /// - `size`: 每页大小
32 fn build_pagination_sql(&self, sql: &str, offset: u64, size: u64) -> String;
33
34 /// 是否支持该方言的 SQL(用于自动检测)。
35 fn supports(&self, db_type: &str) -> bool;
36}
37
38/// 获取默认方言列表(MySQL / PostgreSQL / SQLite)。
39pub fn default_dialects() -> Vec<Box<dyn SqlDialect>> {
40 vec![
41 Box::new(mysql::MysqlDialect),
42 Box::new(postgresql::PostgreSqlDialect),
43 Box::new(sqlite::SqliteDialect),
44 ]
45}