API Documentation¶

Note

All the API calls map the raw REST api as closely as possible, including the distinction between required and optional arguments to the calls. This means that the code makes distinction between positional and keyword arguments; we, however, recommend that people use keyword arguments for all calls for consistency and safety.

Note

for compatibility with the Python ecosystem we use from_ instead of from and doc_type instead of type as parameter names.

Elasticsearch¶

class elasticsearch.Elasticsearch(hosts=None, transport_class=<class 'elasticsearch.transport.Transport'>, **kwargs)¶

Elasticsearch low-level client. Provides a straightforward mapping from Python to ES REST endpoints.

The instance has attributes indices and cluster that provide access to IndicesClient and ClusterClient instances respectively.

Parameters:

hosts – list of nodes we should connect to. Node should be a dictionary ({“host”: “localhost”, “port”: 9200}), the entire dictionary will be passed to the Connection class as kwargs, or a string in the format ot host[:port] which will be translated to a dictionary automatically. If no value is given the Connection class defaults will be used.
transport_class – Transport subclass to use.
kwargs – any additional arguments will be passed on to the Transport class and, subsequently, to the Connection instances.

bulk(*args, **kwargs)¶

Perform many index/delete operations in a single API call. http://elasticsearch.org/guide/reference/api/bulk/

See the bulk() helper function for a more friendly API.

Parameters:

body – The operation definition and data (action-data pairs), as either a newline separated string, or a sequence of dicts to serialize (one per row).
index – Default index for items which don’t provide one
doc_type – Default document type for items which don’t provide one
consistency – Explicit write consistency setting for the operation
refresh – Refresh the index after performing the operation
replication – Explicitly set the replication type (default: sync)
timeout – Explicit operation timeout

clear_scroll(*args, **kwargs)¶

Clear the scroll request created by specifying the scroll parameter to search. http://www.elasticsearch.org/guide/reference/api/search/scroll/

Parameters:	scroll_id – The scroll ID or a list of scroll IDs

count(*args, **kwargs)¶

Execute a query and get the number of matches for that query. http://elasticsearch.org/guide/reference/api/count/

Parameters:

index – A comma-separated list of indices to restrict the results
doc_type – A comma-separated list of types to restrict the results
body – A query to restrict the results (optional)
ignore_indices – When performed on multiple indices, allows to ignore missing ones (default: none)
min_score – Include only documents with a specific _score value in the result
preference – Specify the node or shard the operation should be performed on (default: random)
routing – Specific routing value
source – The URL-encoded query definition (instead of using the request body)

create(*args, **kwargs)¶

Adds a typed JSON document in a specific index, making it searchable. Behind the scenes this method calls index(..., op_type=’create’) http://elasticsearch.org/guide/reference/api/index_/

Parameters:

index – The name of the index
doc_type – The type of the document
id – Document ID
body – The document
consistency – Explicit write consistency setting for the operation
id – Specific document ID (when the POST method is used)
parent – ID of the parent document
percolate – Percolator queries to execute while indexing the document
refresh – Refresh the index after performing the operation
replication – Specific replication type (default: sync)
routing – Specific routing value
timeout – Explicit operation timeout
timestamp – Explicit timestamp for the document
ttl – Expiration time for the document
version – Explicit version number for concurrency control
version_type – Specific version type

delete(*args, **kwargs)¶

Delete a typed JSON document from a specific index based on its id. http://elasticsearch.org/guide/reference/api/delete/

Parameters:

index – The name of the index
doc_type – The type of the document
id – The document ID
consistency – Specific write consistency setting for the operation
parent – ID of parent document
refresh – Refresh the index after performing the operation
replication – Specific replication type (default: sync)
routing – Specific routing value
timeout – Explicit operation timeout
version – Explicit version number for concurrency control
version_type – Specific version type

delete_by_query(*args, **kwargs)¶

Delete documents from one or more indices and one or more types based on a query. http://www.elasticsearch.org/guide/reference/api/delete-by-query/

