Apache AGE扩展psql支持Cypher时SQL子句解析冲突求解

问题背景 #

当前使用Apache AGE执行Cypher查询时，必须嵌套在SQL语句中：

SELECT * FROM cypher('graph_name', $$
MATCH (v)
RETURN v
$$) as (v agtype);

你已实现直接输入MATCH (v) RETURN v;即可执行的功能，但目前仅通过前缀字符串匹配（MATCH/OPTIONAL/EXPLAIN/CREATE）区分Cypher与SQL，该方案维护性差，且会误将前缀匹配的SQL语句送入Cypher解析器，触发语法错误。

优化方案 #

1. 引入显式元命令（推荐） #

在psql中新增类似\cypher的元命令，让用户通过前缀明确指定执行Cypher语句，彻底避免自动检测的歧义：

• 修改psql的slash命令处理逻辑，添加\cypher命令，接收后续Cypher语句后自动转换为嵌套SQL格式发送执行。
• 示例：用户输入\cypher MATCH (v) RETURN v;，psql自动转换为SELECT * FROM cypher('graph_name', $$MATCH (v) RETURN v$$) as (v agtype);（可配置默认图名，或支持用户显式指定）。

该方案逻辑清晰、维护成本低，完全契合psql现有元命令的设计风格，无歧义问题。

2. 基于解析器的精准预检测 #

若坚持自动检测逻辑，可利用Apache AGE的Cypher解析器做轻量预验证，替代单纯的前缀匹配：

• 在HandleCypherCmds中，先调用AGE的Cypher解析器对输入语句做语法检查（仅解析不执行）。
• 解析成功则按Cypher处理；解析失败则回退到SQL执行流程。
• 注意需做好错误捕获，避免解析崩溃，同时控制性能开销（轻量语句预解析影响可忽略）。

核心逻辑示例：

/* 通过Cypher解析器预检测判断语句类型 */
bool is_cypher = false;
// 调用AGE提供的解析接口尝试预解析
if (age_cypher_try_parse(query_buf->data) == 0) {
    is_cypher = true;
}

if (is_cypher) {
    cypherCmdStatus = HandleCypherCmds(scan_state, cond_stack, query_buf, previous_buf);
    success = cypherCmdStatus != PSQL_CMD_ERROR;
    if (cypherCmdStatus == PSQL_CMD_SEND) {
        success = SendQuery(convert_to_psql_command(query_buf->data));
    }
} else {
    success = SendQuery(query_buf->data);
}

3. 优化前缀匹配逻辑，降低误判率 #

若暂时无法接入解析器预检测，可细化前缀匹配规则，排除SQL专属场景：

• 针对CREATE等多用途关键词，进一步匹配后续语法特征（如Cypher中CREATE后紧跟括号，SQL中通常是CREATE TABLE等）。

示例优化后的匹配逻辑：

bool is_cypher_cmd = false;
const char* cmd = query_buf->data;
// 跳过开头空白字符
while (isspace((unsigned char)*cmd)) cmd++;

// 匹配MATCH开头的Cypher语句
if (pg_strncasecmp(cmd, "MATCH", 5) == 0 && isspace((unsigned char)cmd[5])) {
    is_cypher_cmd = true;
}
// 匹配OPTIONAL MATCH
else if (pg_strncasecmp(cmd, "OPTIONAL MATCH", 13) == 0 && isspace((unsigned char)cmd[13])) {
    is_cypher_cmd = true;
}
// 匹配EXPLAIN + Cypher语句
else if (pg_strncasecmp(cmd, "EXPLAIN", 7) == 0) {
    const char* explain_rest = cmd +7;
    while (isspace((unsigned char)*explain_rest)) explain_rest++;
    if (pg_strncasecmp(explain_rest, "MATCH",5)==0 || pg_strncasecmp(explain_rest, "CREATE",6)==0) {
        is_cypher_cmd = true;
    }
}
// 匹配CREATE + 节点/关系语法（Cypher专属）
else if (pg_strncasecmp(cmd, "CREATE",6)==0) {
    const char* create_rest = cmd +6;
    while (isspace((unsigned char)*create_rest)) create_rest++;
    if (*create_rest == '(') {
        is_cypher_cmd = true;
    }
}

if (is_cypher_cmd) {
    // 处理Cypher命令
} else {
    success = SendQuery(query_buf->data);
}

该方案能减少大部分误判，但仍无法完全覆盖极端场景（如SQL中自定义函数调用出现CREATE ( ... )格式）。

4. 错误回退兜底机制 #

将语句按Cypher发送执行后，若收到语法错误响应，自动回退为SQL重新执行：

• 捕获SendQuery返回的错误信息，判断是否为Cypher解析错误。
• 若是，则重新发送原语句作为SQL执行。

示例逻辑：

success = SendQuery(convert_to_psql_command(query_buf->data));
if (!success) {
    // 检查错误是否属于Cypher语法错误
    if (is_cypher_syntax_error(pset.db, pset.curError)) {
        // 回退为SQL执行
        success = SendQuery(query_buf->data);
    }
}

该方案可作为兜底，但会增加一次网络请求，用户体验存在延迟，且需精准识别错误类型。

总结 #

优先推荐显式元命令方案，逻辑简单可靠；若需自动检测，可结合解析器预检测+错误回退的组合方案，平衡用户体验与可靠性。

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