1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370
//! Official Rust client for [Elasticsearch](https://www.elastic.co/products/elasticsearch) //! //! `Elasticsearch` is an official Rust client for Elasticsearch, providing an efficient asynchronous //! client for all stable Elasticsearch APIs that's easy to use. //! //! # Versions and Compatibility //! //! | Rust client | Elasticsearch | //! |-------------|---------------| //! | 7.x | 7.x | //! //! A major version of the client is compatible with the same major version of Elasticsearch. //! Since Elasticsearch is developed following [Semantic Versioning](https://semver.org/) 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, //! //! - A `7.5.0` client can be used against `7.0.0` Elasticsearch //! - A `7.4.0` client can be used against `7.5.1` Elasticsearch //! //! In 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.4.0 client won't contain API functions for APIs that are introduced in //! Elasticsearch 7.5.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. //! //! # Features //! //! The following are a list of Cargo features that can be enabled or disabled: //! //! - **native-tls** *(enabled by default)*: Enables TLS functionality provided by `native-tls`. //! - **rustls-tls**: Enables TLS functionality provided by `rustls`. //! //! # Getting started //! //! Add the `elasticsearch` crate and version to Cargo.toml. Choose the version that is compatible with //! the version of Elasticsearch you're using //! //! ```toml,no_run //! [dependencies] //! elasticsearch = "7.6.1-alpha.1" //! ``` //! The following _optional_ dependencies may also be useful to create requests and read responses //! //! ```toml,no_run //! serde = "~1" //! serde_json = "~1" //! ``` //! ## Create a client //! //! To create a client to make API calls to Elasticsearch running on `http://localhost:9200` //! //! ```rust,no_run //! # use elasticsearch::{Error, Elasticsearch}; //! # fn run() { //! let client = Elasticsearch::default(); //! # } //! ``` //! Alternatively, you can create a client to make API calls against Elasticsearch running on a //! specific [url::Url] //! //! ```rust,no_run //! # use elasticsearch::{ //! # Error, Elasticsearch, //! # http::transport::{Transport, SingleNodeConnectionPool} //! # }; //! # fn run() -> 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](https://www.elastic.co/cloud/), //! a client can be created using a [Cloud ID](https://www.elastic.co/guide/en/cloud/current/ec-cloud-id.html) //! and credentials retrieved from the Cloud web console //! //! ```rust,no_run //! # use elasticsearch::{ //! # auth::Credentials, //! # Error, Elasticsearch, //! # http::transport::Transport, //! # }; //! # use url::Url; //! # fn run() -> Result<(), Error> { //! let cloud_id = "cluster_name:Y2xvdWQtZW5kcG9pbnQuZXhhbXBsZSQzZGFkZjgyM2YwNTM4ODQ5N2VhNjg0MjM2ZDkxOGExYQ=="; //! let credentials = Credentials::Basic("<username>".into(), "<password>".into()); //! let transport = Transport::cloud(cloud_id, credentials)?; //! let client = Elasticsearch::new(transport); //! # Ok(()) //! # } //! ``` //! //! More control over how a [Transport](http::transport::Transport) is built can be //! achieved using [TransportBuilder](http::transport::TransportBuilder) to build a transport, and //! passing it to [Elasticsearch::new] create a new instance of [Elasticsearch] //! //! ```rust,no_run //! # use elasticsearch::{ //! # auth::Credentials, //! # Error, Elasticsearch, //! # http::transport::{TransportBuilder,SingleNodeConnectionPool}, //! # }; //! # use url::Url; //! # fn run() -> Result<(), Error> { //! let url = Url::parse("https://example.com")?; //! let conn_pool = SingleNodeConnectionPool::new(url); //! let transport = TransportBuilder::new(conn_pool).disable_proxy().build()?; //! let client = Elasticsearch::new(transport); //! # Ok(()) //! # } //! ``` //! //! ## Making API calls //! //! The client exposes all stable Elasticsearch APIs, either on the root [Elasticsearch] client, //! or on a _namespace_ client that groups related APIs, such as [Cat](cat::Cat), which groups the //! Cat related APIs. All API functions are `async` and can be `await`ed. //! //! The following makes an API call to the cat indices API //! //! ```rust,no_run //! # use elasticsearch; //! # use elasticsearch::{Elasticsearch, Error, cat::CatIndicesParts}; //! # use url::Url; //! # use elasticsearch::auth::Credentials; //! # use serde_json::{json, Value}; //! # async fn run() -> Result<(), Error> { //! # let client = Elasticsearch::default(); //! let response = client //! .cat() //! .indices(CatIndicesParts::Index(&["*"])) //! .send() //! .await?; //! //! let response_body = response.read_body::<Value>().await?; //! for record in response_body.as_array().unwrap() { //! // print the name of each index //! println!("{}", record["index"].as_str().unwrap()); //! } //! # Ok(()) //! # } //! ``` //! For APIs that contain parts of the Url path to be provided by the consumer, the Url path //! variants are modelled as an `enum`, such as [CatIndicesParts](cat::CatIndicesParts) in the above example, which models //! the variants of the [CatIndices](cat::CatIndices) API. //! //! ### Indexing //! //! Indexing a single document can be achieved with the index API //! //! ```rust,no_run //! # use elasticsearch; //! # use elasticsearch::{Elasticsearch, Error, SearchParts, IndexParts}; //! # use url::Url; //! # use elasticsearch::auth::Credentials; //! # use serde_json::{json, Value}; //! # async fn run() -> Result<(), Error> { //! # let client = Elasticsearch::default(); //! let response = client //! .index(IndexParts::IndexId("tweets", "1")) //! .body(json!({ //! "id": 1, //! "user": "kimchy", //! "post_date": "2009-11-15T00:00:00Z", //! "message": "Trying out Elasticsearch, so far so good?" //! })) //! .send() //! .await?; //! //! let successful = response.status_code().is_success(); //! # Ok(()) //! # } //! ``` //! //! For indexing multiple documents, the bulk API is a better option, allowing multiple operations //! to be sent in one API call //! //! ```rust,no_run //! # use elasticsearch; //! # use elasticsearch::{Elasticsearch, Error, IndexParts, BulkParts, http::request::JsonBody}; //! # use url::Url; //! # use elasticsearch::auth::Credentials; //! # use serde_json::{json, Value}; //! # async fn run() -> Result<(), Error> { //! # let client = Elasticsearch::default(); //! let mut body: Vec<JsonBody<_>> = Vec::with_capacity(4); //! //! // add the first operation and document //! body.push(json!({"index": {"_id": "1"}}).into()); //! body.push(json!({ //! "id": 1, //! "user": "kimchy", //! "post_date": "2009-11-15T00:00:00Z", //! "message": "Trying out Elasticsearch, so far so good?" //! }).into()); //! //! // add the second operation and document //! body.push(json!({"index": {"_id": "2"}}).into()); //! body.push(json!({ //! "id": 2, //! "user": "forloop", //! "post_date": "2020-01-08T00:00:00Z", //! "message": "Bulk indexing with the rust client, yeah!" //! }).into()); //! //! let response = client //! .bulk(BulkParts::Index("tweets")) //! .body(body) //! .send() //! .await?; //! //! let response_body = response.read_body::<Value>().await?; //! let successful = response_body["errors"].as_bool().unwrap() == false; //! # Ok(()) //! # } //! ``` //! ### Searching //! //! The following makes an API call to `tweets/_search` with the json body //! `{"query":{"match":{"message":"Elasticsearch"}}}` //! //! ```rust,no_run //! # use elasticsearch; //! # use elasticsearch::{Elasticsearch, Error, SearchParts}; //! # use url::Url; //! # use elasticsearch::auth::Credentials; //! # use serde_json::{json, Value}; //! # async fn run() -> Result<(), Error> { //! # let client = Elasticsearch::default(); //! let response = client //! .search(SearchParts::Index(&["tweets"])) //! .from(0) //! .size(10) //! .body(json!({ //! "query": { //! "match": { //! "message": "Elasticsearch rust" //! } //! } //! })) //! .send() //! .await?; //! //! let response_body = response.read_body::<Value>().await?; //! let took = response_body["took"].as_i64().unwrap(); //! for hit in response_body["hits"]["hits"].as_array().unwrap() { //! // print the source document //! println!("{:?}", hit["_source"]); //! } //! # Ok(()) //! # } //! ``` //! //! ## Request bodies //! //! For APIs that expect JSON, the `body` associated function of the API constrains the input //! to a type that implements [serde::Serialize] trait. An example of this was the indexing a single //! document example above. //! //! Some APIs expect newline delimited JSON //! (NDJSON) however, so the `body` associated for these APIs constrain the input to a vector of //! types that implement [Body](http::request::Body) trait. An example of this was the bulk indexing multiple documents //! above. //! //! The [Body](http::request::Body) trait represents the body of an API call, allowing for different body implementations. //! As well as those to represent JSON and NDJSON, a few other types also have implementations for //! [Body](http::request::Body), such as byte slice. Whilst these can't be passed to the API functions directly, //! [Elasticsearch::send] can be used //! //! ```rust,no_run //! # use elasticsearch; //! # use elasticsearch::{Elasticsearch, Error, SearchParts}; //! # use url::Url; //! # use elasticsearch::auth::Credentials; //! # use serde_json::{json, Value}; //! # use http::HeaderMap; //! # use elasticsearch::http::Method; //! # async fn run() -> Result<(), Error> { //! # let client = Elasticsearch::default(); //! let body = b"{\"query\":{\"match_all\":{}}}"; //! //! let response = client //! .send(Method::Post, //! SearchParts::Index(&["tweets"]).url().as_ref(), //! HeaderMap::new(), //! Option::<&Value>::None, //! Some(body.as_ref()) //! ) //! .await?; //! //! # Ok(()) //! # } //! ``` // TODO: turn on before releasing :) Will require adding documentation within all REST API specs // #![deny(missing_docs)] // also test examples in README #![feature(external_doc)] #[doc(include = "../../README.md")] #[cfg(doctest)] type _DoctestReadme = (); #[macro_use] extern crate dyn_clone; pub mod auth; pub mod cat; pub mod ccr; pub mod cert; pub mod cluster; pub mod enrich; pub mod graph; pub mod http; pub mod ilm; pub mod indices; pub mod ingest; pub mod license; pub mod migration; pub mod ml; pub mod nodes; pub mod params; pub mod security; pub mod slm; pub mod snapshot; pub mod sql; pub mod ssl; pub mod tasks; pub mod watcher; pub mod xpack; mod client; mod error; mod generated; mod root; // exposes types within modules at the library root level pub use crate::{client::*, error::*, http::transport::DEFAULT_ADDRESS, root::*}; #[cfg(test)] pub mod tests { use crate::SearchParts; #[test] fn build_search_on_all_indices_and_types() { let parts = SearchParts::None; let url = parts.url(); assert_eq!(url, "/_search"); } #[test] fn build_search_on_selected_indices() { let parts = SearchParts::Index(&["index-1", "index-2"]); let url = parts.url(); assert_eq!(url, "/index-1,index-2/_search"); } #[test] fn build_search_on_selected_indices_and_types() { let parts = SearchParts::IndexType(&["index-1", "index-2"], &["type-1", "type-2"]); let url = parts.url(); assert_eq!(url, "/index-1,index-2/type-1,type-2/_search"); } }