yang-db 0.1.5

个人使用数据库操作
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
//! 查询热路径使用的受控 SQL 引用与封闭操作符。

use crate::sql_types::{Identifier, QualifiedIdentifier};
use crate::DbError;
use std::fmt;

/// 构建期校验完成的数据库表引用。
#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct TableRef {
    raw: String,
}

impl TableRef {
    /// 校验并创建表引用。
    pub fn new(value: impl Into<String>) -> Result<Self, DbError> {
        let raw = value.into();
        Identifier::parse(&raw)?;
        Ok(Self { raw })
    }

    /// 返回未加方言引号的已校验表名。
    pub fn as_str(&self) -> &str {
        &self.raw
    }

    #[doc(hidden)]
    pub fn __from_validated_literal(value: &'static str) -> Self {
        Self {
            raw: value.to_string(),
        }
    }

    #[doc(hidden)]
    pub fn __from_validated_owned(raw: String) -> Self {
        Self { raw }
    }
}

impl fmt::Display for TableRef {
    fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
        formatter.write_str(&self.raw)
    }
}

/// 构建期校验完成的列或 `table.column` 引用。
#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct FieldRef {
    raw: String,
    #[cfg(feature = "mysql")]
    mysql: String,
    #[cfg(feature = "postgres")]
    postgres: String,
}

impl FieldRef {
    /// 校验并创建字段引用。
    pub fn new(value: impl Into<String>) -> Result<Self, DbError> {
        let raw = value.into();
        let identifier = QualifiedIdentifier::parse(&raw)?;
        let _ = &identifier;
        Ok(Self {
            #[cfg(feature = "mysql")]
            mysql: identifier.render('`'),
            #[cfg(feature = "postgres")]
            postgres: identifier.render('"'),
            raw,
        })
    }

    /// 返回未加方言引号的已校验字段名。
    pub fn as_str(&self) -> &str {
        &self.raw
    }

    #[doc(hidden)]
    pub fn __from_validated_literal(value: &'static str) -> Self {
        Self {
            #[cfg(feature = "mysql")]
            mysql: value
                .split('.')
                .map(|part| format!("`{part}`"))
                .collect::<Vec<_>>()
                .join("."),
            #[cfg(feature = "postgres")]
            postgres: value
                .split('.')
                .map(|part| format!("\"{part}\""))
                .collect::<Vec<_>>()
                .join("."),
            raw: value.to_string(),
        }
    }

    #[doc(hidden)]
    pub fn __from_validated_owned(raw: String) -> Self {
        Self {
            #[cfg(feature = "mysql")]
            mysql: raw
                .split('.')
                .map(|part| format!("`{part}`"))
                .collect::<Vec<_>>()
                .join("."),
            #[cfg(feature = "postgres")]
            postgres: raw
                .split('.')
                .map(|part| format!("\"{part}\""))
                .collect::<Vec<_>>()
                .join("."),
            raw,
        }
    }

    #[cfg(feature = "mysql")]
    #[doc(hidden)]
    pub fn mysql_quoted(&self) -> &str {
        &self.mysql
    }

    #[cfg(feature = "postgres")]
    #[doc(hidden)]
    pub fn postgres_quoted(&self) -> &str {
        &self.postgres
    }
}

#[doc(hidden)]
pub const fn __validate_table_literal(value: &str) {
    validate_literal(value, false);
}

#[doc(hidden)]
pub const fn __validate_field_literal(value: &str) {
    validate_literal(value, true);
}

const fn validate_literal(value: &str, qualified: bool) {
    let bytes = value.as_bytes();
    assert!(!bytes.is_empty(), "SQL identifier cannot be empty");
    let mut index = 0;
    let mut segment_start = true;
    let mut dots = 0;
    while index < bytes.len() {
        let byte = bytes[index];
        if byte == b'.' {
            assert!(qualified, "table identifier cannot be qualified");
            assert!(!segment_start, "identifier segment cannot be empty");
            dots += 1;
            assert!(dots <= 1, "field identifier accepts at most table.field");
            segment_start = true;
        } else if segment_start {
            assert!(
                byte == b'_' || byte.is_ascii_alphabetic(),
                "identifier must start with ASCII letter or underscore"
            );
            segment_start = false;
        } else {
            assert!(
                byte == b'_' || byte.is_ascii_alphanumeric(),
                "identifier contains invalid character"
            );
        }
        index += 1;
    }
    assert!(!segment_start, "identifier segment cannot be empty");
}

