962 lines
50 KiB
Python
962 lines
50 KiB
Python
from .utils import NamespacedClient, query_params, _make_path, SKIP_IN_PATH
|
|
from ..exceptions import NotFoundError
|
|
|
|
class IndicesClient(NamespacedClient):
|
|
@query_params('analyzer', 'char_filters', 'field', 'filters', 'format',
|
|
'prefer_local', 'text', 'tokenizer')
|
|
def analyze(self, index=None, body=None, params=None):
|
|
"""
|
|
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>`_
|
|
|
|
:arg index: The name of the index to scope the operation
|
|
:arg body: The text on which the analysis should be performed
|
|
:arg analyzer: The name of the analyzer to use
|
|
:arg char_filters: A comma-separated list of character filters to use
|
|
for the analysis
|
|
:arg field: Use the analyzer configured for this field (instead of
|
|
passing the analyzer name)
|
|
:arg filters: A comma-separated list of filters to use for the analysis
|
|
:arg format: Format of the output, default u'detailed'
|
|
:arg prefer_local: With `true`, specify that a local shard should be
|
|
used if available, with `false`, use a random shard (default: true)
|
|
:arg text: The text on which the analysis should be performed (when
|
|
request body is not used)
|
|
:arg tokenizer: The name of the tokenizer to use for the analysis
|
|
"""
|
|
_, data = self.transport.perform_request('GET', _make_path(index, '_analyze'),
|
|
params=params, body=body)
|
|
return data
|
|
|
|
@query_params('allow_no_indices', 'expand_wildcards', 'ignore_indices',
|
|
'ignore_unavailable', 'force')
|
|
def refresh(self, index=None, params=None):
|
|
"""
|
|
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>`_
|
|
|
|
:arg index: A comma-separated list of index names; use `_all` or empty
|
|
string to perform the operation on all indices
|
|
:arg allow_no_indices: Whether to ignore if a wildcard indices
|
|
expression resolves into no concrete indices. (This includes `_all` string or
|
|
when no indices have been specified)
|
|
:arg expand_wildcards: Whether to expand wildcard expression to concrete indices
|
|
that are open, closed or both.
|
|
:arg ignore_indices: When performed on multiple indices, allows to
|
|
ignore `missing` ones, default u'none'
|
|
:arg ignore_unavailable: Whether specified concrete indices should be ignored
|
|
when unavailable (missing or closed)
|
|
:arg force: Force a refresh even if not required
|
|
"""
|
|
_, data = self.transport.perform_request('POST', _make_path(index, '_refresh'),
|
|
params=params)
|
|
return data
|
|
|
|
@query_params('force', 'full', 'allow_no_indices', 'expand_wildcards',
|
|
'ignore_indices', 'ignore_unavailable')
|
|
def flush(self, index=None, params=None):
|
|
"""
|
|
Explicitly flush one or more indices.
|
|
`<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-flush.html>`_
|
|
|
|
:arg index: A comma-separated list of index names; use `_all` or empty
|
|
string for all indices
|
|
:arg force: Whether a flush should be forced even if it is not
|
|
necessarily needed ie. if no changes will be committed to the index.
|
|
:arg full: If set to true a new index writer is created and settings
|
|
that have been changed related to the index writer will be refreshed.
|
|
:arg allow_no_indices: Whether to ignore if a wildcard indices
|
|
expression resolves into no concrete indices. (This includes `_all` string or
|
|
when no indices have been specified)
|
|
:arg expand_wildcards: Whether to expand wildcard expression to concrete indices
|
|
that are open, closed or both.
|
|
:arg ignore_indices: When performed on multiple indices, allows to
|
|
ignore `missing` ones (default: none)
|
|
:arg ignore_unavailable: Whether specified concrete indices should be ignored
|
|
when unavailable (missing or closed)
|
|
"""
|
|
_, data = self.transport.perform_request('POST', _make_path(index, '_flush'),
|
|
params=params)
|
|
return data
|
|
|
|
@query_params('timeout', 'master_timeout')
|
|
def create(self, index, body=None, params=None):
|
|
"""
|
|
Create an index in Elasticsearch.
|
|
`<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-create-index.html>`_
|
|
|
|
:arg index: The name of the index
|
|
:arg body: The configuration for the index (`settings` and `mappings`)
|
|
:arg master_timeout: Specify timeout for connection to master
|
|
:arg timeout: Explicit operation timeout
|
|
"""
|
|
if index in SKIP_IN_PATH:
|
|
raise ValueError("Empty value passed for a required argument 'index'.")
|
|
_, data = self.transport.perform_request('PUT', _make_path(index),
|
|
params=params, body=body)
|
|
return data
|
|
|
|
@query_params('allow_no_indices', 'expand_wildcards', 'ignore_unavailable',
|
|
'local')
|
|
def get(self, index, feature=None, params=None):
|
|
"""
|
|
The get index API allows to retrieve information about one or more indexes.
|
|
`<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-get-index.html>`_
|
|
|
|
:arg index: A comma-separated list of index names
|
|
:arg feature: A comma-separated list of features
|
|
:arg allow_no_indices: Ignore if a wildcard expression resolves to no
|
|
concrete indices (default: false)
|
|
:arg expand_wildcards: Whether wildcard expressions should get expanded
|
|
to open or closed indices (default: open)
|
|
:arg ignore_unavailable: Ignore unavailable indexes (default: false)
|
|
:arg local: Return local information, do not retrieve the state from
|
|
master node (default: false)
|
|
"""
|
|
if index in SKIP_IN_PATH:
|
|
raise ValueError("Empty value passed for a required argument 'index'.")
|
|
_, data = self.transport.perform_request('GET', _make_path(index,
|
|
feature), params=params)
|
|
return data
|
|
|
|
@query_params('timeout', 'master_timeout' 'allow_no_indices', 'expand_wildcards',
|
|
'ignore_unavailable')
|
|
def open(self, index, params=None):
|
|
"""
|
|
Open a closed index to make it available for search.
|
|
`<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-open-close.html>`_
|
|
|
|
:arg index: The name of the index
|
|
:arg master_timeout: Specify timeout for connection to master
|
|
:arg timeout: Explicit operation timeout
|
|
:arg allow_no_indices: Whether to ignore if a wildcard indices
|
|
expression resolves into no concrete indices. (This includes `_all` string or
|
|
when no indices have been specified)
|
|
:arg expand_wildcards: Whether to expand wildcard expression to concrete indices
|
|
that are open, closed or both.
|
|
:arg ignore_unavailable: Whether specified concrete indices should be ignored
|
|
when unavailable (missing or closed)
|
|
"""
|
|
if index in SKIP_IN_PATH:
|
|
raise ValueError("Empty value passed for a required argument 'index'.")
|
|
_, data = self.transport.perform_request('POST', _make_path(index, '_open'),
|
|
params=params)
|
|
return data
|
|
|
|
@query_params('allow_no_indices', 'expand_wildcards', 'ignore_unavailable',
|
|
'master_timeout', 'timeout')
|
|
def close(self, index, params=None):
|
|
"""
|
|
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>`_
|
|
|
|
:arg index: A comma-separated list of indices to close; use `_all` or
|
|
'*' to close all indices
|
|
:arg allow_no_indices: Whether to ignore if a wildcard indices
|
|
expression resolves into no concrete indices. (This includes `_all`
|
|
string or when no indices have been specified)
|
|
:arg expand_wildcards: Whether to expand wildcard expression to concrete
|
|
indices that are open, closed or both., default u'open'
|
|
:arg ignore_unavailable: Whether specified concrete indices should be
|
|
ignored when unavailable (missing or closed)
|
|
:arg master_timeout: Specify timeout for connection to master
|
|
:arg timeout: Explicit operation timeout
|
|
"""
|
|
if index in SKIP_IN_PATH:
|
|
raise ValueError("Empty value passed for a required argument 'index'.")
|
|
_, data = self.transport.perform_request('POST', _make_path(index, '_close'),
|
|
params=params)
|
|
return data
|
|
|
|
@query_params('timeout', 'master_timeout')
|
|
def delete(self, index, params=None):
|
|
"""
|
|
Delete an index in Elasticsearch
|
|
`<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-delete-index.html>`_
|
|
|
|
:arg index: A comma-separated list of indices to delete; use `_all` or
|
|
'*' to delete all indices
|
|
:arg master_timeout: Specify timeout for connection to master
|
|
:arg timeout: Explicit operation timeout
|
|
"""
|
|
if index in SKIP_IN_PATH:
|
|
raise ValueError("Empty value passed for a required argument 'index'.")
|
|
_, data = self.transport.perform_request('DELETE', _make_path(index),
|
|
params=params)
|
|
return data
|
|
|
|
@query_params('allow_no_indices', 'expand_wildcards', 'ignore_unavailable',
|
|
'local')
|
|
def exists(self, index, params=None):
|
|
"""
|
|
Return a boolean indicating whether given index exists.
|
|
`<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-exists.html>`_
|
|
|
|
:arg index: A list of indices to check
|
|
:arg allow_no_indices: Whether to ignore if a wildcard indices
|
|
expression resolves into no concrete indices. (This includes `_all`
|
|
string or when no indices have been specified)
|
|
:arg expand_wildcards: Whether to expand wildcard expression to concrete
|
|
indices that are open, closed or both., default u'open'
|
|
:arg ignore_unavailable: Whether specified concrete indices should be
|
|
ignored when unavailable (missing or closed)
|
|
:arg local: Return local information, do not retrieve the state from
|
|
master node (default: false)
|
|
"""
|
|
if index in SKIP_IN_PATH:
|
|
raise ValueError("Empty value passed for a required argument 'index'.")
|
|
try:
|
|
self.transport.perform_request('HEAD', _make_path(index), params=params)
|
|
except NotFoundError:
|
|
return False
|
|
return True
|
|
|
|
@query_params('allow_no_indices', 'expand_wildcards', 'ignore_indices', 'ignore_unavailable',
|
|
'local')
|
|
def exists_type(self, index, doc_type, params=None):
|
|
"""
|
|
Check if a type/types exists in an index/indices.
|
|
`<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-types-exists.html>`_
|
|
|
|
:arg index: A comma-separated list of index names; use `_all` to check
|
|
the types across all indices
|
|
:arg doc_type: A comma-separated list of document types to check
|
|
:arg allow_no_indices: Whether to ignore if a wildcard indices
|
|
expression resolves into no concrete indices. (This includes `_all` string or
|
|
when no indices have been specified)
|
|
:arg expand_wildcards: Whether to expand wildcard expression to concrete indices
|
|
that are open, closed or both.
|
|
:arg ignore_indices: When performed on multiple indices, allows to
|
|
ignore `missing` ones (default: none)
|
|
:arg ignore_unavailable: Whether specified concrete indices should be ignored
|
|
when unavailable (missing or closed)
|
|
:arg local: Return local information, do not retrieve the state from
|
|
master node (default: false)
|
|
"""
|
|
for param in (index, doc_type):
|
|
if param in SKIP_IN_PATH:
|
|
raise ValueError("Empty value passed for a required argument.")
|
|
try:
|
|
self.transport.perform_request('HEAD', _make_path(index, doc_type), params=params)
|
|
except NotFoundError:
|
|
return False
|
|
return True
|
|
|
|
@query_params('allow_no_indices', 'expand_wildcards', 'ignore_conflicts',
|
|
'ignore_unavailable', 'master_timeout', 'timeout')
|
|
def put_mapping(self, doc_type, body, index=None, params=None):
|
|
"""
|
|
Register specific mapping definition for a specific type.
|
|
`<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-put-mapping.html>`_
|
|
|
|
:arg index: A comma-separated list of index names the mapping should be
|
|
added to (supports wildcards); use `_all` or omit to add the
|
|
mapping on all indices.
|
|
:arg doc_type: The name of the document type
|
|
:arg body: The mapping definition
|
|
:arg allow_no_indices: Whether to ignore if a wildcard indices
|
|
expression resolves into no concrete indices. (This includes `_all`
|
|
string or when no indices have been specified)
|
|
:arg expand_wildcards: Whether to expand wildcard expression to concrete
|
|
indices that are open, closed or both., default u'open'
|
|
:arg ignore_conflicts: Specify whether to ignore conflicts while
|
|
updating the mapping (default: false)
|
|
:arg ignore_unavailable: Whether specified concrete indices should be
|
|
ignored when unavailable (missing or closed)
|
|
:arg master_timeout: Specify timeout for connection to master
|
|
:arg timeout: Explicit operation timeout
|
|
"""
|
|
for param in (doc_type, body):
|
|
if param in SKIP_IN_PATH:
|
|
raise ValueError("Empty value passed for a required argument.")
|
|
_, data = self.transport.perform_request('PUT', _make_path(index, '_mapping', doc_type),
|
|
params=params, body=body)
|
|
return data
|
|
|
|
@query_params('ignore_unavailable', 'allow_no_indices',
|
|
'expand_wildcards', 'local')
|
|
def get_mapping(self, index=None, doc_type=None, params=None):
|
|
"""
|
|
Retrieve mapping definition of index or index/type.
|
|
`<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-get-mapping.html>`_
|
|
|
|
:arg index: A comma-separated list of index names; use `_all` or empty
|
|
string for all indices
|
|
:arg doc_type: A comma-separated list of document types
|
|
:arg allow_no_indices: Whether to ignore if a wildcard indices
|
|
expression resolves into no concrete indices. (This includes `_all` string or
|
|
when no indices have been specified)
|
|
:arg expand_wildcards: Whether to expand wildcard expression to concrete indices
|
|
that are open, closed or both.
|
|
:arg ignore_unavailable: Whether specified concrete indices should be ignored
|
|
when unavailable (missing or closed)
|
|
:arg local: Return local information, do not retrieve the state from
|
|
master node (default: false)
|
|
"""
|
|
_, data = self.transport.perform_request('GET', _make_path(index, '_mapping', doc_type),
|
|
params=params)
|
|
return data
|
|
|
|
@query_params("include_defaults", 'ignore_unavailable', 'allow_no_indices',
|
|
'expand_wildcards', 'local')
|
|
def get_field_mapping(self, field, index=None, doc_type=None, params=None):
|
|
"""
|
|
Retrieve mapping definition of a specific field.
|
|
`<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-get-field-mapping.html>`_
|
|
|
|
:arg index: A comma-separated list of index names; use `_all` or empty
|
|
string for all indices
|
|
:arg doc_type: A comma-separated list of document types
|
|
:arg field: A comma-separated list of fields to retrieve the mapping for
|
|
:arg include_defaults: A boolean indicating whether to return default values
|
|
:arg allow_no_indices: Whether to ignore if a wildcard indices
|
|
expression resolves into no concrete indices. (This includes `_all` string or
|
|
when no indices have been specified)
|
|
:arg expand_wildcards: Whether to expand wildcard expression to concrete indices
|
|
that are open, closed or both.
|
|
:arg ignore_unavailable: Whether specified concrete indices should be ignored
|
|
when unavailable (missing or closed)
|
|
:arg local: Return local information, do not retrieve the state from
|
|
master node (default: false)
|
|
"""
|
|
if field in SKIP_IN_PATH:
|
|
raise ValueError("Empty value passed for a required argument 'field'.")
|
|
_, data = self.transport.perform_request('GET', _make_path(index, '_mapping', doc_type, 'field', field),
|
|
params=params)
|
|
return data
|
|
|
|
@query_params('master_timeout')
|
|
def delete_mapping(self, index, doc_type, params=None):
|
|
"""
|
|
Delete a mapping (type) along with its data.
|
|
`<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-delete-mapping.html>`_
|
|
|
|
:arg index: A comma-separated list of index names (supports wildcard);
|
|
use `_all` for all indices
|
|
:arg doc_type: A comma-separated list of document types to delete
|
|
(supports wildcards); use `_all` to delete all document types in the
|
|
specified indices.
|
|
:arg master_timeout: Specify timeout for connection to master
|
|
"""
|
|
for param in (index, doc_type):
|
|
if param in SKIP_IN_PATH:
|
|
raise ValueError("Empty value passed for a required argument.")
|
|
_, data = self.transport.perform_request('DELETE', _make_path(index, '_mapping', doc_type),
|
|
params=params)
|
|
return data
|
|
|
|
@query_params('timeout', 'master_timeout')
|
|
def put_alias(self, name, index, body=None, params=None):
|
|
"""
|
|
Create an alias for a specific index/indices.
|
|
`<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-aliases.html>`_
|
|
|
|
:arg index: A comma-separated list of index names the alias should
|
|
point to (supports wildcards); use `_all` or omit to perform the
|
|
operation on all indices.
|
|
:arg name: The name of the alias to be created or updated
|
|
:arg body: The settings for the alias, such as `routing` or `filter`
|
|
:arg master_timeout: Specify timeout for connection to master
|
|
:arg timeout: Explicit timestamp for the document
|
|
"""
|
|
for param in (index, name):
|
|
if param in SKIP_IN_PATH:
|
|
raise ValueError("Empty value passed for a required argument.")
|
|
_, data = self.transport.perform_request('PUT', _make_path(index, '_alias', name),
|
|
params=params, body=body)
|
|
return data
|
|
|
|
@query_params('allow_no_indices', 'expand_wildcards', 'ignore_indices', 'ignore_unavailable',
|
|
'local')
|
|
def exists_alias(self, name, index=None, params=None):
|
|
"""
|
|
Return a boolean indicating whether given alias exists.
|
|
`<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-aliases.html>`_
|
|
|
|
:arg name: A comma-separated list of alias names to return
|
|
:arg index: A comma-separated list of index names to filter aliases
|
|
:arg allow_no_indices: Whether to ignore if a wildcard indices
|
|
expression resolves into no concrete indices. (This includes `_all` string or
|
|
when no indices have been specified)
|
|
:arg expand_wildcards: Whether to expand wildcard expression to concrete indices
|
|
that are open, closed or both.
|
|
:arg ignore_indices: When performed on multiple indices, allows to
|
|
ignore `missing` ones (default: none)
|
|
:arg ignore_unavailable: Whether specified concrete indices should be ignored
|
|
when unavailable (missing or closed)
|
|
:arg local: Return local information, do not retrieve the state from
|
|
master node (default: false)
|
|
"""
|
|
try:
|
|
self.transport.perform_request('HEAD', _make_path(index, '_alias', name),
|
|
params=params)
|
|
except NotFoundError:
|
|
return False
|
|
return True
|
|
|
|
@query_params('allow_no_indices', 'expand_wildcards', 'ignore_indices', 'ignore_unavailable', 'local')
|
|
def get_alias(self, index=None, name=None, params=None):
|
|
"""
|
|
Retrieve a specified alias.
|
|
`<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-aliases.html>`_
|
|
|
|
:arg name: A comma-separated list of alias names to return
|
|
:arg index: A comma-separated list of index names to filter aliases
|
|
:arg allow_no_indices: Whether to ignore if a wildcard indices
|
|
expression resolves into no concrete indices. (This includes `_all` string or
|
|
when no indices have been specified)
|
|
:arg expand_wildcards: Whether to expand wildcard expression to concrete indices
|
|
that are open, closed or both.
|
|
:arg ignore_indices: When performed on multiple indices, allows to
|
|
ignore `missing` ones, default u'none'
|
|
:arg ignore_unavailable: Whether specified concrete indices should be ignored
|
|
when unavailable (missing or closed)
|
|
:arg local: Return local information, do not retrieve the state from
|
|
master node (default: false)
|
|
"""
|
|
_, data = self.transport.perform_request('GET', _make_path(index, '_alias', name),
|
|
params=params)
|
|
return data
|
|
|
|
@query_params('local', 'timeout')
|
|
def get_aliases(self, index=None, name=None, params=None):
|
|
"""
|
|
Retrieve specified aliases
|
|
`<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-aliases.html>`_
|
|
|
|
:arg index: A comma-separated list of index names to filter aliases
|
|
:arg name: A comma-separated list of alias names to filter
|
|
:arg local: Return local information, do not retrieve the state from
|
|
master node (default: false)
|
|
:arg timeout: Explicit operation timeout
|
|
"""
|
|
_, data = self.transport.perform_request('GET', _make_path(index, '_aliases', name),
|
|
params=params)
|
|
return data
|
|
|
|
@query_params('timeout', 'master_timeout')
|
|
def update_aliases(self, body, params=None):
|
|
"""
|
|
Update specified aliases.
|
|
`<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-aliases.html>`_
|
|
|
|
:arg body: The definition of `actions` to perform
|
|
:arg master_timeout: Specify timeout for connection to master
|
|
:arg timeout: Request timeout
|
|
"""
|
|
if body in SKIP_IN_PATH:
|
|
raise ValueError("Empty value passed for a required argument 'body'.")
|
|
_, data = self.transport.perform_request('POST', '/_aliases',
|
|
params=params, body=body)
|
|
return data
|
|
|
|
@query_params('timeout', 'master_timeout')
|
|
def delete_alias(self, index, name, params=None):
|
|
"""
|
|
Delete specific alias.
|
|
`<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-aliases.html>`_
|
|
|
|
:arg index: A comma-separated list of index names (supports wildcards);
|
|
use `_all` for all indices
|
|
:arg name: A comma-separated list of aliases to delete (supports
|
|
wildcards); use `_all` to delete all aliases for the specified indices.
|
|
:arg master_timeout: Specify timeout for connection to master
|
|
:arg timeout: Explicit timestamp for the document
|
|
"""
|
|
for param in (index, name):
|
|
if param in SKIP_IN_PATH:
|
|
raise ValueError("Empty value passed for a required argument.")
|
|
_, data = self.transport.perform_request('DELETE', _make_path(index, '_alias', name),
|
|
params=params)
|
|
return data
|
|
|
|
@query_params('create', 'order', 'timeout', 'master_timeout', 'flat_settings')
|
|
def put_template(self, name, body, params=None):
|
|
"""
|
|
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>`_
|
|
|
|
:arg name: The name of the template
|
|
:arg body: The template definition
|
|
:arg create: Whether the index template should only be added if new or
|
|
can also replace an existing one
|
|
:arg order: The order for this template when merging multiple matching
|
|
ones (higher numbers are merged later, overriding the lower numbers)
|
|
:arg master_timeout: Specify timeout for connection to master
|
|
:arg timeout: Explicit operation timeout
|
|
:arg flat_settings: Return settings in flat format (default: false)
|
|
"""
|
|
for param in (name, body):
|
|
if param in SKIP_IN_PATH:
|
|
raise ValueError("Empty value passed for a required argument.")
|
|
_, data = self.transport.perform_request('PUT', _make_path('_template', name),
|
|
params=params, body=body)
|
|
return data
|
|
|
|
@query_params('local', 'master_timeout')
|
|
def exists_template(self, name, params=None):
|
|
"""
|
|
Return a boolean indicating whether given template exists.
|
|
`<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-templates.html>`_
|
|
|
|
:arg name: The name of the template
|
|
:arg local: Return local information, do not retrieve the state from
|
|
master node (default: false)
|
|
:arg master_timeout: Explicit operation timeout for connection to master
|
|
node
|
|
"""
|
|
if name in SKIP_IN_PATH:
|
|
raise ValueError("Empty value passed for a required argument 'name'.")
|
|
try:
|
|
self.transport.perform_request('HEAD', _make_path('_template', name),
|
|
params=params)
|
|
except NotFoundError:
|
|
return False
|
|
return True
|
|
|
|
@query_params('flat_settings', 'local', 'master_timeout')
|
|
def get_template(self, name=None, params=None):
|
|
"""
|
|
Retrieve an index template by its name.
|
|
`<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-templates.html>`_
|
|
|
|
:arg name: The name of the template
|
|
:arg flat_settings: Return settings in flat format (default: false)
|
|
:arg local: Return local information, do not retrieve the state from
|
|
master node (default: false)
|
|
:arg master_timeout: Explicit operation timeout for connection to master
|
|
node
|
|
"""
|
|
_, data = self.transport.perform_request('GET', _make_path('_template', name),
|
|
params=params)
|
|
return data
|
|
|
|
@query_params('timeout', 'master_timeout')
|
|
def delete_template(self, name, params=None):
|
|
"""
|
|
Delete an index template by its name.
|
|
`<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-templates.html>`_
|
|
|
|
:arg name: The name of the template
|
|
:arg master_timeout: Specify timeout for connection to master
|
|
:arg timeout: Explicit operation timeout
|
|
"""
|
|
if name in SKIP_IN_PATH:
|
|
raise ValueError("Empty value passed for a required argument 'name'.")
|
|
_, data = self.transport.perform_request('DELETE', _make_path('_template', name),
|
|
params=params)
|
|
return data
|
|
|
|
@query_params('expand_wildcards', 'ignore_indices', 'ignore_unavailable',
|
|
'flat_settings', 'local')
|
|
def get_settings(self, index=None, name=None, params=None):
|
|
"""
|
|
Retrieve settings for one or more (or all) indices.
|
|
`<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-get-settings.html>`_
|
|
|
|
:arg index: A comma-separated list of index names; use `_all` or empty
|
|
string to perform the operation on all indices
|
|
:arg name: The name of the settings that should be included
|
|
:arg expand_wildcards: Whether to expand wildcard expression to concrete indices
|
|
that are open, closed or both.
|
|
:arg ignore_indices: When performed on multiple indices, allows to
|
|
ignore `missing` ones, default u'none'
|
|
:arg ignore_unavailable: Whether specified concrete indices should be ignored
|
|
when unavailable (missing or closed)
|
|
:arg flat_settings: Return settings in flat format (default: false)
|
|
:arg local: Return local information, do not retrieve the state from
|
|
master node (default: false)
|
|
"""
|
|
_, data = self.transport.perform_request('GET', _make_path(index, '_settings', name),
|
|
params=params)
|
|
return data
|
|
|
|
@query_params('allow_no_indices', 'expand_wildcards', 'flat_settings',
|
|
'ignore_unavailable', 'master_timeout')
|
|
def put_settings(self, body, index=None, params=None):
|
|
"""
|
|
Change specific index level settings in real time.
|
|
`<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-update-settings.html>`_
|
|
|
|
:arg body: The index settings to be updated
|
|
:arg index: A comma-separated list of index names; use `_all` or empty
|
|
string to perform the operation on all indices
|
|
:arg allow_no_indices: Whether to ignore if a wildcard indices
|
|
expression resolves into no concrete indices. (This includes `_all`
|
|
string or when no indices have been specified)
|
|
:arg expand_wildcards: Whether to expand wildcard expression to concrete
|
|
indices that are open, closed or both., default u'open'
|
|
:arg flat_settings: Return settings in flat format (default: false)
|
|
:arg ignore_unavailable: Whether specified concrete indices should be
|
|
ignored when unavailable (missing or closed)
|
|
:arg master_timeout: Specify timeout for connection to master
|
|
"""
|
|
if body in SKIP_IN_PATH:
|
|
raise ValueError("Empty value passed for a required argument 'body'.")
|
|
_, data = self.transport.perform_request('PUT', _make_path(index, '_settings'),
|
|
params=params, body=body)
|
|
return data
|
|
|
|
@query_params('allow_no_indices', 'expand_wildcards', 'ignore_unavailable',
|
|
'master_timeout')
|
|
def put_warmer(self, name, body, index=None, doc_type=None, params=None):
|
|
"""
|
|
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>`_
|
|
|
|
:arg name: The name of the warmer
|
|
:arg body: The search request definition for the warmer (query, filters,
|
|
facets, sorting, etc)
|
|
:arg index: A comma-separated list of index names to register the warmer
|
|
for; use `_all` or omit to perform the operation on all indices
|
|
:arg doc_type: A comma-separated list of document types to register the
|
|
warmer for; leave empty to perform the operation on all types
|
|
:arg allow_no_indices: Whether to ignore if a wildcard indices
|
|
expression resolves into no concrete indices in the search request
|
|
to warm. (This includes `_all` string or when no indices have been
|
|
specified)
|
|
:arg expand_wildcards: Whether to expand wildcard expression to concrete
|
|
indices that are open, closed or both, in the search request to
|
|
warm., default u'open'
|
|
:arg ignore_unavailable: Whether specified concrete indices should be
|
|
ignored when unavailable (missing or closed) in the search request
|
|
to warm
|
|
:arg master_timeout: Specify timeout for connection to master
|
|
"""
|
|
for param in (name, body):
|
|
if param in SKIP_IN_PATH:
|
|
raise ValueError("Empty value passed for a required argument.")
|
|
if doc_type and not index:
|
|
index = '_all'
|
|
_, data = self.transport.perform_request('PUT', _make_path(index, doc_type, '_warmer', name),
|
|
params=params, body=body)
|
|
return data
|
|
|
|
@query_params('allow_no_indices', 'expand_wildcards', 'ignore_unavailable',
|
|
'local')
|
|
def get_warmer(self, index=None, doc_type=None, name=None, params=None):
|
|
"""
|
|
Retreieve an index warmer.
|
|
`<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-warmers.html>`_
|
|
|
|
:arg index: A comma-separated list of index names to restrict the
|
|
operation; use `_all` to perform the operation on all indices
|
|
:arg doc_type: A comma-separated list of document types to restrict the
|
|
operation; leave empty to perform the operation on all types
|
|
:arg name: The name of the warmer (supports wildcards); leave empty to
|
|
get all warmers
|
|
:arg allow_no_indices: Whether to ignore if a wildcard indices
|
|
expression resolves into no concrete indices. (This includes `_all`
|
|
string or when no indices have been specified)
|
|
:arg expand_wildcards: Whether to expand wildcard expression to concrete
|
|
indices that are open, closed or both., default u'open'
|
|
:arg ignore_unavailable: Whether specified concrete indices should be
|
|
ignored when unavailable (missing or closed)
|
|
:arg local: Return local information, do not retrieve the state from
|
|
master node (default: false)
|
|
"""
|
|
_, data = self.transport.perform_request('GET', _make_path(index, doc_type, '_warmer', name), params=params)
|
|
return data
|
|
|
|
@query_params('master_timeout')
|
|
def delete_warmer(self, index, name, params=None):
|
|
"""
|
|
Delete an index warmer.
|
|
`<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-warmers.html>`_
|
|
|
|
:arg index: A comma-separated list of index names to delete warmers from
|
|
(supports wildcards); use `_all` to perform the operation on all indices.
|
|
:arg name: A comma-separated list of warmer names to delete (supports
|
|
wildcards); use `_all` to delete all warmers in the specified indices.
|
|
:arg master_timeout: Specify timeout for connection to master
|
|
"""
|
|
for param in (index, name):
|
|
if param in SKIP_IN_PATH:
|
|
raise ValueError("Empty value passed for a required argument.")
|
|
_, data = self.transport.perform_request('DELETE', _make_path(index, '_warmer', name),
|
|
params=params)
|
|
return data
|
|
|
|
@query_params('allow_no_indices', 'expand_wildcards', 'ignore_indices',
|
|
'ignore_unavailable', 'operation_threading', 'recovery', 'snapshot', 'human')
|
|
def status(self, index=None, params=None):
|
|
"""
|
|
Get a comprehensive status information of one or more indices.
|
|
`<http://elasticsearch.org/guide/reference/api/admin-indices-_/>`_
|
|
|
|
:arg index: A comma-separated list of index names; use `_all` or empty
|
|
string to perform the operation on all indices
|
|
:arg allow_no_indices: Whether to ignore if a wildcard indices
|
|
expression resolves into no concrete indices. (This includes `_all` string or
|
|
when no indices have been specified)
|
|
:arg expand_wildcards: Whether to expand wildcard expression to concrete indices
|
|
that are open, closed or both.
|
|
:arg ignore_indices: When performed on multiple indices, allows to
|
|
ignore `missing` ones, default u'none'
|
|
:arg ignore_unavailable: Whether specified concrete indices should be ignored
|
|
when unavailable (missing or closed)
|
|
:arg operation_threading: TODO: ?
|
|
:arg recovery: Return information about shard recovery
|
|
:arg snapshot: TODO: ?
|
|
:arg human: Whether to return time and byte values in human-readable format.
|
|
"""
|
|
_, data = self.transport.perform_request('GET', _make_path(index, '_status'),
|
|
params=params)
|
|
return data
|
|
|
|
@query_params('completion_fields', 'docs', 'fielddata_fields', 'fields', 'groups',
|
|
'allow_no_indices', 'expand_wildcards', 'ignore_indices',
|
|
'ignore_unavailable', 'human', 'level', 'types')
|
|
def stats(self, index=None, metric=None, params=None):
|
|
"""
|
|
Retrieve statistics on different operations happening on an index.
|
|
`<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-stats.html>`_
|
|
|
|
:arg index: A comma-separated list of index names; use `_all` or empty
|
|
string to perform the operation on all indices
|
|
:arg metric: A comma-separated list of metrics to display. Possible
|
|
values: "_all", "completion", "docs", "fielddata", "filter_cache",
|
|
"flush", "get", "id_cache", "indexing", "merge", "percolate",
|
|
"refresh", "search", "segments", "store", "warmer"
|
|
:arg completion_fields: A comma-separated list of fields for
|
|
`completion` metric (supports wildcards)
|
|
:arg fielddata_fields: A comma-separated list of fields for `fielddata`
|
|
metric (supports wildcards)
|
|
:arg fields: A comma-separated list of fields for `fielddata` and
|
|
`completion` metric (supports wildcards)
|
|
:arg groups: A comma-separated list of search groups for `search` statistics
|
|
:arg allow_no_indices: Whether to ignore if a wildcard indices
|
|
expression resolves into no concrete indices. (This includes `_all` string or
|
|
when no indices have been specified)
|
|
:arg expand_wildcards: Whether to expand wildcard expression to concrete indices
|
|
that are open, closed or both.
|
|
:arg ignore_indices: When performed on multiple indices, allows to
|
|
ignore `missing` ones (default: none)
|
|
:arg ignore_unavailable: Whether specified concrete indices should be ignored
|
|
when unavailable (missing or closed)
|
|
:arg human: Whether to return time and byte values in human-readable format.
|
|
:arg level: Return stats aggregated at cluster, index or shard level.
|
|
("cluster", "indices" or "shards", default: "indices")
|
|
:arg types: A comma-separated list of document types for the `indexing`
|
|
index metric
|
|
"""
|
|
_, data = self.transport.perform_request('GET', _make_path(index, '_stats', metric),
|
|
params=params)
|
|
return data
|
|
|
|
@query_params('allow_no_indices', 'expand_wildcards', 'ignore_indices',
|
|
'ignore_unavailable', 'human')
|
|
def segments(self, index=None, params=None):
|
|
"""
|
|
Provide low level segments information that a Lucene index (shard level) is built with.
|
|
`<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-segments.html>`_
|
|
|
|
:arg index: A comma-separated list of index names; use `_all` or empty
|
|
string to perform the operation on all indices
|
|
:arg allow_no_indices: Whether to ignore if a wildcard indices
|
|
expression resolves into no concrete indices. (This includes `_all` string or
|
|
when no indices have been specified)
|
|
:arg expand_wildcards: Whether to expand wildcard expression to concrete indices
|
|
that are open, closed or both.
|
|
:arg ignore_indices: When performed on multiple indices, allows to
|
|
ignore `missing` ones, default u'none'
|
|
:arg ignore_unavailable: Whether specified concrete indices should be ignored
|
|
when unavailable (missing or closed)
|
|
:arg human: Whether to return time and byte values in human-readable
|
|
format (default: false)
|
|
"""
|
|
_, data = self.transport.perform_request('GET', _make_path(index, '_segments'), params=params)
|
|
return data
|
|
|
|
@query_params('flush', 'allow_no_indices', 'expand_wildcards',
|
|
'ignore_indices', 'ignore_unavailable', 'max_num_segments',
|
|
'only_expunge_deletes', 'operation_threading', 'wait_for_merge')
|
|
def optimize(self, index=None, params=None):
|
|
"""
|
|
Explicitly optimize one or more indices through an API.
|
|
`<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-optimize.html>`_
|
|
|
|
:arg index: A comma-separated list of index names; use `_all` or empty
|
|
string to perform the operation on all indices
|
|
:arg flush: Specify whether the index should be flushed after
|
|
performing the operation (default: true)
|
|
:arg allow_no_indices: Whether to ignore if a wildcard indices
|
|
expression resolves into no concrete indices. (This includes `_all` string or
|
|
when no indices have been specified)
|
|
:arg expand_wildcards: Whether to expand wildcard expression to concrete indices
|
|
that are open, closed or both.
|
|
:arg ignore_indices: When performed on multiple indices, allows to
|
|
ignore `missing` ones, default u'none'
|
|
:arg ignore_unavailable: Whether specified concrete indices should be ignored
|
|
when unavailable (missing or closed)
|
|
:arg max_num_segments: The number of segments the index should be
|
|
merged into (default: dynamic)
|
|
:arg only_expunge_deletes: Specify whether the operation should only
|
|
expunge deleted documents
|
|
:arg operation_threading: TODO: ?
|
|
:arg wait_for_merge: Specify whether the request should block until the
|
|
merge process is finished (default: true)
|
|
"""
|
|
_, data = self.transport.perform_request('POST', _make_path(index, '_optimize'), params=params)
|
|
return data
|
|
|
|
@query_params('explain', 'allow_no_indices', 'expand_wildcards',
|
|
'ignore_indices', 'ignore_unavailable', 'operation_threading', 'q',
|
|
'source')
|
|
def validate_query(self, index=None, doc_type=None, body=None, params=None):
|
|
"""
|
|
Validate a potentially expensive query without executing it.
|
|
`<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-validate.html>`_
|
|
|
|
:arg index: A comma-separated list of index names to restrict the operation;
|
|
use `_all` or empty string to perform the operation on all indices
|
|
:arg doc_type: A comma-separated list of document types to restrict the
|
|
operation; leave empty to perform the operation on all types
|
|
:arg body: The query definition
|
|
:arg explain: Return detailed information about the error
|
|
:arg allow_no_indices: Whether to ignore if a wildcard indices
|
|
expression resolves into no concrete indices. (This includes `_all` string or
|
|
when no indices have been specified)
|
|
:arg expand_wildcards: Whether to expand wildcard expression to concrete indices
|
|
that are open, closed or both.
|
|
:arg ignore_indices: When performed on multiple indices, allows to
|
|
ignore `missing` ones (default: none)
|
|
:arg ignore_unavailable: Whether specified concrete indices should be ignored
|
|
when unavailable (missing or closed)
|
|
:arg operation_threading: TODO: ?
|
|
:arg q: Query in the Lucene query string syntax
|
|
:arg source: The URL-encoded query definition (instead of using the
|
|
request body)
|
|
"""
|
|
_, data = self.transport.perform_request('GET', _make_path(index, doc_type, '_validate', 'query'),
|
|
params=params, body=body)
|
|
return data
|
|
|
|
@query_params('field_data', 'fielddata', 'fields', 'filter', 'filter_cache',
|
|
'filter_keys', 'id', 'id_cache', 'allow_no_indices', 'expand_wildcards',
|
|
'ignore_indices', 'ignore_unavailable', 'recycler')
|
|
def clear_cache(self, index=None, params=None):
|
|
"""
|
|
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>`_
|
|
|
|
:arg index: A comma-separated list of index name to limit the operation
|
|
:arg field_data: Clear field data
|
|
:arg fielddata: Clear field data
|
|
:arg fields: A comma-separated list of fields to clear when using the
|
|
`field_data` parameter (default: all)
|
|
:arg filter: Clear filter caches
|
|
:arg filter_cache: Clear filter caches
|
|
:arg filter_keys: A comma-separated list of keys to clear when using
|
|
the `filter_cache` parameter (default: all)
|
|
:arg id: Clear ID caches for parent/child
|
|
:arg id_cache: Clear ID caches for parent/child
|
|
:arg allow_no_indices: Whether to ignore if a wildcard indices
|
|
expression resolves into no concrete indices. (This includes `_all` string or
|
|
when no indices have been specified)
|
|
:arg expand_wildcards: Whether to expand wildcard expression to concrete indices
|
|
that are open, closed or both.
|
|
:arg ignore_indices: When performed on multiple indices, allows to
|
|
ignore `missing` ones (default: none)
|
|
:arg ignore_unavailable: Whether specified concrete indices should be ignored
|
|
when unavailable (missing or closed)
|
|
:arg recycler: Clear the recycler cache
|
|
"""
|
|
_, data = self.transport.perform_request('POST', _make_path(index, '_cache', 'clear'),
|
|
params=params)
|
|
return data
|
|
|
|
@query_params('active_only', 'detailed', 'human')
|
|
def recovery(self, index=None, params=None):
|
|
"""
|
|
The indices recovery API provides insight into on-going shard
|
|
recoveries. Recovery status may be reported for specific indices, or
|
|
cluster-wide.
|
|
`<http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/indices-recovery.html>`_
|
|
|
|
:arg index: A comma-separated list of index names; use `_all` or empty
|
|
string to perform the operation on all indices
|
|
:arg active_only: Display only those recoveries that are currently on-
|
|
going (default: 'false')
|
|
:arg detailed: Whether to display detailed information about shard
|
|
recovery (default: 'false')
|
|
:arg human: Whether to return time and byte values in human-readable
|
|
format. (default: 'false')
|
|
|
|
"""
|
|
_, data = self.transport.perform_request('GET', _make_path(index,
|
|
'_recovery'), params=params)
|
|
return data
|
|
|
|
@query_params('allow_no_indices', 'expand_wildcards', 'ignore_indices', 'ignore_unavailable')
|
|
def snapshot_index(self, index=None, params=None):
|
|
"""
|
|
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>`_
|
|
|
|
:arg index: A comma-separated list of index names; use `_all` or empty
|
|
string for all indices
|
|
:arg allow_no_indices: Whether to ignore if a wildcard indices
|
|
expression resolves into no concrete indices. (This includes `_all` string or
|
|
when no indices have been specified)
|
|
:arg expand_wildcards: Whether to expand wildcard expression to concrete indices
|
|
that are open, closed or both.
|
|
:arg ignore_indices: When performed on multiple indices, allows to
|
|
ignore `missing` ones (default: none)
|
|
:arg ignore_unavailable: Whether specified concrete indices should be ignored
|
|
when unavailable (missing or closed)
|
|
"""
|
|
_, data = self.transport.perform_request('POST',
|
|
_make_path(index, '_gateway', 'snapshot'), params=params)
|
|
return data
|
|
|
|
@query_params('allow_no_indices', 'expand_wildcards', 'ignore_unavailable',
|
|
'wait_for_completion')
|
|
def upgrade(self, index=None, params=None):
|
|
"""
|
|
Upgrade one or more indices to the latest format through an API.
|
|
`<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-upgrade.html>`_
|
|
|
|
:arg index: A comma-separated list of index names; use `_all` or empty
|
|
string to perform the operation on all indices
|
|
:arg allow_no_indices: Whether to ignore if a wildcard indices
|
|
expression resolves into no concrete indices. (This includes `_all`
|
|
string or when no indices have been specified)
|
|
:arg expand_wildcards: Whether to expand wildcard expression to concrete
|
|
indices that are open, closed or both., default u'open'
|
|
:arg ignore_unavailable: Whether specified concrete indices should be
|
|
ignored when unavailable (missing or closed)
|
|
:arg wait_for_completion: Specify whether the request should block until
|
|
the all segments are upgraded (default: false)
|
|
"""
|
|
_, data = self.transport.perform_request('POST', _make_path(index,
|
|
'_upgrade'), params=params)
|
|
return data
|
|
|
|
@query_params('allow_no_indices', 'expand_wildcards', 'human',
|
|
'ignore_unavailable')
|
|
def get_upgrade(self, index=None, params=None):
|
|
"""
|
|
Monitor how much of one or more index is upgraded.
|
|
`<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-upgrade.html>`_
|
|
|
|
:arg index: A comma-separated list of index names; use `_all` or empty
|
|
string to perform the operation on all indices
|
|
:arg allow_no_indices: Whether to ignore if a wildcard indices
|
|
expression resolves into no concrete indices. (This includes `_all`
|
|
string or when no indices have been specified)
|
|
:arg expand_wildcards: Whether to expand wildcard expression to concrete
|
|
indices that are open, closed or both., default u'open'
|
|
:arg human: Whether to return time and byte values in human-readable
|
|
format., default False
|
|
:arg ignore_unavailable: Whether specified concrete indices should be
|
|
ignored when unavailable (missing or closed)
|
|
"""
|
|
_, data = self.transport.perform_request('GET', _make_path(index,
|
|
'_upgrade'), params=params)
|
|
return data
|