Parameters:

index – A comma-separated list of indices to restrict the operation
doc_type – A comma-separated list of types to restrict the operation
body – A query to restrict the operation
consistency – Specific write consistency setting for the operation
ignore_indices – When performed on multiple indices, allows to ignore missing ones (default: none)
replication – Specific replication type (default: sync)
routing – Specific routing value
source – The URL-encoded query definition (instead of using the request body)
q – Query in the Lucene query string syntax
timeout – Explicit operation timeout

exists(*args, **kwargs)¶

Returns a boolean indicating whether or not given document exists in Elasticsearch. http://elasticsearch.org/guide/reference/api/get/

Parameters:

index – The name of the index
id – The document ID
doc_type – The type of the document (uses _all by default to fetch the first document matching the ID across all types)
parent – The ID of the parent document
preference – Specify the node or shard the operation should be performed on (default: random)
realtime – Specify whether to perform the operation in realtime or search mode
refresh – Refresh the shard containing the document before performing the operation
routing – Specific routing value

explain(*args, **kwargs)¶

The explain api computes a score explanation for a query and a specific document. This can give useful feedback whether a document matches or didn’t match a specific query. http://elasticsearch.org/guide/reference/api/explain/

Parameters:

index – The name of the index
doc_type – The type of the document
id – The document ID
body – The query definition using the Query DSL
_source – True or false to return the _source field or not, or a list of fields to return
_source_exclude – A list of fields to exclude from the returned _source field
_source_include – A list of fields to extract and return from the _source field
analyze_wildcard – Specify whether wildcards and prefix queries in the query string query should be analyzed (default: false)
analyzer – The analyzer for the query string query
default_operator – The default operator for query string query (AND or OR), (default: OR)
df – The default field for query string query (default: _all)
fields – A comma-separated list of fields to return in the response
lenient – Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
lowercase_expanded_terms – Specify whether query terms should be lowercased
parent – The ID of the parent document
preference – Specify the node or shard the operation should be performed on (default: random)
q – Query in the Lucene query string syntax
routing – Specific routing value
source – The URL-encoded query definition (instead of using the request body)

get(*args, **kwargs)¶

Get a typed JSON document from the index based on its id. http://elasticsearch.org/guide/reference/api/get/

Parameters:

index – The name of the index
id – The document ID
doc_type – The type of the document (uses _all by default to fetch the first document matching the ID across all types)
_source – True or false to return the _source field or not, or a list of fields to return
_source_exclude – A list of fields to exclude from the returned _source field
_source_include – A list of fields to extract and return from the _source field
fields – A comma-separated list of fields to return in the response
parent – The ID of the parent document
preference – Specify the node or shard the operation should be performed on (default: random)
realtime – Specify whether to perform the operation in realtime or search mode
refresh – Refresh the shard containing the document before performing the operation
routing – Specific routing value

get_source(*args, **kwargs)¶

Get the source of a document by it’s index, type and id. http://elasticsearch.org/guide/reference/api/get/

Parameters:

index – The name of the index
doc_type – The type of the document (uses _all by default to fetch the first document matching the ID across all types)
id – The document ID
exclude – A list of fields to exclude from the returned _source field
include – A list of fields to extract and return from the _source field
parent – The ID of the parent document
preference – Specify the node or shard the operation should be performed on (default: random)
realtime – Specify whether to perform the operation in realtime or search mode
refresh – Refresh the shard containing the document before performing the operation
routing – Specific routing value

index(*args, **kwargs)¶

Adds or updates a typed JSON document in a specific index, making it searchable. http://elasticsearch.org/guide/reference/api/index_/

Parameters:

index – The name of the index
doc_type – The type of the document
body – The document
id – Document ID
consistency – Explicit write consistency setting for the operation
op_type – Explicit operation type (default: index)
parent – ID of the parent document
percolate – Percolator queries to execute while indexing the document
refresh – Refresh the index after performing the operation
replication – Specific replication type (default: sync)
routing – Specific routing value
timeout – Explicit operation timeout
timestamp – Explicit timestamp for the document
ttl – Expiration time for the document
version – Explicit version number for concurrency control
version_type – Specific version type

info(*args, **kwargs)¶: Get the basic info from the current cluster.

mget(*args, **kwargs)¶

Get multiple documents based on an index, type (optional) and ids. http://elasticsearch.org/guide/reference/api/multi-get/

Parameters:

body – Document identifiers; can be either docs (containing full document information) or ids (when index and type is provided in the URL.
index – The name of the index
doc_type – The type of the document
_source – True or false to return the _source field or not, or a list of fields to return
_source_exclude – A list of fields to exclude from the returned _source field
_source_include – A list of fields to extract and return from the _source field
fields – A comma-separated list of fields to return in the response
parent – The ID of the parent document
preference – Specify the node or shard the operation should be performed on (default: random)
realtime – Specify whether to perform the operation in realtime or search mode
refresh – Refresh the shard containing the document before performing the operation
routing – Specific routing value

mlt(*args, **kwargs)¶

Get documents that are “like” a specified document. http://elasticsearch.org/guide/reference/api/more-like-this/

Parameters:

index – The name of the index
doc_type – The type of the document (use _all to fetch the first document matching the ID across all types)
id – The document ID
body – A specific search request definition
boost_terms – The boost factor
max_doc_freq – The word occurrence frequency as count: words with higher occurrence in the corpus will be ignored
max_query_terms – The maximum query terms to be included in the generated query
max_word_len – The minimum length of the word: longer words will be ignored
min_doc_freq – The word occurrence frequency as count: words with lower occurrence in the corpus will be ignored
min_term_freq – The term frequency as percent: terms with lower occurence in the source document will be ignored
min_word_len – The minimum length of the word: shorter words will be ignored
mlt_fields – Specific fields to perform the query against
percent_terms_to_match – How many terms have to match in order to consider the document a match (default: 0.3)
routing – Specific routing value
search_from – The offset from which to return results
search_indices – A comma-separated list of indices to perform the query against (default: the index containing the document)
search_query_hint – The search query hint
search_scroll – A scroll search request definition
search_size – The number of documents to return (default: 10)
search_source – A specific search request definition (instead of using the request body)
search_type – Specific search type (eg. dfs_then_fetch, count, etc)
search_types – A comma-separated list of types to perform the query against (default: the same type as the document)
stop_words – A list of stop words to be ignored

msearch(*args, **kwargs)¶

Execute several search requests within the same API. http://www.elasticsearch.org/guide/reference/api/multi-search/

Parameters:	body – The request definitions (metadata-search request definition pairs), as either a newline separated string, or a sequence of dicts to serialize (one per row). index – A comma-separated list of index names to use as default doc_type – A comma-separated list of document types to use as default search_type – Search operation type

percolate(*args, **kwargs)¶

Send a percolate request which include a doc, and get back the queries that match on that doc out of the set of registered queries. http://elasticsearch.org/guide/reference/api/percolate/

Parameters:	index – The name of the index with a registered percolator query doc_type – The document type body – The document (doc) to percolate against registered queries; optionally also a query to limit the percolation to specific registered queries prefer_local – With true, specify that a local shard should be used if available, with false, use a random shard (default: true)

ping(*args, **kwargs)¶: Returns True if the cluster is up, False otherwise.

scroll(*args, **kwargs)¶

Scroll a search request created by specifying the scroll parameter. http://www.elasticsearch.org/guide/reference/api/search/scroll/

Parameters:	scroll_id – The scroll ID scroll – Specify how long a consistent view of the index should be maintained for scrolled search

search(*args, **kwargs)¶

Execute a search query and get back search hits that match the query. http://www.elasticsearch.org/guide/reference/api/search/

Parameters:

index – A comma-separated list of index names to search; use _all or empty string to perform the operation on all indices
doc_type – A comma-separated list of document types to search; leave empty to perform the operation on all types
body – The search definition using the Query DSL
_source – True or false to return the _source field or not, or a list of fields to return
_source_exclude – A list of fields to exclude from the returned _source field
_source_include – A list of fields to extract and return from the _source field
analyze_wildcard – Specify whether wildcard and prefix queries should be analyzed (default: false)
analyzer – The analyzer to use for the query string
default_operator – The default operator for query string query (AND or OR) (default: OR)
df – The field to use as default where no field prefix is given in the query string
explain – Specify whether to return detailed information about score computation as part of a hit
fields – A comma-separated list of fields to return as part of a hit
ignore_indices – When performed on multiple indices, allows to ignore missing ones (default: none)
indices_boost – Comma-separated list of index boosts
lenient – Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
lowercase_expanded_terms – Specify whether query terms should be lowercased
from – Starting offset (default: 0)
preference – Specify the node or shard the operation should be performed on (default: random)
q – Query in the Lucene query string syntax
routing – A comma-separated list of specific routing values
scroll – Specify how long a consistent view of the index should be maintained for scrolled search
search_type – Search operation type
size – Number of hits to return (default: 10)
sort – A comma-separated list of <field>:<direction> pairs
source – The URL-encoded request definition using the Query DSL (instead of using request body)
stats – Specific ‘tag’ of the request for logging and statistical purposes
suggest_field – Specify which field to use for suggestions
suggest_mode – Specify suggest mode (default: missing)
suggest_size – How many suggestions to return in response
suggest_text – The source text for which the suggestions should be returned
timeout – Explicit operation timeout
version – Specify whether to return document version as part of a hit

suggest(*args, **kwargs)¶

The suggest feature suggests similar looking terms based on a provided text by using a suggester. http://elasticsearch.org/guide/reference/api/search/suggest/

Parameters:

index – A comma-separated list of index names to restrict the operation; use _all or empty string to perform the operation on all indices
body – The request definition
ignore_indices – When performed on multiple indices, allows to ignore missing ones (default: none)
preference – Specify the node or shard the operation should be performed on (default: random)
routing – Specific routing value
source – The URL-encoded request definition (instead of using request body)

update(*args, **kwargs)¶

Update a document based on a script or partial data provided. http://elasticsearch.org/guide/reference/api/update/

Parameters:

index – The name of the index
doc_type – The type of the document
id – Document ID
body – The request definition using either script or partial doc
consistency – Explicit write consistency setting for the operation
fields – A comma-separated list of fields to return in the response
lang – The script language (default: mvel)
parent – ID of the parent document
percolate – Perform percolation during the operation; use specific registered query name, attribute, or wildcard
refresh – Refresh the index after performing the operation
replication – Specific replication type (default: sync)
retry_on_conflict – Specify how many times should the operation be retried when a conflict occurs (default: 0)
routing – Specific routing value
script – The URL-encoded script definition (instead of using request body)
timeout – Explicit operation timeout
timestamp – Explicit timestamp for the document
ttl – Expiration time for the document
version – Explicit version number for concurrency control
version_type – Explicit version number for concurrency control

Indices¶

class elasticsearch.client.IndicesClient(client)¶

analyze(*args, **kwargs)¶

Perform the analysis process on a text and return the tokens breakdown of the text. http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-analyze.html

Parameters:

index – The name of the index to scope the operation
body – The text on which the analysis should be performed
analyzer – The name of the analyzer to use
field – Use the analyzer configured for this field (instead of passing the analyzer name)
filters – A comma-separated list of filters to use for the analysis
format – Format of the output, default u’detailed’
index – The name of the index to scope the operation
prefer_local – With true, specify that a local shard should be used if available, with false, use a random shard (default: true)
text – The text on which the analysis should be performed (when request body is not used)
tokenizer – The name of the tokenizer to use for the analysis

clear_cache(*args, **kwargs)¶

Clear either all caches or specific cached associated with one ore more indices. http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-clearcache.html

Parameters:

index – A comma-separated list of index name to limit the operation
field_data – Clear field data
fielddata – Clear field data
fields – A comma-separated list of fields to clear when using the field_data parameter (default: all)
filter – Clear filter caches
filter_cache – Clear filter caches
filter_keys – A comma-separated list of keys to clear when using the filter_cache parameter (default: all)
id – Clear ID caches for parent/child
id_cache – Clear ID caches for parent/child
ignore_indices – When performed on multiple indices, allows to ignore missing ones (default: none)
index – A comma-separated list of index name to limit the operation
recycler – Clear the recycler cache

close(*args, **kwargs)¶

Close an index to remove it’s overhead from the cluster. Closed index is blocked for read/write operations. http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-open-close.html

Parameters:	index – The name of the index master_timeout – Specify timeout for connection to master timeout – Explicit operation timeout

create(*args, **kwargs)¶

Create an index in Elasticsearch. http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-create-index.html

Parameters:	index – The name of the index body – The configuration for the index (settings and mappings) master_timeout – Specify timeout for connection to master timeout – Explicit operation timeout

delete(*args, **kwargs)¶

Delete an index in Elasticsearch http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-delete-index.html

Parameters:	index – A comma-separated list of indices to delete; use _all or empty string to delete all indices master_timeout – Specify timeout for connection to master timeout – Explicit operation timeout

delete_alias(*args, **kwargs)¶

Delete specific alias. http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-aliases.html

Parameters:	index – The name of the index with an alias name – The name of the alias to be deleted master_timeout – Specify timeout for connection to master timeout – Explicit timestamp for the document

delete_mapping(*args, **kwargs)¶

Delete a mapping (type) along with its data. http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-delete-mapping.html

Parameters:	index – A comma-separated list of index names; use _all for all indices doc_type – The name of the document type to delete master_timeout – Specify timeout for connection to master

delete_template(*args, **kwargs)¶

Delete an index template by its name. http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-templates.html

Parameters:	name – The name of the template master_timeout – Specify timeout for connection to master timeout – Explicit operation timeout

delete_warmer(*args, **kwargs)¶

Delete an index warmer. http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-warmers.html

Parameters:

index – A comma-separated list of index names to register warmer for; use _all or empty string to perform the operation on all indices
doc_type – A comma-separated list of document types to register warmer for; use _all or empty string to perform the operation on all types
name – The name of the warmer (supports wildcards); leave empty to delete all warmers
master_timeout – Specify timeout for connection to master

exists(*args, **kwargs)¶

Return a boolean indicating whether given index exists. http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-indices-exists.html

Parameters:	index – A list of indices to check

exists_alias(*args, **kwargs)¶

Return a boolean indicating whether given alias exists. http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-aliases.html

Parameters:	name – A comma-separated list of alias names to return index – A comma-separated list of index names to filter aliases ignore_indices – When performed on multiple indices, allows to ignore missing ones (default: none)

exists_type(*args, **kwargs)¶

Check if a type/types exists in an index/indices. http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-types-exists.html

Parameters:	index – A comma-separated list of index names; use _all to check the types across all indices doc_type – A comma-separated list of document types to check ignore_indices – When performed on multiple indices, allows to ignore missing ones (default: none)

flush(*args, **kwargs)¶

Explicitly flush one or more indices. http://http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-flush.html

Parameters:	index – A comma-separated list of index names; use _all or empty string for all indices force – TODO: ? full – TODO: ? ignore_indices – When performed on multiple indices, allows to ignore missing ones (default: none) refresh – Refresh the index after performing the operation

get_alias(*args, **kwargs)¶

Retrieve a specified alias. http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-aliases.html

Parameters:	name – A comma-separated list of alias names to return index – A comma-separated list of index names to filter aliases ignore_indices – When performed on multiple indices, allows to ignore missing ones, default u’none’

get_aliases(*args, **kwargs)¶

Retrieve specified aliases http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-aliases.html

Parameters:	index – A comma-separated list of index names to filter aliases timeout – Explicit operation timeout

get_field_mapping(*args, **kwargs)¶

Retrieve mapping definition of a specific field. http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-get-field-mapping.html

Parameters:	index – A comma-separated list of index names; use _all or empty string for all indices doc_type – A comma-separated list of document types field – A comma-separated list of fields to retrieve the mapping for include_defaults – A boolean indicating whether to return default values

get_mapping(*args, **kwargs)¶

Retrieve mapping definition of index or index/type. http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-get-mapping.html

Parameters:	index – A comma-separated list of index names; use _all or empty string for all indices doc_type – A comma-separated list of document types

get_settings(*args, **kwargs)¶

Retrieve settings for one or more (or all) indices. http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-get-settings.html

Parameters:	index – A comma-separated list of index names; use _all or empty string to perform the operation on all indices

get_template(*args, **kwargs)¶

Retrieve an index template by its name. http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-templates.html

Parameters:	name – The name of the template

get_warmer(*args, **kwargs)¶

Retreieve an index warmer. http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-warmers.html

Parameters:	index – A comma-separated list of index names to restrict the operation; use _all to perform the operation on all indices doc_type – A comma-separated list of document types to restrict the operation; leave empty to perform the operation on all types name – The name of the warmer (supports wildcards); leave empty to get all warmers

open(*args, **kwargs)¶

Open a closed index to make it available for search. http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-open-close.html

Parameters:	index – The name of the index master_timeout – Specify timeout for connection to master timeout – Explicit operation timeout

optimize(*args, **kwargs)¶

Explicitly optimize one or more indices through an API. http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-optimize.html

Parameters:

index – A comma-separated list of index names; use _all or empty string to perform the operation on all indices
flush – Specify whether the index should be flushed after performing the operation (default: true)
ignore_indices – When performed on multiple indices, allows to ignore missing ones, default u’none’
max_num_segments – The number of segments the index should be merged into (default: dynamic)
only_expunge_deletes – Specify whether the operation should only expunge deleted documents
operation_threading – TODO: ?
refresh – Specify whether the index should be refreshed after performing the operation (default: true)
wait_for_merge – Specify whether the request should block until the merge process is finished (default: true)

put_alias(*args, **kwargs)¶

Create an alias for a specific index/indices. http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-aliases.html

Parameters:	index – The name of the index with an alias name – The name of the alias to be created or updated body – The settings for the alias, such as routing or filter master_timeout – Specify timeout for connection to master timeout – Explicit timestamp for the document

put_mapping(*args, **kwargs)¶

Register specific mapping definition for a specific type. http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-put-mapping.html

Parameters:

index – A comma-separated list of index names; use _all to perform the operation on all indices
doc_type – The name of the document type
body – The mapping definition
ignore_conflicts – Specify whether to ignore conflicts while updating the mapping (default: false)
master_timeout – Specify timeout for connection to master
timeout – Explicit operation timeout

put_settings(*args, **kwargs)¶

Change specific index level settings in real time. http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-update-settings.html

Parameters:	index – A comma-separated list of index names; use _all or empty string to perform the operation on all indices master_timeout – Specify timeout for connection to master body – The index settings to be updated

put_template(*args, **kwargs)¶

Create an index template that will automatically be applied to new indices created. http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-templates.html

Parameters:	name – The name of the template body – The template definition order – The order for this template when merging multiple matching ones (higher numbers are merged later, overriding the lower numbers) master_timeout – Specify timeout for connection to master timeout – Explicit operation timeout

put_warmer(*args, **kwargs)¶

Create an index warmer to run registered search requests to warm up the index before it is available for search. http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-warmers.html

Parameters:

index – A comma-separated list of index names to register the warmer for; use _all or empty string to perform the operation on all indices
name – The name of the warmer
doc_type – A comma-separated list of document types to register the warmer for; leave empty to perform the operation on all types
body – The search request definition for the warmer (query, filters, facets, sorting, etc)
master_timeout – Specify timeout for connection to master

refresh(*args, **kwargs)¶

Explicitly refresh one or more index, making all operations performed since the last refresh available for search. http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-refresh.html

Parameters:	index – A comma-separated list of index names; use _all or empty string to perform the operation on all indices ignore_indices – When performed on multiple indices, allows to ignore missing ones, default u’none’

segments(*args, **kwargs)¶

Provide low level segments information that a Lucene index (shard level) is built with. http://elasticsearch.org/guide/reference/api/admin-indices-segments/

Parameters:	index – A comma-separated list of index names; use _all or empty string to perform the operation on all indices ignore_indices – When performed on multiple indices, allows to ignore missing ones, default u’none’ operation_threading – TODO: ?

snapshot_index(*args, **kwargs)¶

Explicitly perform a snapshot through the gateway of one or more indices (backup them). http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-gateway-snapshot.html

Parameters:	index – A comma-separated list of index names; use _all or empty string for all indices ignore_indices – When performed on multiple indices, allows to ignore missing ones (default: none)

stats(*args, **kwargs)¶

Retrieve statistics on different operations happening on an index. http://elasticsearch.org/guide/reference/api/admin-indices-stats/

Parameters:

index – A comma-separated list of index names; use _all or empty string to perform the operation on all indices
metric_family – Limit the information returned to a specific metric
all – Return all available information
clear – Reset the default level of detail
completion – Return information about completion suggester stats
completion_fields – A comma-separated list of fields for completion metric (supports wildcards)
docs – Return information about indexed and deleted documents
fielddata – Return information about field data
fielddata_fields – A comma-separated list of fields for fielddata metric (supports wildcards)
fields – A comma-separated list of fields for fielddata and completion metric (supports wildcards)
filter_cache – Return information about filter cache
flush – Return information about flush operations
get – Return information about get operations
groups – A comma-separated list of search groups for search statistics
id_cache – Return information about ID cache
ignore_indices – When performed on multiple indices, allows to ignore missing ones (default: none)
indexing – Return information about indexing operations
merge – Return information about merge operations
refresh – Return information about refresh operations
search – Return information about search operations; use the groups parameter to include information for specific search groups
store – Return information about the size of the index
warmer – Return information about warmers

status(*args, **kwargs)¶

Get a comprehensive status information of one or more indices. http://elasticsearch.org/guide/reference/api/admin-indices-_/

Parameters:	index – A comma-separated list of index names; use _all or empty string to perform the operation on all indices ignore_indices – When performed on multiple indices, allows to ignore missing ones, default u’none’ operation_threading – TODO: ? recovery – Return information about shard recovery snapshot – TODO: ?

update_aliases(*args, **kwargs)¶

Update specified aliases. http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-aliases.html

Parameters:	body – The definition of actions to perform master_timeout – Specify timeout for connection to master timeout – Request timeout

validate_query(*args, **kwargs)¶

Validate a potentially expensive query without executing it. http://www.elasticsearch.org/guide/reference/api/validate/

Parameters:

index – A comma-separated list of index names to restrict the operation; use _all or empty string to perform the operation on all indices
doc_type – A comma-separated list of document types to restrict the operation; leave empty to perform the operation on all types
body – The query definition
explain – Return detailed information about the error
ignore_indices – When performed on multiple indices, allows to ignore missing ones (default: none)
operation_threading – TODO: ?
q – Query in the Lucene query string syntax
source – The URL-encoded query definition (instead of using the request body)

Cluster¶

class elasticsearch.client.ClusterClient(client)¶

get_settings(*args, **kwargs)¶: Get cluster settings. http://elasticsearch.org/guide/reference/api/admin-cluster-update-settings/

health(*args, **kwargs)¶

Get a very simple status on the health of the cluster. http://elasticsearch.org/guide/reference/api/admin-cluster-health/

Parameters:

index – Limit the information returned to a specific index
level – Specify the level of detail for returned information, default u’cluster’
local – Return local information, do not retrieve the state from master node (default: false)
master_timeout – Explicit operation timeout for connection to master node
timeout – Explicit operation timeout
wait_for_active_shards – Wait until the specified number of shards is active
wait_for_nodes – Wait until the specified number of nodes is available
wait_for_relocating_shards – Wait until the specified number of relocating shards is finished
wait_for_status – Wait until cluster is in a specific state, default None

node_info(*args, **kwargs)¶

Retrieve one or more (or all) of the cluster nodes’ information. http://elasticsearch.org/guide/reference/api/admin-cluster-nodes-info/

Parameters:

node_id – A comma-separated list of node IDs or names to limit the returned information; use _local to return information from the node you’re connecting to, leave empty to get information from all nodes
all – Return all available information
clear – Reset the default settings
http – Return information about HTTP
jvm – Return information about the JVM
network – Return information about network
os – Return information about the operating system
plugin – Return information about plugins
process – Return information about the Elasticsearch process
settings – Return information about node settings
thread_pool – Return information about the thread pool
timeout – Explicit operation timeout
transport – Return information about transport

node_shutdown(*args, **kwargs)¶

Shutdown one or more (or all) nodes in the cluster. http://elasticsearch.org/guide/reference/api/admin-cluster-nodes-shutdown/

Parameters:	node_id – A comma-separated list of node IDs or names to perform the operation on; use _local to perform the operation on the node you’re connected to, leave empty to perform the operation on all nodes delay – Set the delay for the operation (default: 1s) exit – Exit the JVM as well (default: true)

node_stats(*args, **kwargs)¶

Retrieve one or more (or all) of the cluster nodes statistics. http://elasticsearch.org/guide/reference/api/admin-cluster-nodes-stats/

Parameters:

node_id – A comma-separated list of node IDs or names to limit the returned information; use _local to return information from the node you’re connecting to, leave empty to get information from all nodes
metric – Limit the information returned for indices family to a specific metric
fields – A comma-separated list of fields to return detailed information for, when returning the indices metric family (supports wildcards)
all – Return all available information
clear – Reset the default level of detail
fields – A comma-separated list of fields for fielddata metric (supports wildcards)
fs – Return information about the filesystem
http – Return information about HTTP
indices – Return information about indices
jvm – Return information about the JVM
network – Return information about network
os – Return information about the operating system
process – Return information about the Elasticsearch process
thread_pool – Return information about the thread pool
transport – Return information about transport

put_settings(*args, **kwargs)¶

Update cluster wide specific settings. http://elasticsearch.org/guide/reference/api/admin-cluster-update-settings/

Parameters:	body – The settings to be updated. Can be either transient or persistent (survives cluster restart).

reroute(*args, **kwargs)¶

Explicitly execute a cluster reroute allocation command including specific commands. http://elasticsearch.org/guide/reference/api/admin-cluster-reroute/

Parameters:	body – The definition of commands to perform (move, cancel, allocate) dry_run – Simulate the operation only and return the resulting state filter_metadata – Don’t return cluster state metadata (default: false)

state(*args, **kwargs)¶

Get a comprehensive state information of the whole cluster. http://elasticsearch.org/guide/reference/api/admin-cluster-state/

Parameters:

filter_blocks – Do not return information about blocks
filter_index_templates – Do not return information about index templates
filter_indices – Limit returned metadata information to specific indices
filter_metadata – Do not return information about indices metadata
filter_nodes – Do not return information about nodes
filter_routing_table – Do not return information about shard allocation (routing_table and routing_nodes)
local – Return local information, do not retrieve the state from master node (default: false)
master_timeout – Specify timeout for connection to master