impl fmt::Display for FieldRef {
    fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
        formatter.write_str(&self.raw)
    }
}

/// QueryBuilder 接受的封闭比较操作符。
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
#[non_exhaustive]
pub enum CompareOp {
    /// 等于。
    Eq,
    /// 不等于。
    Ne,
    /// 大于。
    Gt,
    /// 小于。
    Lt,
    /// 大于等于。
    Gte,
    /// 小于等于。
    Lte,
    /// SQL LIKE。
    Like,
}

/// 受控排序方向。
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub enum SortOrder {
    /// 升序。
    Asc,
    /// 降序。
    Desc,
}

/// 受控字段引用组成的布尔查询树。
#[derive(Debug, Clone, PartialEq)]
pub enum Predicate {
    /// 字段比较。
    Compare(FieldRef, CompareOp, serde_json::Value),
    /// IN。
    In(FieldRef, Vec<serde_json::Value>),
    /// NOT IN。
    NotIn(FieldRef, Vec<serde_json::Value>),
    /// BETWEEN。
    Between(FieldRef, serde_json::Value, serde_json::Value),
    /// IS NULL。
    IsNull(FieldRef),
    /// IS NOT NULL。
    IsNotNull(FieldRef),
    /// AND 组。
    And(Vec<Predicate>),
    /// OR 组。
    Or(Vec<Predicate>),
}

