SiKuLa

Simple Query Language - [ˈziːˈkuːˈlaː']

原理

另一个查询语言，你认真吗？

实际上它并不算新。但是将其命名为“类似于 GitHub 搜索语法的查询语言”（QLSTGHSS）并不是一个真正的选择。

更可以说它是一个熟悉语法的实现。

那么区别在哪里呢？

它们很微妙。但我不想破坏惊喜。或者也许我只是太懒于编写文档。🤷

示例

假设你定义了一个用于搜索电子邮件的枚举

use sikula::prelude::*;

#[derive(Search, Clone, Debug, PartialEq, Eq)]
enum DeriveResource<'a> {
    /// Standard qualifier: `author:someone`
    #[search(sort, scope)]
    Author(&'a str),
    /// Default primary: `warranty`
    #[search(default)]
    Subject(Primary<'a>),
    /// Non-default primary: `warranty in:message`, to search in both: `warranty in:message in:subject`
    #[search(scope)]
    Message(Primary<'a>),

    /// Predicate: `is:read`
    Read,

    /// Numeric qualifier example:
    /// * `size:100` (equals)
    /// * `size:>=100` (size greater than or equals 100)
    /// * `size:100..200` (size between 100 inclusive and 200 exclusive)
    /// * `size:*..200` (size up to 200 exclusive)
    #[search(sort)]
    Size(Ordered<usize>),

    #[search(sort)]
    Sent(Ordered<time::OffsetDateTime>),

    Label(Qualified<'a, &'a str>),
}

Query derive 提供了特质实现。`#[query(scope)]` 属性将 Subject 变量标记为 Body 范围的主搜索词，如果没有选择则默认为 Subject。

一般来说，有三种类型的术语：主术语、限定词、谓词。谓词是简单的“这个条件是否为真”风格的过滤器。如果一个枚举变量没有值，则它是一个谓词。

限定词是额外的匹配标准，这取决于值的类型。

使用 `#[query(sort)]` 标志，一个字段可以用于排序结果。

现在，你可以执行以下查询

要测试上述资源的更多示例，您可以运行 cli 示例

cargo run --example cli --features time -- -is:read AND foo

这将为您提供解析查询的结构化输出

Input: '-is:read AND foo'
Query {
    terms: And(
        [
            Not(
                Match(
                    Read,
                ),
            ),
            Match(
                Subject(
                    Partial(
                        "foo",
                    ),
                ),
            ),
        ],
    ),
    sorting: [],
}