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 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538
/*! HTTP client, requests and responses. This module contains the HTTP client, as well as request and response types. # Request builders Some commonly used endpoints have high-level builder methods you can use to configure requests easily. They're exposed as methods on the `Client`: Client method | Elasticsearch API | Raw request type | Response type ------------------------------------------- | ---------------------------------- | ------------------------------------------------------- | ------------------------------------ [`search`][Client.search] | [Search][docs-search] | [`SearchRequest`][SearchRequest] | [`SearchResponse`][SearchResponse] [`get_document`][Client.get_document] | [Get Document][docs-get] | [`GetRequest`][GetRequest] | [`GetResponse`][GetResponse] [`index_document`][Client.index_document] | [Index Document][docs-index] | [`IndexRequest`][IndexRequest] | [`IndexResponse`][IndexResponse] [`put_mapping`][Client.put_mapping] | [Put Mapping][docs-mapping] | [`IndicesPutMappingRequest`][IndicesPutMappingRequest] | [`CommandResponse`][CommandResponse] [`create_index`][Client.create_index] | [Create Index][docs-create-index] | [`IndicesCreateRequest`][IndicesCreateRequest] | [`CommandResponse`][CommandResponse] All builders follow a standard pattern: - The `Client` method that takes all required parameters without inference - Optional or inferred parameters can be overridden in builder methods with inference - `send` will return a specific response type A search request for a value, where the response is matched for an `ApiError`: ```no_run # #[macro_use] extern crate json_str; # extern crate serde_json; # extern crate elastic; # use serde_json::Value; # use elastic::prelude::*; # use elastic::error::*; # fn main() { # let client = ClientBuilder::new().build().unwrap(); let response = client.search::<Value>() .index("myindex") .ty(Some("myty")) .body(json_str!({ query: { query_string: { query: "*" } } })) .send(); match response { Ok(response) => { // Iterate through the response hits for hit in response.hits() { println!("{:?}", hit); } }, Err(e) => { match *e.kind() { ErrorKind::Api(ref e) => { // handle a REST API error }, ref e => { // handle a HTTP or JSON error } } } } # } ``` The request builders are wrappers around the [`Client.request`][Client.request] method, taking a [raw request type][endpoints-mod]. A `get` request for a value: ```no_run # extern crate serde_json; # extern crate elastic; # use serde_json::Value; # use elastic::prelude::*; # fn main() { # let client = ClientBuilder::new().build().unwrap(); let response = client.get_document::<Value>(index("values"), id(1)).send(); # } ``` Is equivalent to: ```no_run # extern crate serde_json; # extern crate elastic; # use serde_json::Value; # use elastic::prelude::*; # fn main() { # let client = ClientBuilder::new().build().unwrap(); let response = client.request(GetRequest::for_index_ty_id("values", "value", 1)) .send() .and_then(into_response::<GetResponse<Value>>); # } ``` # Raw request types Not all endpoints have strongly-typed builders, but all Elasticsearch API endpoints have a specific [raw request type][endpoints-mod] that can be used to build a request manually and send with the [`Client.request`][Client.Request] method. The builders described above are just wrappers around these request types, but that doesn't mean raw requests are a second-class API. You have more control over how requests are serialised, sent and deserialised using the raw requests API. All request endpoints live in the [`endpoints`][endpoints-mod] module. The process of sending raw requests is described in more detail below. ## The raw request process The pieces involved in sending an Elasticsearch API request and parsing the response are modular. Each one exposes Rust traits you can implement to support your own logic but if you just want to send a search/get request and parse a search/get response then you won't need to worry about this so much. The basic flow from request to response is: **1)** Turn a concrete [request type][endpoints-mod] into a [`RequestBuilder`][RequestBuilder]: ```text [RequestType] ---> [Client.request()] ---> [RequestBuilder] ``` **2)** Send the [`RequestBuilder`][RequestBuilder] and get a [`ResponseBuilder`][ResponseBuilder]: ```text [RequestBuilder.send()] ---> [ResponseBuilder] ``` **3)** Parse the [`ResponseBuilder`][ResponseBuilder] to a [response type][response-types]: ```text [ResponseBuilder.response()] ---> [ResponseType] ``` The example below shows how these pieces fit together in code by sending a simple `SearchRequest`, with the steps in the above process labelled: ```no_run # extern crate elastic; # #[macro_use] # extern crate json_str; # extern crate serde_json; # use elastic::prelude::*; # use elastic::error::*; # use serde_json::Value; # fn main() { # let client = ClientBuilder::new().build().unwrap(); let req = SearchRequest::for_index("_all", empty_body()); let response = client.request(req) // 1 .send() // 2 .and_then(into_response::<SearchResponse<Value>>); // 3 # } ``` ### 1. Building raw requests The [`endpoints`][endpoints-mod] module contains code-generated request types for the Elasticsearch REST API. Each request type expects its parameters upfront and is generic over the request body. A raw search request: ```no_run # #[macro_use] extern crate json_str; # extern crate elastic; # use elastic::prelude::*; # fn main() { let req = { let body = json_str!({ query: { query_string: { query: "*" } } }); SearchRequest::for_index_ty("myindex", "myty", body) }; # } ``` A raw request to index a document: ```no_run # #[macro_use] extern crate serde_derive; # extern crate serde; # extern crate serde_json; # extern crate elastic; # use elastic::prelude::*; # #[derive(Serialize)] # struct MyType; # fn main() { # let doc = MyType; let req = { let body = serde_json::to_string(&doc).unwrap(); IndexRequest::for_index_ty_id("myindex", "myty", 1, body) }; # } ``` ### 2. Sending requests Both high-level request builders and raw requests have some common builder methods: - [`params`][RequestBuilder.params] for setting url query parameters - a `send` method for sending the request. For high-level requests this returns a strongly-typed response. For raw requests this returns a [`ResponseBuilder`][ResponseBuilder]. ```no_run # use elastic::prelude::*; # let client = ClientBuilder::new().build().unwrap(); # let req = PingRequest::new(); let request_builder = client.request(req); // Set additional url parameters let request_builder = request_builder.params(|p| p .url_param("pretty", true) .url_param("refresh", true) ); // Send the request let response = request_builder.send(); ``` ### 3. Parsing responses Call [`ResponseBuilder.into_response`][ResponseBuilder.into_response] on a sent request to get a [strongly typed response][response-types]: ```no_run # extern crate serde; # extern crate serde_json; # #[macro_use] extern crate serde_derive; # #[macro_use] extern crate elastic_derive; # extern crate elastic; # use serde_json::Value; # use elastic::prelude::*; # use elastic::error::*; # fn main() { # #[derive(Serialize, Deserialize, ElasticType)] # struct MyType { # pub id: i32, # pub title: String, # pub timestamp: Date<DefaultDateFormat> # } # let params = RequestParams::new("http://es_host:9200"); # let client = Client::new(params).unwrap(); # let req = PingRequest::new(); let response = client.request(req) .send() .and_then(into_response::<SearchResponse<Value>>); match response { Ok(response) => { // Iterate through the response hits for hit in response.hits() { println!("{:?}", hit); } }, Err(e) => { match *e.kind() { ErrorKind::Api(ref e) => { // handle a REST API error }, ref e => { // handle a HTTP or JSON error } } } } # } ``` Alternatively, call [`ResponseBuilder.into_raw`][ResponseBuilder.into_raw] on a sent request to get a raw [`HttpResponse`][HttpResponse]: ```no_run # extern crate serde; # #[macro_use] extern crate serde_derive; # #[macro_use] extern crate elastic_derive; # extern crate elastic; # use std::io::Read; # use elastic::prelude::*; # fn main() { # let params = RequestParams::new("http://es_host:9200"); # let client = Client::new(params).unwrap(); # let req = PingRequest::new(); let mut response = client.request(req) .send() .and_then(into_raw) .unwrap(); let mut body = String::new(); response.read_to_string(&mut body).unwrap(); # } ``` `HttpResponse` implements the standard `Read` trait so you can buffer out the raw response data. For more details see the [`responses`][responses-mod] module. [docs-search]: http://www.elastic.co/guide/en/elasticsearch/reference/current/search-search.html [docs-get]: http://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html [docs-index]: https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-index_.html [docs-mapping]: https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping.html [docs-create-index]: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-create-index.html [endpoints-mod]: requests/endpoints/index.html [RequestParams]: struct.RequestParams.html [Client.request]: struct.Client.html#method.request [Client.search]: struct.Client.html#method.search [Client.get_document]: struct.Client.html#method.get_document [Client.index_document]: struct.Client.html#method.index_document [Client.put_mapping]: struct.Client.html#method.put_mapping [Client.create_index]: struct.Client.html#method.create_index [RequestBuilder]: requests/struct.RequestBuilder.html [RequestBuilder.params]: requests/struct.RequestBuilder.html#method.params [SearchRequest]: requests/endpoints/struct.SearchRequest.html [GetRequest]: requests/endpoints/struct.GetRequest.html [IndexRequest]: requests/endpoints/struct.IndexRequest.html [IndicesPutMappingRequest]: requests/endpoints/struct.IndicesPutMappingRequest.html [IndicesCreateRequest]: requests/endpoints/struct.IndicesCreateRequest.html [responses-mod]: responses/index.html [ResponseBuilder]: responses/struct.ResponseBuilder.html [ResponseBuilder.into_response]: responses/struct.ResponseBuilder.html#method.into_response [ResponseBuilder.into_raw]: responses/struct.ResponseBuilder.html#method.into_raw [SearchResponse]: responses/type.SearchResponse.html [GetResponse]: responses/type.GetResponse.html [IndexResponse]: responses/struct.IndexResponse.html [CommandResponse]: responses/struct.CommandResponse.html [HttpResponse]: responses/struct.HttpResponse.html [response-types]: responses/parse/trait.IsOk.html#implementors */ pub mod requests; pub mod responses; use serde::de::DeserializeOwned; use reqwest::{Client as HttpClient, Response as RawResponse}; use error::*; use self::responses::ResponseBuilder; use self::responses::HttpResponse; use self::responses::parse::IsOk; pub use elastic_reqwest::RequestParams; /** A builder for a client. */ pub struct ClientBuilder { http: Option<HttpClient>, params: RequestParams } impl ClientBuilder { /** Create a new client builder. By default, a client constructed by this builder will: - Send requests to `localhost:9200` - Not use any authentication - Not use TLS */ pub fn new() -> Self { ClientBuilder { http: None, params: RequestParams::default() } } /** Set the base url. The url must be fully qualified. This method is a convenient alternative to using `params` to specify the `base_url`. # Examples Specify a base url for the client to send requests to. In this case, the base url is HTTPS, and not on the root path: ``` # use elastic::prelude::*; let builder = ClientBuilder::new() .base_url("https://my_es_cluster/some_path"); ``` */ pub fn base_url<I>(mut self, base_url: I) -> Self where I: Into<String> { self.params = self.params.base_url(base_url); self } /** Specify default request parameters. # Examples Require all responses use pretty-printing: ``` # use elastic::prelude::*; let builder = ClientBuilder::new() .params(|params| params.url_param("pretty", true)); ``` Add an authorization header: ``` # use elastic::prelude::*; use elastic::http::header::Authorization; let builder = ClientBuilder::new() .params(|params| params.header(Authorization("let me in".to_owned()))); ``` Specify a base url (prefer the [`base_url`][ClientBuilder.base_url] method on `ClientBuilder` instead): ``` # use elastic::prelude::*; let builder = ClientBuilder::new() .params(|params| params.base_url("https://my_es_cluster/some_path")); ``` [ClientBuilder.base_url]: #method.base_url */ pub fn params<F>(mut self, builder: F) -> Self where F: Fn(RequestParams) -> RequestParams { self.params = builder(self.params); self } /** Use the given `reqwest::Client` for sending requests. */ pub fn http_client(mut self, client: HttpClient) -> Self { self.http = Some(client); self } /** Construct a [`Client`][Client] from this builder. [Client]: struct.Client.html */ pub fn build(self) -> Result<Client> { if let Some(http) = self.http { Ok(Client { http: http, params: self.params }) } else { Client::new(self.params) } } } /** A HTTP client for the Elasticsearch REST API. The `Client` is a structure that lets you create and send [`RequestBuilder`][RequestBuilder]s. It's mostly a thin wrapper over a `reqwest::Client` and is re-usable. # Examples Create a `Client` for an Elasticsearch node at `es_host:9200`: ```no_run # use elastic::prelude::*; let params = RequestParams::new("http://es_host:9200").url_param("pretty", true); let client = Client::new(params).unwrap(); [RequestBuilder]: requests/index.html ``` */ pub struct Client { http: HttpClient, params: RequestParams, } impl Client { /** Create a new client for the given parameters. The parameters given here are used as the defaults for any request made by this client, but can be overriden on a per-request basis. This method can return a `HttpError` if the underlying `reqwest::Client` fails to create. # Examples Create a `Client` with default parameters: ``` # use elastic::prelude::*; let client = ClientBuilder::new().build().unwrap(); ``` Create a `Client` for a specific node: ``` # use elastic::prelude::*; let client = Client::new(RequestParams::new("http://eshost:9200")).unwrap(); ``` See [`RequestParams`][RequestParams] for more configuration options. [RequestParams]: struct.RequestParams.html */ pub fn new(params: RequestParams) -> Result<Self> { let client = HttpClient::new()?; Ok(Client { http: client, params: params, }) } } /** Try convert a `ResponseBuilder` into a concrete response type. */ pub fn into_response<T>(res: ResponseBuilder) -> Result<T> where T: IsOk + DeserializeOwned { res.into_response() } /** Try convert a `ResponseBuilder` into a raw http response. */ pub fn into_raw(res: ResponseBuilder) -> Result<HttpResponse> { Ok(res.into_raw()) } /** A type that can be converted into a `ResponseBuilder` without being exposed publicly. */ struct IntoResponseBuilder(RawResponse);