/// 受控 SELECT 聚合表达式。
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct SelectExpr {
    aggregate: Aggregate,
    field: Option<FieldRef>,
    alias: Option<FieldRef>,
    cast_double: bool,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
enum Aggregate {
    Count,
    Sum,
    Avg,
    Min,
    Max,
}

impl SelectExpr {
    /// `COUNT(*)`。
    pub fn count_all() -> Self {
        Self {
            aggregate: Aggregate::Count,
            field: None,
            alias: None,
            cast_double: false,
        }
    }

    /// `COUNT(field)`。
    pub fn count(field: &FieldRef) -> Self {
        Self::new(Aggregate::Count, field)
    }

    /// `SUM(field)`。
    pub fn sum(field: &FieldRef) -> Self {
        Self::new(Aggregate::Sum, field)
    }

    /// `AVG(field)`。
    pub fn avg(field: &FieldRef) -> Self {
        Self::new(Aggregate::Avg, field)
    }

    /// `MIN(field)`。
    pub fn min(field: &FieldRef) -> Self {
        Self::new(Aggregate::Min, field)
    }

    /// `MAX(field)`。
    pub fn max(field: &FieldRef) -> Self {
        Self::new(Aggregate::Max, field)
    }

    fn new(aggregate: Aggregate, field: &FieldRef) -> Self {
        Self {
            aggregate,
            field: Some(field.clone()),
            alias: None,
            cast_double: false,
        }
    }

    /// 将聚合结果转换为方言对应的双精度浮点数。
    pub fn cast_double(mut self) -> Self {
        self.cast_double = true;
        self
    }

    /// 设置受控输出别名。
    pub fn alias(mut self, alias: &FieldRef) -> Self {
        self.alias = Some(alias.clone());
        self
    }

    #[cfg(feature = "mysql")]
    pub(crate) fn mysql_sql(&self) -> String {
        self.render('`', "DOUBLE")
    }

    #[cfg(feature = "postgres")]
    pub(crate) fn postgres_sql(&self) -> String {
        self.render('"', "DOUBLE PRECISION")
    }

    #[cfg(any(feature = "mysql", feature = "postgres"))]
    fn render(&self, quote: char, double_type: &str) -> String {
        let function = match self.aggregate {
            Aggregate::Count => "COUNT",
            Aggregate::Sum => "SUM",
            Aggregate::Avg => "AVG",
            Aggregate::Min => "MIN",
            Aggregate::Max => "MAX",
        };
        let operand = self.field.as_ref().map_or_else(
            || "*".to_string(),
            |field| quote_qualified(field.as_str(), quote),
        );
        let aggregate = format!("{function}({operand})");
        let expression = if self.cast_double {
            format!("CAST({aggregate} AS {double_type})")
        } else {
            aggregate
        };
        self.alias.as_ref().map_or(expression.clone(), |alias| {
            format!("{expression} AS {}", quote_qualified(alias.as_str(), quote))
        })
    }
}

#[cfg(any(feature = "mysql", feature = "postgres"))]
fn quote_qualified(value: &str, quote: char) -> String {
    value
        .split('.')
        .map(|segment| format!("{quote}{segment}{quote}"))
        .collect::<Vec<_>>()
        .join(".")
}

#[cfg(any(feature = "mysql", feature = "postgres"))]
impl SortOrder {
    pub(crate) const fn is_ascending(self) -> bool {
        matches!(self, Self::Asc)
    }
}

#[cfg(test)]
#[allow(clippy::expect_used)]
mod tests {
    use super::*;

    #[test]
    fn controlled_references_validate_once_and_render_both_dialects() {
        let table = TableRef::new("org_user").expect("合法表名应创建成功");
        let field = FieldRef::new("org_user.username").expect("合法限定字段应创建成功");

        assert_eq!(table.as_str(), "org_user");
        assert_eq!(field.as_str(), "org_user.username");
        #[cfg(feature = "mysql")]
        assert_eq!(field.mysql_quoted(), "`org_user`.`username`");
        #[cfg(feature = "postgres")]
        assert_eq!(field.postgres_quoted(), "\"org_user\".\"username\"");
    }

    #[test]
    fn controlled_references_reject_expressions_and_injection_payloads() {
        for invalid in ["", "users;DROP", "COUNT(*)", "users.id.extra", "用户"] {
            assert!(TableRef::new(invalid).is_err());
            assert!(FieldRef::new(invalid).is_err());
        }
    }

    #[cfg(feature = "mysql")]
    #[tokio::test]
    async fn mysql_query_builder_consumes_controlled_references_without_value_interpolation() {
        let pool = sqlx::mysql::MySqlPoolOptions::new()
            .connect_lazy("mysql://root:test@127.0.0.1:3306/test")
            .expect("lazy MySQL pool 应创建成功");
        let database = crate::Database::from_pool(pool, crate::DatabaseConfig::default())
            .expect("默认 MySQL 配置应有效");
        let table = TableRef::new("org_user").expect("固定表名有效");
        let username = FieldRef::new("username").expect("固定字段名有效");

        let sql = database
            .table(&table)
            .field(&username)
            .where_and(&username, CompareOp::Eq, "alice")
            .order(&username, SortOrder::Asc)
            .try_to_sql()
            .expect("受控 MySQL 查询应生成 SQL");

        assert!(sql.contains("`org_user`"));
        assert!(sql.contains("`username`"));
        assert!(sql.contains('?'));
        assert!(!sql.contains("alice"));
    }

    #[cfg(feature = "postgres")]
    #[tokio::test]
    async fn postgres_query_builder_consumes_controlled_references_without_value_interpolation() {
        let pool = sqlx::postgres::PgPoolOptions::new()
            .connect_lazy("postgres://postgres:test@127.0.0.1:5432/test")
            .expect("lazy PostgreSQL pool 应创建成功");
        let database = crate::PgDatabase::from_pool(pool, crate::PgDatabaseConfig::default())
            .expect("默认 PostgreSQL 配置应有效");
        let table = TableRef::new("org_user").expect("固定表名有效");
        let username = FieldRef::new("username").expect("固定字段名有效");

        let sql = database
            .table(&table)
            .field(&username)
            .where_and(&username, CompareOp::Eq, "alice")
            .order(&username, SortOrder::Desc)
            .try_to_sql()
            .expect("受控 PostgreSQL 查询应生成 SQL");

        assert!(sql.contains("\"org_user\""));
        assert!(sql.contains("\"username\""));
        assert!(sql.contains("$1"));
        assert!(!sql.contains("alice"));
    }
}