lucene - 在启动我想要运行的完整 XQuery 之前，如何验证嵌入在较大 XQuery 中的 Lucene 查询不包含语法错误？

Question

我有一个应用程序，我需要允许用户对文档执行全文搜索，并使用 Lucene Query Parser syntax如果需要的话。 eXist 数据库是从使用 eulexistdb 的 Django 后端查询的。与 eXist 交谈。

问题在于，当用户使用不正确的语法进行全文搜索时，我们会在游戏后期才发现这一点。 Django 应用程序必须查询 SQL 数据库以确定搜索的某些参数。当构建完整的 XQuery 并访问 eXist 时，SQL 查询已经运行，这意味着 SQL 查询的成本已经花费了。 (我知道我可以将 SQL 端查询的数据编码到 eXist 中，以便只查询 eXist。目前这不是一个选项。)

我想提前知道 Lucene 查询是否存在语法错误，这样我就可以避免开始毫无意义地查询 SQL 数据库。

我已经检查了 eXist 的文档，但我没有在 API 中找到任何内容，这将是一个检查全文查询在语法上是否有效的简单函数。

Answer 1

这是一个简单的函数，它将返回 True如果 Lucene 查询没问题，或者 False如果查询中存在语法错误。 db必须是 eulexistdb.db.ExistDB 的实例和query是 Lucene 查询:

def check(db, query):
    try:
        db.query(safe_interpolate("ft:query(<doc/>, {lucene_query})",
                                   lucene_query=query))
    except ExistDBException as ex:
        if ex.message().startswith(
                "exerr:ERROR Syntax error in Lucene query string"):
            return False

        raise ex # Don't swallow other problems that may occur.

    return True

这应该适用于任何有提供对 eXist 访问的库的语言。这个想法是针对虚假文档( <doc/> )运行感兴趣的查询。使用伪造文档可以避免实际搜索数据库。 (空节点序列可能看起来更好，但我们不会针对空节点序列运行 ft:query，因为这样 XQuery 优化器可以跳过尝试解析和运行 Lucene 查询，因为对空序列的有效查询必然会返回空序列，无论实际的 Lucene 查询如何。)它是否返回任何结果并不重要。如果查询没有错误，那么就不会出现异常。如果查询有语法错误，则会引发异常。我还没有找到比检查异常存储的错误消息来检测它是 Lucene 语法错误还是其他错误更可靠的方法。

(safe_interpolate 函数应该对 lucene_query 进行插值以避免注入(inject)。您可以决定应用程序中需要什么。)