如何为基于MySQL Lex的CalciteQueryEngine新增Lex配置控制？

要新增配置控制Calcite SqlParser的MySQL Lex配置，按以下步骤操作：

1. 定义自定义配置常量与配置类 #

首先在Calcite的配置体系中添加专属的配置键，用来承载你的Lex自定义规则：

import org.apache.calcite.config.Config;
import org.apache.calcite.config.ConfigDef;

// 自定义Lex配置类，封装需要控制的参数
public class MySqlLexConfig {
    // 默认配置
    public static final MySqlLexConfig DEFAULT = new MySqlLexConfig(false, true);
    
    // 示例参数：关键字是否区分大小写、是否允许反引号标识符
    private final boolean caseSensitiveKeywords;
    private final boolean allowBackQuotedIdentifiers;

    public MySqlLexConfig(boolean caseSensitiveKeywords, boolean allowBackQuotedIdentifiers) {
        this.caseSensitiveKeywords = caseSensitiveKeywords;
        this.allowBackQuotedIdentifiers = allowBackQuotedIdentifiers;
    }

    // Getter方法
    public boolean isCaseSensitiveKeywords() { return caseSensitiveKeywords; }
    public boolean isAllowBackQuotedIdentifiers() { return allowBackQuotedIdentifiers; }
}

// 在Calcite配置类中注册自定义配置键
public class CustomCalciteConfig {
    public static final Config.ConfigKey<MySqlLexConfig> MYSQL_LEX_CONFIG =
            ConfigDef.key("mysqlLexConfig", MySqlLexConfig.class, MySqlLexConfig.DEFAULT);
}

2. 扩展SqlParser配置类 #

继承Calcite的SqlParser.ConfigImpl，将自定义Lex配置关联到Parser配置中：

import org.apache.calcite.sql.parser.SqlParser;

public class CustomMySqlParserConfig extends SqlParser.ConfigImpl {
    private final MySqlLexConfig mysqlLexConfig;

    public CustomMySqlParserConfig(MySqlLexConfig mysqlLexConfig) {
        // 基于默认MySQL Lex配置初始化
        super(SqlParser.DEFAULT.withLex(Lex.MYSQL));
        this.mysqlLexConfig = mysqlLexConfig;
    }

    public MySqlLexConfig getMysqlLexConfig() {
        return mysqlLexConfig;
    }
}

3. 自定义MySQL Lex实现 #

继承Calcite原生的MySqlLex，根据自定义配置调整Lex行为：

import org.apache.calcite.sql.parser.SqlParserPos;
import org.apache.calcite.sql.parser.mysql.MySqlLex;

public class CustomMySqlLex extends MySqlLex {
    private final MySqlLexConfig config;

    public CustomMySqlLex(MySqlLexConfig config) {
        // 传递配置参数给父类
        super(config.isCaseSensitiveKeywords(), config.isAllowBackQuotedIdentifiers());
        this.config = config;
    }

    // 示例：重写标识符解析逻辑，根据配置调整规则
    @Override
    public String identifierString() {
        String id = super.identifierString();
        // 如果配置要求标识符小写，这里可以统一转换
        if (!config.isCaseSensitiveKeywords()) {
            return id.toLowerCase();
        }
        return id;
    }
}

4. 绑定自定义Lex到Parser工厂 #

实现SqlParserImplFactory，在创建Parser实例时注入自定义Lex：

import org.apache.calcite.sql.parser.SqlParser;
import org.apache.calcite.sql.parser.SqlParserImpl;
import org.apache.calcite.sql.parser.SqlParserImplFactory;

public class CustomMySqlParserFactory implements SqlParserImplFactory {
    @Override
    public SqlParserImpl create(SqlParser.Config config) {
        // 强转获取自定义配置
        CustomMySqlParserConfig customConfig = (CustomMySqlParserConfig) config;
        // 创建自定义Lex实例
        CustomMySqlLex lex = new CustomMySqlLex(customConfig.getMysqlLexConfig());
        // 返回绑定了自定义Lex的MySQL Parser
        return new MySqlParserImpl(lex, config);
    }
}

5. 使用自定义配置创建Parser #

在业务代码中，通过自定义配置初始化Parser：

// 创建自定义Lex配置
MySqlLexConfig customLexConfig = new MySqlLexConfig(true, false);
// 创建Parser配置
SqlParser.Config parserConfig = new CustomMySqlParserConfig(customLexConfig);
// 绑定自定义Parser工厂
parserConfig = parserConfig.withParserFactory(new CustomMySqlParserFactory());
// 创建Parser并解析SQL
SqlParser parser = SqlParser.create("SELECT * FROM `users`", parserConfig);
SqlNode sqlNode = parser.parseStmt();

内容的提问来源于stack exchange，提问作者ZhangJian He