elastic

elastic 是一个高效、模块化的针对 Elasticsearch 的 Rust API客户端。API针对Elastic Stack 7.x。

elastic 提供强类型文档和弱类型查询。

快速参考

• 简单示例
• 示例应用程序

稳定性

这个crate仍然非常不稳定，并且在未来一段时间内可能会继续发布破坏性版本，变更日志不太详细。

如果您在自己的开源项目中遇到升级问题，请随时 提出问题，我们将提供帮助。我们的目标是最终提供稳定的API。

构建状态

平台	通道	状态 (master)
Linux / OSX	稳定/夜间
Windows	夜间

文档

版本	文档
当前 (master)

示例

将 elastic 添加到您的 Cargo.toml

[dependencies]
elastic = "0.21.0-pre.5"
elastic_derive = "0.21.0-pre.5"
serde_json = "1"

创建一个 SyncClient 并开始发送请求

#[macro_use]
extern crate elastic_derive;
#[macro_use]
extern crate serde_json;
extern crate elastic;

use serde_json::Value;
use elastic::prelude::*;

// A reqwest HTTP client and default parameters.
// The builder includes the base node url (http://localhost:9200).
let client = SyncClient::builder().build()?;

let query = "some query string";

// A search request with a freeform body.
let res = client.search::<Value>()
                .index("_all")
                .body(json!({
                    "query": {
                        "query_string": {
                            "query": query
                        }
                    }
                }))
                .send()?;

// Iterate through the hits in the response.
for hit in res.hits() {
    println!("{:?}", hit);
}

elastic 还提供了一个用于与 tokio 异步io堆栈一起使用的 AsyncClient。请参阅 示例 文件夹以获取完整的示例。

构建文档

文档映射是在编译时从您的 传统Rust结构 中派生的。只需添加 #[derive(ElasticType)] 属性

#[derive(ElasticType, Serialize, Deserialize)]
struct MyDocument {
	#[elastic(id)]
	pub id: String,
	pub title: String,
	pub timestamp: Date<DefaultDateMapping<EpochMillis>>,
	pub content: Text<DefaultTextMapping>,
}

然后您可以在 Client 请求方法中使用 MyDocument。

有关详细信息，请参阅 文档。

替代方案

如果您想使用强类型化的查询 DSL 构建器，请参阅 rs-es。此客户端负责提供用于与 Elasticsearch 交互的惯用 Rust API。它的优点是允许您在编译时而不是运行时知道查询将被解析。

目标

为了提供一个功能齐全且高效的异步 io Rust Elasticsearch 客户端。Rust 为我们提供了许多构建超级性能但高度可访问库的工具，这是我们希望继续的目标。 elastic 旨在为需要与 Elasticsearch 合作并考虑使用 Rust 的人以及已经在使用 Rust 的用户提供解决方案。我们希望提供一个既能从 Rust 生态系统内部又能从外部与 Elasticsearch 交互的解决方案。

REST API 由简单的内联 JSON 宏（如 serde_json 的 json!）处理，因此始终可以构建任何查询。这意味着您不需要学习另一个与 Elasticsearch 交互的 API；在 Dev Tools 中模拟的查询可以直接复制粘贴到您的 Rust 源代码中。

此项目的核心重点是 Elasticsearch 中的文档类型和查询响应的强类型，而不是尝试映射整个 Query DSL。

根据需要，可以将支持 Elastic 的插件产品（如 watcher 和 graph）作为功能门控模块添加。

许可

以下任一许可下授权

• Apache License，版本 2.0（《LICENSE-APACHE》或 http://apache.org/licenses/LICENSE-2.0》）
• MIT 许可证（《LICENSE-MIT》或 http://opensource.org/licenses/MIT》）