34 个版本

使用旧 Rust 2015

0.21.0-pre.42019年4月23日
0.21.0-pre.22019年2月23日
0.20.10 2018年5月7日
0.20.9 2018年2月6日
0.7.0 2016年11月22日

#31 in #elastic


4 个 crate 中使用 (通过 elastic_types)

MIT/Apache

32KB
781

elastic 最新版本 Gitter

elastic 是一个高效的、模块化的 Elasticsearch API 客户端,用 Rust 编写。该 API 面向 Elastic Stack 7.x

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

快速参考

还可以查看官方的 elasticsearch crate!

稳定性

此 crate 仍然相当不稳定,预计在不久的将来将继续发布破坏性版本,变更日志不够详细。

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

构建状态

平台 频道 状态 (master)
Linux / macOS 稳定/夜间 Build Status
Windows 夜间 Build status

文档

版本 文档
当前 (master) Documentation

示例

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 (https://127.0.0.1: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了。

有关详细信息,请参阅文档

替代方案

elastic.co 发布了官方客户端elasticsearch。虽然它目前还处于alpha阶段(截至2020-02-10),但它非常全面,并且大部分代码都是从官方REST API规范中生成的。

此外,如果您想使用强类型Query DSL构建器,请参阅rs-es。这个客户端为您提供了与Elasticsearch交互的Rust API,并且让您在编译时而不是运行时知道查询是否可以解析。

目标

为了提供基于异步io的完整功能和高效的Elasticsearch客户端,Rust为我们提供了许多构建超级高性能但易于使用的库的工具,这是我们希望继续的目标。elastic的目标是为那些需要与Elasticsearch一起工作且正在考虑使用Rust的人,以及已经在使用Rust的用户。我们希望提供一个解决方案,让Elasticsearch与Rust生态系统内外都具有吸引力。

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

本项目核心关注点是在Elasticsearch的文档类型和查询响应上实现强类型,而不是试图映射整个Query DSL。

根据需要,支持Elastic的插件产品,如watchergraph,可以作为功能模块添加。

许可

根据以下任一许可证

依赖项

~4.5MB
~93K SLoC