Official Rust Client for Elasticsearch.
Full documentation is available at https://docs.rs/elasticsearch
The project is still very much a work in progress and in an alpha state; input and contributions welcome!
| Rust client | Elasticsearch | Status | |-------------|---------------|--------| | 7.x | 7.x | alpha |
A major version of the client is compatible with the same major version of Elasticsearch. Since Elasticsearch is developed following Semantic Versioning principles, Any minor/patch version of the client can be used against any minor/patch version of Elasticsearch within the same major version lineage. For example,
7.5.0 client can be used against 7.0.0 Elasticsearch7.5.0 client can be used against 7.6.0 ElasticsearchIn the former case, a 7.5.0 client may contain additional API functions that are not available in 7.0.0 Elasticsearch. In this case, these APIs cannot be used, but for any APIs available in Elasticsearch, the respective API functions on the client will be compatible.
In the latter case, a 7.5.0 client won't contain API functions for APIs that are introduced in Elasticsearch 7.6.0+, but for all other APIs available in Elasticsearch, the respective API functions on the client will be compatible.
No compatibility assurances are given between different major versions of the client and Elasticsearch. Major differences likely exist between major versions of Elasticsearch, particularly around request and response object formats, but also around API urls and behaviour.
The following are a list of Cargo features that can be enabled or disabled:
native-tls.rustls.beta-apis.The client exposes all Elasticsearch APIs as associated functions, either on
the root client, Elasticsearch, or on one of the namespaced clients, such as Cat, Indices, etc. The namespaced clients
are based on the grouping of APIs within the Elasticsearch and X-Pack REST API specs from which much of the client is generated.
All API functions are async only, and can be awaited.
Add elasticsearch crate and version to Cargo.toml. Choose the version
that is compatible with the version of Elasticsearch you're using
toml
[dependencies]
elasticsearch = "7.17.7-alpha.1"
The following optional dependencies may also be useful to create requests and read responses
toml
serde = "~1"
serde_json = "~1"
The client uses reqwest to make HTTP calls, which internally uses
the tokio runtime for async support. As such, you may require to take a dependency on tokio
in order to use the client. For example, in Cargo.toml, you may need the following dependency,
toml
tokio = { version = "*", features = ["full"] }
and to attribute async main function with #[tokio::main]
```rust,no_run
async fn main() -> Result<(), Box
and attribute test functions with #[tokio::test]
```rust,no_run
async fn my_test() -> Result<(), Box
Build a transport to make API requests to Elasticsearch using the TransportBuilder,
which allows setting of proxies, authentication schemes, certificate validation, and
other transport related settings.
To create a client to make API calls to Elasticsearch running on http://localhost:9200
```rust,no_run use elasticsearch::Elasticsearch;
fn main() { let client = Elasticsearch::default(); } ``` Alternatively, you can create a client to make API calls against Elasticsearch running on a specific url
```rust,no_run use elasticsearch::{ Elasticsearch, Error, http::transport::Transport };
fn main() -> Result<(), Error> { let transport = Transport::single_node("https://example.com")?; let client = Elasticsearch::new(transport); Ok(()) } ```
If you're running against an Elasticsearch deployment in Elastic Cloud, a client can be created using a Cloud ID and credentials retrieved from the Cloud web console
```rust,no_run use elasticsearch::{ auth::Credentials, Elasticsearch, Error, http::transport::Transport, };
fn main() -> Result<(), Error> {
let cloudid = "clustername:Y2xvdWQtZW5kcG9pbnQuZXhhbXBsZSQzZGFkZjgyM2YwNTM4ODQ5N2VhNjg0MjM2ZDkxOGExYQ==";
// can use other types of Credentials too, like Bearer or ApiKey
let credentials = Credentials::Basic("
More control over how a Transport is built can be
achieved using TransportBuilder to build a transport, and
passing it to Elasticsearch::new() create a new instance of Elasticsearch
```rust,no_run use url::Url; use elasticsearch::{ Error, Elasticsearch, http::transport::{TransportBuilder,SingleNodeConnectionPool}, };
fn main() -> Result<(), Error> { let url = Url::parse("https://example.com")?; let connpool = SingleNodeConnectionPool::new(url); let transport = TransportBuilder::new(connpool).disable_proxy().build()?; let client = Elasticsearch::new(transport); Ok(()) } ```
The following will execute a POST request to /_search?allow_no_indices=true with
a JSON body of {"query":{"match_all":{}}}
```rust,norun use elasticsearch::{Elasticsearch, Error, SearchParts}; use serdejson::{json, Value};
async fn main() -> Result<(), Box
// make a search API call
let search_response = client
.search(SearchParts::None)
.body(json!({
"query": {
"match_all": {}
}
}))
.allow_no_indices(true)
.send()
.await?;
// get the HTTP response status code
let status_code = search_response.status_code();
// read the response body. Consumes search_response
let response_body = search_response.json::<Value>().await?;
// read fields from the response body
let took = response_body["took"].as_i64().unwrap();
Ok(())
} ```
The client provides functions on each API builder struct for all query string parameters available for that API. APIs with multiple URI path variants, where some can contain parts parameters, are modelled as enums.
Elasticsearch also has an async send function on the root that allows sending an
API call to an endpoint not represented as an API function, for example, experimental
and beta APIs
```rust,norun use elasticsearch::{http::Method, Elasticsearch, Error, SearchParts}; use http::HeaderMap; use serdejson::Value;
async fn main() -> Result<(), Box
This is free software, licensed under The Apache License Version 2.0..