Trait DialectPlugin

Source

pub trait DialectPlugin: Send + Sync {
    // Required method
    fn name(&self) -> &str;

    // Provided methods
    fn quote_style(&self) -> Option<QuoteStyle> { ... }
    fn supports_ilike(&self) -> Option<bool> { ... }
    fn map_function_name(&self, name: &str) -> Option<String> { ... }
    fn map_data_type(&self, data_type: &DataType) -> Option<DataType> { ... }
    fn transform_expr(&self, expr: &Expr) -> Option<Expr> { ... }
    fn transform_statement(&self, statement: &Statement) -> Option<Statement> { ... }
}

Expand description

Trait that external code can implement to define a custom SQL dialect.

All methods have default implementations that return None, meaning “no custom behaviour — fall through to the built-in logic”. Implementors only need to override the methods they care about.

§Thread Safety

Implementations must be Send + Sync because the global registry is shared across threads.

§Example

use sqlglot_rust::dialects::plugin::{DialectPlugin, DialectRegistry};
use sqlglot_rust::ast::{DataType, Expr, QuoteStyle, Statement};

struct MyDialect;

impl DialectPlugin for MyDialect {
    fn name(&self) -> &str { "mydialect" }

    fn map_function_name(&self, name: &str) -> Option<String> {
        match name.to_uppercase().as_str() {
            "MY_FUNC" => Some("BUILTIN_FUNC".to_string()),
            _ => None,
        }
    }

    fn quote_style(&self) -> Option<QuoteStyle> {
        Some(QuoteStyle::Backtick)
    }
}

// Register once, then use via DialectRef::Custom("mydialect")
DialectRegistry::global().register(MyDialect);