Struct rs_es::Client

pub struct Client { /* fields omitted */ }

The core of the ElasticSearch client, owns a HTTP connection.

Each instance of Client is reusable, but only one thread can use each one at once. This will be enforced by the borrow-checker as most methods are defined on &mut self.

To create a Client, the URL needs to be specified.

Each ElasticSearch API operation is defined as a method on Client. Any compulsory parameters must be given as arguments to this method. It returns an operation builder that can be used to add any optional parameters.

Finally send is called to submit the operation:

Examples

use rs_es::Client;

let mut client = Client::init("http://localhost:9200");

See the specific operations and their builder objects for details.

Methods

impl Client

pub fn analyze<'a>(&'a mut self, body: &'a str) -> AnalyzeOperation

Analyze

See: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-analyze.html

impl Client

pub fn bulk<'a, 'b, S>(
    &'a mut self,
    actions: &'b [Action<S>]
) -> BulkOperation<'a, 'b, S> where
    S: Serialize, 

Bulk

See: https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-bulk.html

impl Client

pub fn delete<'a>(
    &'a mut self,
    index: &'a str,
    doc_type: &'a str,
    id: &'a str
) -> DeleteOperation

Delete by ID

See: https://www.elastic.co/guide/en/elasticsearch/reference/1.x/docs-delete.html

impl Client

pub fn delete_index<'a>(
    &'a mut self,
    index: &'a str
) -> Result<GenericResult, EsError>

Delete given index

TODO: ensure all options are supported, replace with a DeleteIndexOperation to follow the pattern defined elsewhere.

See: https://www.elastic.co/guide/en/elasticsearch/reference/2.x/indices-delete-index.html

impl Client

pub fn get<'a>(&'a mut self, index: &'a str, id: &'a str) -> GetOperation

Implementation of the ES GET API

See: https://www.elastic.co/guide/en/elasticsearch/reference/1.x/docs-get.html

impl Client

pub fn index<'a, 'b, E: Serialize>(
    &'a mut self,
    index: &'b str,
    doc_type: &'b str
) -> IndexOperation<'a, 'b, E>

An index operation to index a document in the specified index.

See: https://www.elastic.co/guide/en/elasticsearch/reference/1.x/docs-index_.html

impl Client

pub fn open_index<'a>(
    &'a mut self,
    index: &'a str
) -> Result<GenericResult, EsError>

Open the index, making it available.

pub fn close_index<'a>(
    &'a mut self,
    index: &'a str
) -> Result<GenericResult, EsError>

Close the index, making it unavailable and modifiable.

pub fn wait_for_status<'a>(
    &'a mut self,
    status: &'a str,
    timeout: &'a str
) -> Result<(), EsError>

TODO: Return proper health data from https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-health.html

impl Client

pub fn refresh(&mut self) -> RefreshOperation

Refresh

See: https://www.elastic.co/guide/en/elasticsearch/reference/1.x/indices-refresh.html

impl Client

pub fn count_uri(&mut self) -> CountURIOperation

Count via the query parameter

See: https://www.elastic.co/guide/en/elasticsearch/reference/1.x/search-uri-request.html

pub fn count_query(&mut self) -> CountQueryOperation

Count via the query DSL

See: https://www.elastic.co/guide/en/elasticsearch/reference/1.x/search-request-body.html

impl Client

pub fn search_uri(&mut self) -> SearchURIOperation

Search via the query parameter

See: https://www.elastic.co/guide/en/elasticsearch/reference/1.x/search-uri-request.html

pub fn search_query(&mut self) -> SearchQueryOperation

Search via the query DSL

See: https://www.elastic.co/guide/en/elasticsearch/reference/1.x/search-request-body.html

impl Client

pub fn version(&mut self) -> VersionOperation

Calls the base ES path, returning the version number

impl Client

pub fn init(url_s: &str) -> Result<Client, UrlError>

Create a new client

pub fn init_with_timeout(
    url_s: &str,
    timeout: Option<Duration>
) -> Result<Client, UrlError>

pub fn full_url(&self, suffix: &str) -> Url

Take a nearly complete ElasticSearch URL, and stick the URL on the front.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.