Rust数据库方言支持库sqruff-lib-dialects使用指南

概述

sqruff-lib-dialects是一个Rust库，提供多数据库SQL语法解析与转换功能。它允许开发者将SQL语句在不同数据库方言之间进行转换，简化跨数据库应用的开发。

主要特性

• 支持多种数据库方言（MySQL、PostgreSQL、SQLite等）
• SQL语法解析与抽象语法树(AST)构建
• 数据库方言间的SQL转换
• 语法验证与规范化

安装

在Cargo.toml中添加依赖：

[dependencies]
sqruff-lib-dialects = "0.1"  # 请使用最新版本

基本使用方法

1. 解析SQL语句

use sqruff_lib_dialects::parser::parse_sql;
use sqruff_lib_dialects::dialect::GenericDialect;

fn main() {
    let dialect = GenericDialect {};
    let sql = "SELECT id, name FROM users WHERE age > 25";
    
    match parse_sql(&dialect, sql) {
        Ok(ast) => println!("解析成功: {:?}", ast),
        Err(e) => println!("解析失败: {}", e),
    }
}

2. 转换SQL方言

use sqruff_lib_dialects::{
    parser::parse_sql,
    dialects::{MySQLDialect, PostgreSQLDialect},
    translator::translate,
};

fn main() {
    let mysql_sql = "SELECT `id`, `name` FROM `users` WHERE `age` > 25";
    
    // 解析MySQL SQL
    let mysql_dialect = MySQLDialect {};
    let ast = parse_sql(&mysql_dialect, mysql_sql).unwrap();
    
    // 转换为PostgreSQL语法
    let pg_dialect = PostgreSQLDialect {};
    let pg_sql = translate(&pg_dialect, &ast).unwrap();
    
    println!("PostgreSQL SQL: {}", pg_sql);
    // 输出: SELECT "id", "name" FROM "users" WHERE "age" > 25
}

3. 处理不同数据库的特性差异

use sqruff_lib_dialects::{
    dialects::{MySQLDialect, SQLiteDialect},
    parser::parse_sql,
    translator::translate,
};

fn convert_mysql_to_sqlite(mysql_sql: &str) -> String {
    let mysql_dialect = MySQLDialect {};
    let ast = parse_sql(&mysql_dialect, mysql_sql).unwrap();
    
    let sqlite_dialect = SQLiteDialect {};
    translate(&sqlite_dialect, &ast).unwrap()
}

fn main() {
    let mysql_sql = "SELECT NOW() as current_time";
    let sqlite_sql = convert_mysql_to_sqlite(mysql_sql);
    
    println!("SQLite SQL: {}", sqlite_sql);
    // 输出: SELECT CURRENT_TIMESTAMP as current_time
}

高级用法

自定义方言处理

use sqruff_lib_dialects::{
    dialect::Dialect,
    parser::parse_sql,
    translator::translate,
    dialects::GenericDialect,
};

struct CustomDialect;
impl Dialect for CustomDialect {
    // 实现自定义方言特性
    fn identifier_quote(&self) -> char {
        '#'
    }
    
    // 其他自定义方法...
}

fn main() {
    let sql = "SELECT id FROM users";
    let generic_ast = parse_sql(&GenericDialect {}, sql).unwrap();
    
    let custom_dialect = CustomDialect {};
    let custom_sql = translate(&custom_dialect, &generic_ast).unwrap();
    
    println!("Custom SQL: {}", custom_sql);
    // 输出: SELECT #id# FROM #users#
}

批量转换SQL文件

use sqruff_lib_dialects::{
    dialects::{MySQLDialect, PostgreSQLDialect},
    parser::parse_sql,
    translator::translate,
};
use std::fs;

fn convert_sql_file(input_path: &str, output_path: &str) -> Result<(), Box<dyn std::error::Error>> {
    let mysql_sql = fs::read_to_string(input_path)?;
    let mysql_dialect = MySQLDialect {};
    let ast = parse_sql(&mysql_dialect, &mysql_sql)?;
    
    let pg_dialect = PostgreSQLDialect {};
    let pg_sql = translate(&pg_dialect, &ast)?;
    
    fs::write(output_path, pg_sql)?;
    Ok(())
}

fn main() {
    if let Err(e) = convert_sql_file("input.sql", "output.sql") {
        eprintln!("转换失败: {}", e);
    }
}

注意事项

1. 并非所有SQL特性都能完美转换，某些数据库特有的功能可能需要手动调整
2. 复杂查询（如嵌套子查询、窗口函数等）可能需要额外验证
3. 转换后的SQL应始终进行测试验证

支持的数据库方言

• MySQL
• PostgreSQL
• SQLite
• Microsoft SQL Server (部分支持)
• Oracle (部分支持)
• 通用SQL方言 (GenericDialect)

通过sqruff-lib-dialects，开发者可以更轻松地构建支持多数据库的Rust应用程序，减少为不同数据库维护单独SQL语句的工作量。

完整示例DEMO

下面是一个完整的示例，展示如何使用sqruff-lib-dialects进行SQL解析和转换：

use sqruff_lib_dialects::{
    parser::parse_sql,
    dialects::{MySQLDialect, PostgreSQLDialect, SQLiteDialect},
    translator::translate,
    dialect::Dialect,
};

fn main() {
    // 示例1: 基本SQL解析
    println!("=== 基本SQL解析示例 ===");
    let generic_sql = "SELECT id, name FROM products WHERE price > 100";
    let generic_dialect = GenericDialect {};
    
    match parse_sql(&generic_dialect, generic_sql) {
        Ok(ast) => println!("解析成功: {:#?}", ast),
        Err(e) => println!("解析失败: {}", e),
    }

    // 示例2: MySQL到PostgreSQL转换
    println!("\n=== MySQL到PostgreSQL转换示例 ===");
    let mysql_sql = "SELECT `id`, `product_name` FROM `products` WHERE `category` = 'electronics'";
    let mysql_dialect = MySQLDialect {};
    
    let ast = parse_sql(&mysql_dialect, mysql_sql).unwrap();
    let pg_dialect = PostgreSQLDialect {};
    let pg_sql = translate(&pg_dialect, &ast).unwrap();
    
    println!("PostgreSQL SQL:\n{}", pg_sql);

    // 示例3: 处理函数差异
    println!("\n=== 处理函数差异示例 ===");
    let mysql_func_sql = "SELECT DATE_FORMAT(created_at, '%Y-%m-%d') FROM orders";
    let ast = parse_sql(&mysql_dialect, mysql_func_sql).unwrap();
    
    let pg_sql = translate(&pg_dialect, &ast).unwrap();
    println!("PostgreSQL 转换结果:\n{}", pg_sql);
    
    // 示例4: 自定义方言
    println!("\n=== 自定义方言示例 ===");
    struct MyCustomDialect;
    impl Dialect for MyCustomDialect {
        fn identifier_quote(&self) -> char {
            '@'
        }
        
        fn supports_filter_during_aggregation(&self) -> bool {
            true
        }
    }
    
    let custom_dialect = MyCustomDialect {};
    let custom_sql = translate(&custom_dialect, &ast).unwrap();
    println!("自定义方言SQL:\n{}", custom_sql);
}

这个完整示例展示了：

1. 基本的SQL解析功能
2. MySQL到PostgreSQL的SQL转换
3. 处理数据库间函数差异的情况
4. 如何创建和使用自定义方言

运行此示例前，请确保已正确添加sqruff-lib-dialects依赖。