sqlt 0.3.2

SQL parser, translator, and linter for MySQL, MariaDB, Postgres, MSSQL, SQLite
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

//! SQLT0001 — diagnostics for `SqltStatement::Raw` fragments.

use crate::ast::SqltStatement;
use crate::lint::ctx::LintCtx;
use crate::lint::diagnostic::Diagnostic;
use crate::lint::rule::{Category, Rule, RuleId, RuleMeta, Severity};

pub struct RawPassthrough;

const META_RAW: RuleMeta = RuleMeta {
    id: RuleId("SQLT0001"),
    name: "raw-passthrough",
    category: Category::Raw,
    default_severity: Severity::Warning,
    // Off by default: real `mariadb-dump` output emits hundreds of fragments
    // sqlparser can't parse (DISABLE/ENABLE KEYS, DELIMITER directives,
    // CREATE DEFINER prefixes, …) and a flood of identical SQLT0001 warnings
    // drowns out the typed-AST rule findings. Pass `sqlt lint --verbose`
    // (or `-v`) to surface them, or `--rule SQLT0001` to opt in explicitly.
    default_enabled: false,
    summary: "A statement fell back to raw passthrough — no typed AST in sqlparser 0.59.",
    explanation: "Disabled by default; pass `--verbose` / `-v` to surface these. MariaDB \
                  constructs that don't yet have a typed sqlparser node — system versioning, \
                  FOR SYSTEM_TIME, CREATE PACKAGE, MariaDB sequence option ordering, vector \
                  types, DISABLE/ENABLE KEYS, DELIMITER directives, CREATE DEFINER prefixes — \
                  are kept as raw text. Same-dialect round-trip preserves them; cross-dialect \
                  translation will reject them with a RAW_PASSTHROUGH warning. The `reason` \
                  field on the parsed JSON envelope identifies which class of construct \
                  triggered the fallback.",
};

impl Rule for RawPassthrough {
    fn meta(&self) -> &'static RuleMeta {
        &META_RAW
    }
    fn check_statement(&self, stmt: &SqltStatement, ctx: &LintCtx, out: &mut Vec<Diagnostic>) {
        if let SqltStatement::Raw(r) = stmt {
            out.push(Diagnostic {
                rule: META_RAW.id,
                rule_name: META_RAW.name,
                category: META_RAW.category,
                severity: META_RAW.default_severity,
                message: format!(
                    "raw {} fragment — no typed AST representation in sqlparser 0.59",
                    r.reason
                ),
                suggestion: Some(
                    "ensure the construct survives the round-trip you intend; cross-dialect translation will reject it"
                        .into(),
                ),
                span: ctx.stmt_span,
                stmt_index: ctx.stmt_index,
                source_dialect: ctx.src,
                target_dialect: ctx.dst,
            });
        }
    }
}