first pass for 6.0 compatibility
This commit is contained in:
@@ -238,15 +238,15 @@ class Elasticsearch(object):
|
|||||||
:arg refresh: If `true` then refresh the affected shards to make this
|
:arg refresh: If `true` then refresh the affected shards to make this
|
||||||
operation visible to search, if `wait_for` then wait for a refresh
|
operation visible to search, if `wait_for` then wait for a refresh
|
||||||
to make this operation visible to search, if `false` (the default)
|
to make this operation visible to search, if `false` (the default)
|
||||||
then do nothing with refreshes., valid choices are: u'true',
|
then do nothing with refreshes., valid choices are: 'true', 'false',
|
||||||
u'false', u'wait_for'
|
'wait_for'
|
||||||
:arg routing: Specific routing value
|
:arg routing: Specific routing value
|
||||||
:arg timeout: Explicit operation timeout
|
:arg timeout: Explicit operation timeout
|
||||||
:arg timestamp: Explicit timestamp for the document
|
:arg timestamp: Explicit timestamp for the document
|
||||||
:arg ttl: Expiration time for the document
|
:arg ttl: Expiration time for the document
|
||||||
:arg version: Explicit version number for concurrency control
|
:arg version: Explicit version number for concurrency control
|
||||||
:arg version_type: Specific version type, valid choices are:
|
:arg version_type: Specific version type, valid choices are: 'internal',
|
||||||
u'internal', u'external', u'external_gte', u'force'
|
'external', 'external_gte', 'force'
|
||||||
:arg wait_for_active_shards: Sets the number of shard copies that must
|
:arg wait_for_active_shards: Sets the number of shard copies that must
|
||||||
be active before proceeding with the index operation. Defaults to 1,
|
be active before proceeding with the index operation. Defaults to 1,
|
||||||
meaning the primary shard only. Set to `all` for all shard copies,
|
meaning the primary shard only. Set to `all` for all shard copies,
|
||||||
@@ -278,8 +278,8 @@ class Elasticsearch(object):
|
|||||||
:arg refresh: If `true` then refresh the affected shards to make this
|
:arg refresh: If `true` then refresh the affected shards to make this
|
||||||
operation visible to search, if `wait_for` then wait for a refresh
|
operation visible to search, if `wait_for` then wait for a refresh
|
||||||
to make this operation visible to search, if `false` (the default)
|
to make this operation visible to search, if `false` (the default)
|
||||||
then do nothing with refreshes., valid choices are: u'true',
|
then do nothing with refreshes., valid choices are: 'true', 'false',
|
||||||
u'false', u'wait_for'
|
'wait_for'
|
||||||
:arg routing: Specific routing value
|
:arg routing: Specific routing value
|
||||||
:arg timeout: Explicit operation timeout
|
:arg timeout: Explicit operation timeout
|
||||||
:arg timestamp: Explicit timestamp for the document
|
:arg timestamp: Explicit timestamp for the document
|
||||||
@@ -375,15 +375,15 @@ class Elasticsearch(object):
|
|||||||
@query_params('_source', '_source_exclude', '_source_include', 'parent',
|
@query_params('_source', '_source_exclude', '_source_include', 'parent',
|
||||||
'preference', 'realtime', 'refresh', 'routing', 'stored_fields',
|
'preference', 'realtime', 'refresh', 'routing', 'stored_fields',
|
||||||
'version', 'version_type')
|
'version', 'version_type')
|
||||||
def get(self, index, id, doc_type='_all', params=None):
|
def get(self, index, doc_type, id, params=None):
|
||||||
"""
|
"""
|
||||||
Get a typed JSON document from the index based on its id.
|
Get a typed JSON document from the index based on its id.
|
||||||
`<http://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html>`_
|
`<http://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html>`_
|
||||||
|
|
||||||
:arg index: The name of the index
|
:arg index: The name of the index
|
||||||
:arg id: The document ID
|
|
||||||
:arg doc_type: The type of the document (use `_all` to fetch the first
|
:arg doc_type: The type of the document (use `_all` to fetch the first
|
||||||
document matching the ID across all types)
|
document matching the ID across all types)
|
||||||
|
:arg id: The document ID
|
||||||
:arg _source: True or false to return the _source field or not, or a
|
:arg _source: True or false to return the _source field or not, or a
|
||||||
list of fields to return
|
list of fields to return
|
||||||
:arg _source_exclude: A list of fields to exclude from the returned
|
:arg _source_exclude: A list of fields to exclude from the returned
|
||||||
@@ -447,7 +447,7 @@ class Elasticsearch(object):
|
|||||||
doc_type, id, '_source'), params=params)
|
doc_type, id, '_source'), params=params)
|
||||||
|
|
||||||
@query_params('_source', '_source_exclude', '_source_include', 'preference',
|
@query_params('_source', '_source_exclude', '_source_include', 'preference',
|
||||||
'realtime', 'refresh', 'stored_fields')
|
'realtime', 'refresh', 'routing', 'stored_fields')
|
||||||
def mget(self, body, index=None, doc_type=None, params=None):
|
def mget(self, body, index=None, doc_type=None, params=None):
|
||||||
"""
|
"""
|
||||||
Get multiple documents based on an index, type (optional) and ids.
|
Get multiple documents based on an index, type (optional) and ids.
|
||||||
@@ -470,6 +470,7 @@ class Elasticsearch(object):
|
|||||||
search mode
|
search mode
|
||||||
:arg refresh: Refresh the shard containing the document before
|
:arg refresh: Refresh the shard containing the document before
|
||||||
performing the operation
|
performing the operation
|
||||||
|
:arg routing: Specific routing value
|
||||||
:arg stored_fields: A comma-separated list of stored fields to return in
|
:arg stored_fields: A comma-separated list of stored fields to return in
|
||||||
the response
|
the response
|
||||||
"""
|
"""
|
||||||
@@ -529,12 +530,12 @@ class Elasticsearch(object):
|
|||||||
@query_params('_source', '_source_exclude', '_source_include',
|
@query_params('_source', '_source_exclude', '_source_include',
|
||||||
'allow_no_indices', 'analyze_wildcard', 'analyzer',
|
'allow_no_indices', 'analyze_wildcard', 'analyzer',
|
||||||
'batched_reduce_size', 'default_operator', 'df', 'docvalue_fields',
|
'batched_reduce_size', 'default_operator', 'df', 'docvalue_fields',
|
||||||
'expand_wildcards', 'explain', 'fielddata_fields', 'from_',
|
'expand_wildcards', 'explain', 'from_', 'ignore_unavailable', 'lenient',
|
||||||
'ignore_unavailable', 'lenient', 'lowercase_expanded_terms',
|
'max_concurrent_shard_requests', 'pre_filter_shard_size', 'preference',
|
||||||
'preference', 'q', 'request_cache', 'routing', 'scroll',
|
'q', 'request_cache', 'routing', 'scroll', 'search_type', 'size',
|
||||||
'search_type', 'size', 'sort', 'stats', 'stored_fields',
|
'sort', 'stats', 'stored_fields', 'suggest_field', 'suggest_mode',
|
||||||
'suggest_field', 'suggest_mode', 'suggest_size', 'suggest_text',
|
'suggest_size', 'suggest_text', 'terminate_after', 'timeout',
|
||||||
'terminate_after', 'timeout', 'track_scores', 'typed_keys', 'version')
|
'track_scores', 'track_total_hits', 'typed_keys', 'version')
|
||||||
def search(self, index=None, doc_type=None, body=None, params=None):
|
def search(self, index=None, doc_type=None, body=None, params=None):
|
||||||
"""
|
"""
|
||||||
Execute a search query and get back search hits that match the query.
|
Execute a search query and get back search hits that match the query.
|
||||||
@@ -573,15 +574,23 @@ class Elasticsearch(object):
|
|||||||
choices are: 'open', 'closed', 'none', 'all'
|
choices are: 'open', 'closed', 'none', 'all'
|
||||||
:arg explain: Specify whether to return detailed information about score
|
:arg explain: Specify whether to return detailed information about score
|
||||||
computation as part of a hit
|
computation as part of a hit
|
||||||
:arg fielddata_fields: A comma-separated list of fields to return as the
|
|
||||||
docvalue representation of a field for each hit
|
|
||||||
:arg from\_: Starting offset (default: 0)
|
:arg from\_: Starting offset (default: 0)
|
||||||
:arg ignore_unavailable: Whether specified concrete indices should be
|
:arg ignore_unavailable: Whether specified concrete indices should be
|
||||||
ignored when unavailable (missing or closed)
|
ignored when unavailable (missing or closed)
|
||||||
:arg lenient: Specify whether format-based query failures (such as
|
:arg lenient: Specify whether format-based query failures (such as
|
||||||
providing text to a numeric field) should be ignored
|
providing text to a numeric field) should be ignored
|
||||||
:arg lowercase_expanded_terms: Specify whether query terms should be
|
:arg max_concurrent_shard_requests: The number of concurrent shard
|
||||||
lowercased
|
requests this search executes concurrently. This value should be
|
||||||
|
used to limit the impact of the search on the cluster in order to
|
||||||
|
limit the number of concurrent shard requests, default 'The default
|
||||||
|
grows with the number of nodes in the cluster but is at most 256.'
|
||||||
|
:arg pre_filter_shard_size: A threshold that enforces a pre-filter
|
||||||
|
roundtrip to prefilter search shards based on query rewriting if
|
||||||
|
the number of shards the search request expands to exceeds the
|
||||||
|
threshold. This filter roundtrip can limit the number of shards
|
||||||
|
significantly if for instance a shard can not match any documents
|
||||||
|
based on it's rewrite method ie. if date filters are mandatory to
|
||||||
|
match but the shard bounds and the query are disjoint., default 128
|
||||||
:arg preference: Specify the node or shard the operation should be
|
:arg preference: Specify the node or shard the operation should be
|
||||||
performed on (default: random)
|
performed on (default: random)
|
||||||
:arg q: Query in the Lucene query string syntax
|
:arg q: Query in the Lucene query string syntax
|
||||||
@@ -610,6 +619,8 @@ class Elasticsearch(object):
|
|||||||
:arg timeout: Explicit operation timeout
|
:arg timeout: Explicit operation timeout
|
||||||
:arg track_scores: Whether to calculate and return scores even if they
|
:arg track_scores: Whether to calculate and return scores even if they
|
||||||
are not used for sorting
|
are not used for sorting
|
||||||
|
:arg track_total_hits: Indicate if the number of documents that match
|
||||||
|
the query should be tracked
|
||||||
:arg typed_keys: Specify whether aggregation and suggester names should
|
:arg typed_keys: Specify whether aggregation and suggester names should
|
||||||
be prefixed by their respective types in the response
|
be prefixed by their respective types in the response
|
||||||
:arg version: Specify whether to return document version as part of a
|
:arg version: Specify whether to return document version as part of a
|
||||||
@@ -626,13 +637,11 @@ class Elasticsearch(object):
|
|||||||
|
|
||||||
@query_params('_source', '_source_exclude', '_source_include',
|
@query_params('_source', '_source_exclude', '_source_include',
|
||||||
'allow_no_indices', 'analyze_wildcard', 'analyzer', 'conflicts',
|
'allow_no_indices', 'analyze_wildcard', 'analyzer', 'conflicts',
|
||||||
'default_operator', 'df', 'docvalue_fields', 'expand_wildcards',
|
'default_operator', 'df', 'expand_wildcards', 'from_',
|
||||||
'explain', 'fielddata_fields', 'from_', 'ignore_unavailable', 'lenient',
|
'ignore_unavailable', 'lenient', 'pipeline', 'preference', 'q',
|
||||||
'lowercase_expanded_terms', 'pipeline', 'preference', 'q', 'refresh',
|
'refresh', 'request_cache', 'requests_per_second', 'routing', 'scroll',
|
||||||
'request_cache', 'requests_per_second', 'routing', 'scroll',
|
'scroll_size', 'search_timeout', 'search_type', 'size', 'slices',
|
||||||
'scroll_size', 'search_timeout', 'search_type', 'size', 'sort', 'stats',
|
'sort', 'stats', 'terminate_after', 'timeout', 'version',
|
||||||
'stored_fields', 'suggest_field', 'suggest_mode', 'suggest_size',
|
|
||||||
'suggest_text', 'terminate_after', 'timeout', 'track_scores', 'version',
|
|
||||||
'version_type', 'wait_for_active_shards', 'wait_for_completion')
|
'version_type', 'wait_for_active_shards', 'wait_for_completion')
|
||||||
def update_by_query(self, index, doc_type=None, body=None, params=None):
|
def update_by_query(self, index, doc_type=None, body=None, params=None):
|
||||||
"""
|
"""
|
||||||
@@ -656,28 +665,20 @@ class Elasticsearch(object):
|
|||||||
:arg analyze_wildcard: Specify whether wildcard and prefix queries
|
:arg analyze_wildcard: Specify whether wildcard and prefix queries
|
||||||
should be analyzed (default: false)
|
should be analyzed (default: false)
|
||||||
:arg analyzer: The analyzer to use for the query string
|
:arg analyzer: The analyzer to use for the query string
|
||||||
:arg conflicts: What to do when the reindex hits version conflicts?,
|
:arg conflicts: What to do when the update by query hits version
|
||||||
default 'abort', valid choices are: 'abort', 'proceed'
|
conflicts?, default 'abort', valid choices are: 'abort', 'proceed'
|
||||||
:arg default_operator: The default operator for query string query (AND
|
:arg default_operator: The default operator for query string query (AND
|
||||||
or OR), default 'OR', valid choices are: 'AND', 'OR'
|
or OR), default 'OR', valid choices are: 'AND', 'OR'
|
||||||
:arg df: The field to use as default where no field prefix is given in
|
:arg df: The field to use as default where no field prefix is given in
|
||||||
the query string
|
the query string
|
||||||
:arg docvalue_fields: A comma-separated list of fields to return as the
|
|
||||||
docvalue representation of a field for each hit
|
|
||||||
:arg expand_wildcards: Whether to expand wildcard expression to concrete
|
:arg expand_wildcards: Whether to expand wildcard expression to concrete
|
||||||
indices that are open, closed or both., default 'open', valid
|
indices that are open, closed or both., default 'open', valid
|
||||||
choices are: 'open', 'closed', 'none', 'all'
|
choices are: 'open', 'closed', 'none', 'all'
|
||||||
:arg explain: Specify whether to return detailed information about score
|
|
||||||
computation as part of a hit
|
|
||||||
:arg fielddata_fields: A comma-separated list of fields to return as the
|
|
||||||
docvalue representation of a field for each hit
|
|
||||||
:arg from\_: Starting offset (default: 0)
|
:arg from\_: Starting offset (default: 0)
|
||||||
:arg ignore_unavailable: Whether specified concrete indices should be
|
:arg ignore_unavailable: Whether specified concrete indices should be
|
||||||
ignored when unavailable (missing or closed)
|
ignored when unavailable (missing or closed)
|
||||||
:arg lenient: Specify whether format-based query failures (such as
|
:arg lenient: Specify whether format-based query failures (such as
|
||||||
providing text to a numeric field) should be ignored
|
providing text to a numeric field) should be ignored
|
||||||
:arg lowercase_expanded_terms: Specify whether query terms should be
|
|
||||||
lowercased
|
|
||||||
:arg pipeline: Ingest pipeline to set on index requests made by this
|
:arg pipeline: Ingest pipeline to set on index requests made by this
|
||||||
action. (default: none)
|
action. (default: none)
|
||||||
:arg preference: Specify the node or shard the operation should be
|
:arg preference: Specify the node or shard the operation should be
|
||||||
@@ -687,8 +688,7 @@ class Elasticsearch(object):
|
|||||||
:arg request_cache: Specify if request cache should be used for this
|
:arg request_cache: Specify if request cache should be used for this
|
||||||
request or not, defaults to index level setting
|
request or not, defaults to index level setting
|
||||||
:arg requests_per_second: The throttle to set on this request in sub-
|
:arg requests_per_second: The throttle to set on this request in sub-
|
||||||
requests per second. -1 means set no throttle as does "unlimited"
|
requests per second. -1 means no throttle., default 0
|
||||||
which is the only non-float this accepts., default 0
|
|
||||||
:arg routing: A comma-separated list of specific routing values
|
:arg routing: A comma-separated list of specific routing values
|
||||||
:arg scroll: Specify how long a consistent view of the index should be
|
:arg scroll: Specify how long a consistent view of the index should be
|
||||||
maintained for scrolled search
|
maintained for scrolled search
|
||||||
@@ -705,21 +705,11 @@ class Elasticsearch(object):
|
|||||||
:arg sort: A comma-separated list of <field>:<direction> pairs
|
:arg sort: A comma-separated list of <field>:<direction> pairs
|
||||||
:arg stats: Specific 'tag' of the request for logging and statistical
|
:arg stats: Specific 'tag' of the request for logging and statistical
|
||||||
purposes
|
purposes
|
||||||
:arg stored_fields: A comma-separated list of stored fields to return as
|
|
||||||
part of a hit
|
|
||||||
:arg suggest_field: Specify which field to use for suggestions
|
|
||||||
:arg suggest_mode: Specify suggest mode, default 'missing', valid
|
|
||||||
choices are: 'missing', 'popular', 'always'
|
|
||||||
:arg suggest_size: How many suggestions to return in response
|
|
||||||
:arg suggest_text: The source text for which the suggestions should be
|
|
||||||
returned
|
|
||||||
:arg terminate_after: The maximum number of documents to collect for
|
:arg terminate_after: The maximum number of documents to collect for
|
||||||
each shard, upon reaching which the query execution will terminate
|
each shard, upon reaching which the query execution will terminate
|
||||||
early.
|
early.
|
||||||
:arg timeout: Time each individual bulk request should wait for shards
|
:arg timeout: Time each individual bulk request should wait for shards
|
||||||
that are unavailable., default '1m'
|
that are unavailable., default '1m'
|
||||||
:arg track_scores: Whether to calculate and return scores even if they
|
|
||||||
are not used for sorting
|
|
||||||
:arg version: Specify whether to return document version as part of a
|
:arg version: Specify whether to return document version as part of a
|
||||||
hit
|
hit
|
||||||
:arg version_type: Should the document increment the version number
|
:arg version_type: Should the document increment the version number
|
||||||
@@ -731,7 +721,7 @@ class Elasticsearch(object):
|
|||||||
equal to the total number of copies for the shard (number of
|
equal to the total number of copies for the shard (number of
|
||||||
replicas + 1)
|
replicas + 1)
|
||||||
:arg wait_for_completion: Should the request should block until the
|
:arg wait_for_completion: Should the request should block until the
|
||||||
reindex is complete., default True
|
update by query operation is complete., default True
|
||||||
"""
|
"""
|
||||||
if index in SKIP_IN_PATH:
|
if index in SKIP_IN_PATH:
|
||||||
raise ValueError("Empty value passed for a required argument 'index'.")
|
raise ValueError("Empty value passed for a required argument 'index'.")
|
||||||
@@ -749,8 +739,7 @@ class Elasticsearch(object):
|
|||||||
for the index request.
|
for the index request.
|
||||||
:arg refresh: Should the effected indexes be refreshed?
|
:arg refresh: Should the effected indexes be refreshed?
|
||||||
:arg requests_per_second: The throttle to set on this request in sub-
|
:arg requests_per_second: The throttle to set on this request in sub-
|
||||||
requests per second. -1 means set no throttle as does "unlimited"
|
requests per second. -1 means no throttle., default 0
|
||||||
which is the only non-float this accepts., default 0
|
|
||||||
:arg slices: The number of slices this task should be divided into.
|
:arg slices: The number of slices this task should be divided into.
|
||||||
Defaults to 1 meaning the task isn't sliced into subtasks., default
|
Defaults to 1 meaning the task isn't sliced into subtasks., default
|
||||||
1
|
1
|
||||||
@@ -784,13 +773,11 @@ class Elasticsearch(object):
|
|||||||
|
|
||||||
@query_params('_source', '_source_exclude', '_source_include',
|
@query_params('_source', '_source_exclude', '_source_include',
|
||||||
'allow_no_indices', 'analyze_wildcard', 'analyzer', 'conflicts',
|
'allow_no_indices', 'analyze_wildcard', 'analyzer', 'conflicts',
|
||||||
'default_operator', 'df', 'docvalue_fields', 'expand_wildcards',
|
'default_operator', 'df', 'expand_wildcards', 'from_',
|
||||||
'explain', 'from_', 'ignore_unavailable', 'lenient',
|
'ignore_unavailable', 'lenient', 'preference', 'q', 'refresh',
|
||||||
'lowercase_expanded_terms', 'preference', 'q', 'refresh',
|
'request_cache', 'requests_per_second', 'routing', 'scroll',
|
||||||
'request_cache', 'requests_per_second', 'routing', 'scroll', 'slices',
|
'scroll_size', 'search_timeout', 'search_type', 'size', 'slices',
|
||||||
'scroll_size', 'search_timeout', 'search_type', 'size', 'sort', 'stats',
|
'sort', 'stats', 'terminate_after', 'timeout', 'version',
|
||||||
'stored_fields', 'suggest_field', 'suggest_mode', 'suggest_size',
|
|
||||||
'suggest_text', 'terminate_after', 'timeout', 'track_scores', 'version',
|
|
||||||
'wait_for_active_shards', 'wait_for_completion')
|
'wait_for_active_shards', 'wait_for_completion')
|
||||||
def delete_by_query(self, index, body, doc_type=None, params=None):
|
def delete_by_query(self, index, body, doc_type=None, params=None):
|
||||||
"""
|
"""
|
||||||
@@ -820,20 +807,14 @@ class Elasticsearch(object):
|
|||||||
or OR), default 'OR', valid choices are: 'AND', 'OR'
|
or OR), default 'OR', valid choices are: 'AND', 'OR'
|
||||||
:arg df: The field to use as default where no field prefix is given in
|
:arg df: The field to use as default where no field prefix is given in
|
||||||
the query string
|
the query string
|
||||||
:arg docvalue_fields: A comma-separated list of fields to return as the
|
|
||||||
docvalue representation of a field for each hit
|
|
||||||
:arg expand_wildcards: Whether to expand wildcard expression to concrete
|
:arg expand_wildcards: Whether to expand wildcard expression to concrete
|
||||||
indices that are open, closed or both., default 'open', valid
|
indices that are open, closed or both., default 'open', valid
|
||||||
choices are: 'open', 'closed', 'none', 'all'
|
choices are: 'open', 'closed', 'none', 'all'
|
||||||
:arg explain: Specify whether to return detailed information about score
|
|
||||||
computation as part of a hit
|
|
||||||
:arg from\_: Starting offset (default: 0)
|
:arg from\_: Starting offset (default: 0)
|
||||||
:arg ignore_unavailable: Whether specified concrete indices should be
|
:arg ignore_unavailable: Whether specified concrete indices should be
|
||||||
ignored when unavailable (missing or closed)
|
ignored when unavailable (missing or closed)
|
||||||
:arg lenient: Specify whether format-based query failures (such as
|
:arg lenient: Specify whether format-based query failures (such as
|
||||||
providing text to a numeric field) should be ignored
|
providing text to a numeric field) should be ignored
|
||||||
:arg lowercase_expanded_terms: Specify whether query terms should be
|
|
||||||
lowercased
|
|
||||||
:arg preference: Specify the node or shard the operation should be
|
:arg preference: Specify the node or shard the operation should be
|
||||||
performed on (default: random)
|
performed on (default: random)
|
||||||
:arg q: Query in the Lucene query string syntax
|
:arg q: Query in the Lucene query string syntax
|
||||||
@@ -858,21 +839,11 @@ class Elasticsearch(object):
|
|||||||
:arg sort: A comma-separated list of <field>:<direction> pairs
|
:arg sort: A comma-separated list of <field>:<direction> pairs
|
||||||
:arg stats: Specific 'tag' of the request for logging and statistical
|
:arg stats: Specific 'tag' of the request for logging and statistical
|
||||||
purposes
|
purposes
|
||||||
:arg stored_fields: A comma-separated list of stored fields to return as
|
|
||||||
part of a hit
|
|
||||||
:arg suggest_field: Specify which field to use for suggestions
|
|
||||||
:arg suggest_mode: Specify suggest mode, default 'missing', valid
|
|
||||||
choices are: 'missing', 'popular', 'always'
|
|
||||||
:arg suggest_size: How many suggestions to return in response
|
|
||||||
:arg suggest_text: The source text for which the suggestions should be
|
|
||||||
returned
|
|
||||||
:arg terminate_after: The maximum number of documents to collect for
|
:arg terminate_after: The maximum number of documents to collect for
|
||||||
each shard, upon reaching which the query execution will terminate
|
each shard, upon reaching which the query execution will terminate
|
||||||
early.
|
early.
|
||||||
:arg timeout: Time each individual bulk request should wait for shards
|
:arg timeout: Time each individual bulk request should wait for shards
|
||||||
that are unavailable., default '1m'
|
that are unavailable., default '1m'
|
||||||
:arg track_scores: Whether to calculate and return scores even if they
|
|
||||||
are not used for sorting
|
|
||||||
:arg version: Specify whether to return document version as part of a
|
:arg version: Specify whether to return document version as part of a
|
||||||
hit
|
hit
|
||||||
:arg wait_for_active_shards: Sets the number of shard copies that must
|
:arg wait_for_active_shards: Sets the number of shard copies that must
|
||||||
@@ -901,8 +872,6 @@ class Elasticsearch(object):
|
|||||||
|
|
||||||
:arg index: A comma-separated list of index names to search; use `_all`
|
:arg index: A comma-separated list of index names to search; use `_all`
|
||||||
or empty string to perform the operation on all indices
|
or empty string to perform the operation on all indices
|
||||||
:arg doc_type: A comma-separated list of document types to search; leave
|
|
||||||
empty to perform the operation on all types
|
|
||||||
:arg allow_no_indices: Whether to ignore if a wildcard indices
|
:arg allow_no_indices: Whether to ignore if a wildcard indices
|
||||||
expression resolves into no concrete indices. (This includes `_all`
|
expression resolves into no concrete indices. (This includes `_all`
|
||||||
string or when no indices have been specified)
|
string or when no indices have been specified)
|
||||||
@@ -961,8 +930,7 @@ class Elasticsearch(object):
|
|||||||
|
|
||||||
@query_params('_source', '_source_exclude', '_source_include',
|
@query_params('_source', '_source_exclude', '_source_include',
|
||||||
'analyze_wildcard', 'analyzer', 'default_operator', 'df', 'lenient',
|
'analyze_wildcard', 'analyzer', 'default_operator', 'df', 'lenient',
|
||||||
'lowercase_expanded_terms', 'parent', 'preference', 'q', 'routing',
|
'parent', 'preference', 'q', 'routing', 'stored_fields')
|
||||||
'stored_fields')
|
|
||||||
def explain(self, index, doc_type, id, body=None, params=None):
|
def explain(self, index, doc_type, id, body=None, params=None):
|
||||||
"""
|
"""
|
||||||
The explain api computes a score explanation for a query and a specific
|
The explain api computes a score explanation for a query and a specific
|
||||||
@@ -988,8 +956,6 @@ class Elasticsearch(object):
|
|||||||
:arg df: The default field for query string query (default: _all)
|
:arg df: The default field for query string query (default: _all)
|
||||||
:arg lenient: Specify whether format-based query failures (such as
|
:arg lenient: Specify whether format-based query failures (such as
|
||||||
providing text to a numeric field) should be ignored
|
providing text to a numeric field) should be ignored
|
||||||
:arg lowercase_expanded_terms: Specify whether query terms should be
|
|
||||||
lowercased
|
|
||||||
:arg parent: The ID of the parent document
|
:arg parent: The ID of the parent document
|
||||||
:arg preference: Specify the node or shard the operation should be
|
:arg preference: Specify the node or shard the operation should be
|
||||||
performed on (default: random)
|
performed on (default: random)
|
||||||
@@ -1081,8 +1047,7 @@ class Elasticsearch(object):
|
|||||||
|
|
||||||
@query_params('allow_no_indices', 'analyze_wildcard', 'analyzer',
|
@query_params('allow_no_indices', 'analyze_wildcard', 'analyzer',
|
||||||
'default_operator', 'df', 'expand_wildcards', 'ignore_unavailable',
|
'default_operator', 'df', 'expand_wildcards', 'ignore_unavailable',
|
||||||
'lenient', 'lowercase_expanded_terms', 'min_score', 'preference', 'q',
|
'lenient', 'min_score', 'preference', 'q', 'routing')
|
||||||
'routing')
|
|
||||||
def count(self, index=None, doc_type=None, body=None, params=None):
|
def count(self, index=None, doc_type=None, body=None, params=None):
|
||||||
"""
|
"""
|
||||||
Execute a query and get the number of matches for that query.
|
Execute a query and get the number of matches for that query.
|
||||||
@@ -1109,8 +1074,6 @@ class Elasticsearch(object):
|
|||||||
ignored when unavailable (missing or closed)
|
ignored when unavailable (missing or closed)
|
||||||
:arg lenient: Specify whether format-based query failures (such as
|
:arg lenient: Specify whether format-based query failures (such as
|
||||||
providing text to a numeric field) should be ignored
|
providing text to a numeric field) should be ignored
|
||||||
:arg lowercase_expanded_terms: Specify whether query terms should be
|
|
||||||
lowercased
|
|
||||||
:arg min_score: Include only documents with a specific `_score` value in
|
:arg min_score: Include only documents with a specific `_score` value in
|
||||||
the result
|
the result
|
||||||
:arg preference: Specify the node or shard the operation should be
|
:arg preference: Specify the node or shard the operation should be
|
||||||
@@ -1166,7 +1129,8 @@ class Elasticsearch(object):
|
|||||||
return self.transport.perform_request('POST', _make_path(index,
|
return self.transport.perform_request('POST', _make_path(index,
|
||||||
doc_type, '_bulk'), params=params, body=self._bulk_body(body))
|
doc_type, '_bulk'), params=params, body=self._bulk_body(body))
|
||||||
|
|
||||||
@query_params('max_concurrent_searches', 'search_type', 'typed_keys')
|
@query_params('max_concurrent_searches', 'pre_filter_shard_size',
|
||||||
|
'search_type', 'typed_keys')
|
||||||
def msearch(self, body, index=None, doc_type=None, params=None):
|
def msearch(self, body, index=None, doc_type=None, params=None):
|
||||||
"""
|
"""
|
||||||
Execute several search requests within the same API.
|
Execute several search requests within the same API.
|
||||||
@@ -1179,6 +1143,13 @@ class Elasticsearch(object):
|
|||||||
default
|
default
|
||||||
:arg max_concurrent_searches: Controls the maximum number of concurrent
|
:arg max_concurrent_searches: Controls the maximum number of concurrent
|
||||||
searches the multi search api will execute
|
searches the multi search api will execute
|
||||||
|
:arg pre_filter_shard_size: A threshold that enforces a pre-filter
|
||||||
|
roundtrip to prefilter search shards based on query rewriting if
|
||||||
|
the number of shards the search request expands to exceeds the
|
||||||
|
threshold. This filter roundtrip can limit the number of shards
|
||||||
|
significantly if for instance a shard can not match any documents
|
||||||
|
based on it's rewrite method ie. if date filters are mandatory to
|
||||||
|
match but the shard bounds and the query are disjoint., default 128
|
||||||
:arg search_type: Search operation type, valid choices are:
|
:arg search_type: Search operation type, valid choices are:
|
||||||
'query_then_fetch', 'query_and_fetch', 'dfs_query_then_fetch',
|
'query_then_fetch', 'query_and_fetch', 'dfs_query_then_fetch',
|
||||||
'dfs_query_and_fetch'
|
'dfs_query_and_fetch'
|
||||||
@@ -1190,155 +1161,6 @@ class Elasticsearch(object):
|
|||||||
return self.transport.perform_request('GET', _make_path(index,
|
return self.transport.perform_request('GET', _make_path(index,
|
||||||
doc_type, '_msearch'), params=params, body=self._bulk_body(body))
|
doc_type, '_msearch'), params=params, body=self._bulk_body(body))
|
||||||
|
|
||||||
@query_params('allow_no_indices', 'expand_wildcards', 'ignore_unavailable',
|
|
||||||
'preference', 'routing')
|
|
||||||
def suggest(self, body, index=None, params=None):
|
|
||||||
"""
|
|
||||||
The suggest feature suggests similar looking terms based on a provided
|
|
||||||
text by using a suggester.
|
|
||||||
`<http://www.elastic.co/guide/en/elasticsearch/reference/current/search-suggesters.html>`_
|
|
||||||
|
|
||||||
:arg body: The request definition
|
|
||||||
: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 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 'open', valid
|
|
||||||
choices are: 'open', 'closed', 'none', 'all'
|
|
||||||
:arg ignore_unavailable: Whether specified concrete indices should be
|
|
||||||
ignored when unavailable (missing or closed)
|
|
||||||
:arg preference: Specify the node or shard the operation should be
|
|
||||||
performed on (default: random)
|
|
||||||
:arg routing: Specific routing value
|
|
||||||
"""
|
|
||||||
if body in SKIP_IN_PATH:
|
|
||||||
raise ValueError("Empty value passed for a required argument 'body'.")
|
|
||||||
return self.transport.perform_request('POST', _make_path(index,
|
|
||||||
'_suggest'), params=params, body=body)
|
|
||||||
|
|
||||||
@query_params('allow_no_indices', 'expand_wildcards', 'ignore_unavailable',
|
|
||||||
'percolate_format', 'percolate_index', 'percolate_preference',
|
|
||||||
'percolate_routing', 'percolate_type', 'preference', 'routing',
|
|
||||||
'version', 'version_type')
|
|
||||||
def percolate(self, index, doc_type, id=None, body=None, params=None):
|
|
||||||
"""
|
|
||||||
The percolator allows to register queries against an index, and then
|
|
||||||
send percolate requests which include a doc, and getting back the
|
|
||||||
queries that match on that doc out of the set of registered queries.
|
|
||||||
`<http://www.elastic.co/guide/en/elasticsearch/reference/current/search-percolate.html>`_
|
|
||||||
|
|
||||||
:arg index: The index of the document being percolated.
|
|
||||||
:arg doc_type: The type of the document being percolated.
|
|
||||||
:arg id: Substitute the document in the request body with a document
|
|
||||||
that is known by the specified id. On top of the id, the index and
|
|
||||||
type parameter will be used to retrieve the document from within the
|
|
||||||
cluster.
|
|
||||||
:arg body: The percolator request definition using the percolate DSL
|
|
||||||
: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 'open', valid
|
|
||||||
choices are: 'open', 'closed', 'none', 'all'
|
|
||||||
:arg ignore_unavailable: Whether specified concrete indices should be
|
|
||||||
ignored when unavailable (missing or closed)
|
|
||||||
:arg percolate_format: Return an array of matching query IDs instead of
|
|
||||||
objects, valid choices are: 'ids'
|
|
||||||
:arg percolate_index: The index to percolate the document into. Defaults
|
|
||||||
to index.
|
|
||||||
:arg percolate_preference: Which shard to prefer when executing the
|
|
||||||
percolate request.
|
|
||||||
:arg percolate_routing: The routing value to use when percolating the
|
|
||||||
existing document.
|
|
||||||
:arg percolate_type: The type to percolate document into. Defaults to
|
|
||||||
type.
|
|
||||||
:arg preference: Specify the node or shard the operation should be
|
|
||||||
performed on (default: random)
|
|
||||||
:arg routing: A comma-separated list of specific routing values
|
|
||||||
:arg version: Explicit version number for concurrency control
|
|
||||||
:arg version_type: Specific version type, valid choices are: 'internal',
|
|
||||||
'external', 'external_gte', 'force'
|
|
||||||
"""
|
|
||||||
for param in (index, doc_type):
|
|
||||||
if param in SKIP_IN_PATH:
|
|
||||||
raise ValueError("Empty value passed for a required argument.")
|
|
||||||
return self.transport.perform_request('GET', _make_path(index,
|
|
||||||
doc_type, id, '_percolate'), params=params, body=body)
|
|
||||||
|
|
||||||
@query_params('allow_no_indices', 'expand_wildcards', 'ignore_unavailable')
|
|
||||||
def mpercolate(self, body, index=None, doc_type=None, params=None):
|
|
||||||
"""
|
|
||||||
The percolator allows to register queries against an index, and then
|
|
||||||
send percolate requests which include a doc, and getting back the
|
|
||||||
queries that match on that doc out of the set of registered queries.
|
|
||||||
`<http://www.elastic.co/guide/en/elasticsearch/reference/current/search-percolate.html>`_
|
|
||||||
|
|
||||||
:arg body: The percolate request definitions (header & body pair),
|
|
||||||
separated by newlines
|
|
||||||
:arg index: The index of the document being count percolated to use as
|
|
||||||
default
|
|
||||||
:arg doc_type: The type of the document being percolated to use as
|
|
||||||
default.
|
|
||||||
: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 'open', valid
|
|
||||||
choices are: 'open', 'closed', 'none', 'all'
|
|
||||||
:arg ignore_unavailable: Whether specified concrete indices should be
|
|
||||||
ignored when unavailable (missing or closed)
|
|
||||||
"""
|
|
||||||
if body in SKIP_IN_PATH:
|
|
||||||
raise ValueError("Empty value passed for a required argument 'body'.")
|
|
||||||
return self.transport.perform_request('GET', _make_path(index,
|
|
||||||
doc_type, '_mpercolate'), params=params, body=self._bulk_body(body))
|
|
||||||
|
|
||||||
@query_params('allow_no_indices', 'expand_wildcards', 'ignore_unavailable',
|
|
||||||
'percolate_index', 'percolate_type', 'preference', 'routing', 'version',
|
|
||||||
'version_type')
|
|
||||||
def count_percolate(self, index, doc_type, id=None, body=None, params=None):
|
|
||||||
"""
|
|
||||||
The percolator allows to register queries against an index, and then
|
|
||||||
send percolate requests which include a doc, and getting back the
|
|
||||||
queries that match on that doc out of the set of registered queries.
|
|
||||||
`<http://www.elastic.co/guide/en/elasticsearch/reference/current/search-percolate.html>`_
|
|
||||||
|
|
||||||
:arg index: The index of the document being count percolated.
|
|
||||||
:arg doc_type: The type of the document being count percolated.
|
|
||||||
:arg id: Substitute the document in the request body with a document
|
|
||||||
that is known by the specified id. On top of the id, the index and
|
|
||||||
type parameter will be used to retrieve the document from within the
|
|
||||||
cluster.
|
|
||||||
:arg body: The count percolator request definition using the percolate
|
|
||||||
DSL
|
|
||||||
: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 'open', valid
|
|
||||||
choices are: 'open', 'closed', 'none', 'all'
|
|
||||||
:arg ignore_unavailable: Whether specified concrete indices should be
|
|
||||||
ignored when unavailable (missing or closed)
|
|
||||||
:arg percolate_index: The index to count percolate the document into.
|
|
||||||
Defaults to index.
|
|
||||||
:arg percolate_type: The type to count percolate document into. Defaults
|
|
||||||
to type.
|
|
||||||
:arg preference: Specify the node or shard the operation should be
|
|
||||||
performed on (default: random)
|
|
||||||
:arg routing: A comma-separated list of specific routing values
|
|
||||||
:arg version: Explicit version number for concurrency control
|
|
||||||
:arg version_type: Specific version type, valid choices are: 'internal',
|
|
||||||
'external', 'external_gte', 'force'
|
|
||||||
"""
|
|
||||||
for param in (index, doc_type):
|
|
||||||
if param in SKIP_IN_PATH:
|
|
||||||
raise ValueError("Empty value passed for a required argument.")
|
|
||||||
return self.transport.perform_request('GET', _make_path(index,
|
|
||||||
doc_type, id, '_percolate', 'count'), params=params, body=body)
|
|
||||||
|
|
||||||
@query_params('field_statistics', 'fields', 'offsets', 'parent', 'payloads',
|
@query_params('field_statistics', 'fields', 'offsets', 'parent', 'payloads',
|
||||||
'positions', 'preference', 'realtime', 'routing', 'term_statistics',
|
'positions', 'preference', 'realtime', 'routing', 'term_statistics',
|
||||||
'version', 'version_type')
|
'version', 'version_type')
|
||||||
@@ -1438,50 +1260,32 @@ class Elasticsearch(object):
|
|||||||
doc_type, '_mtermvectors'), params=params, body=body)
|
doc_type, '_mtermvectors'), params=params, body=body)
|
||||||
|
|
||||||
@query_params()
|
@query_params()
|
||||||
def put_script(self, lang, id, body, params=None):
|
def put_script(self, id, body, context=None, params=None):
|
||||||
"""
|
"""
|
||||||
Create a script in given language with specified ID.
|
Create a script in given language with specified ID.
|
||||||
`<http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-scripting.html>`_
|
`<http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-scripting.html>`_
|
||||||
|
|
||||||
:arg lang: Script language
|
|
||||||
:arg id: Script ID
|
:arg id: Script ID
|
||||||
:arg body: The document
|
:arg body: The document
|
||||||
"""
|
"""
|
||||||
for param in (lang, id, body):
|
for param in (id, body):
|
||||||
if param in SKIP_IN_PATH:
|
if param in SKIP_IN_PATH:
|
||||||
raise ValueError("Empty value passed for a required argument.")
|
raise ValueError("Empty value passed for a required argument.")
|
||||||
return self.transport.perform_request('PUT', _make_path('_scripts',
|
return self.transport.perform_request('PUT', _make_path('_scripts', id,
|
||||||
lang, id), params=params, body=body)
|
context), params=params, body=body)
|
||||||
|
|
||||||
@query_params()
|
@query_params()
|
||||||
def get_script(self, lang, id, params=None):
|
def get_script(self, id, params=None):
|
||||||
"""
|
"""
|
||||||
Retrieve a script from the API.
|
Retrieve a script from the API.
|
||||||
`<http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-scripting.html>`_
|
`<http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html>`_
|
||||||
|
|
||||||
:arg lang: Script language
|
|
||||||
:arg id: Script ID
|
:arg id: Script ID
|
||||||
"""
|
"""
|
||||||
for param in (lang, id):
|
if id in SKIP_IN_PATH:
|
||||||
if param in SKIP_IN_PATH:
|
raise ValueError("Empty value passed for a required argument 'id'.")
|
||||||
raise ValueError("Empty value passed for a required argument.")
|
return self.transport.perform_request('GET', _make_path('_scripts', id),
|
||||||
return self.transport.perform_request('GET', _make_path('_scripts',
|
params=params)
|
||||||
lang, id), params=params)
|
|
||||||
|
|
||||||
@query_params()
|
|
||||||
def delete_script(self, lang, id, params=None):
|
|
||||||
"""
|
|
||||||
Remove a stored script from elasticsearch.
|
|
||||||
`<http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-scripting.html>`_
|
|
||||||
|
|
||||||
:arg lang: Script language
|
|
||||||
:arg id: Script ID
|
|
||||||
"""
|
|
||||||
for param in (lang, id):
|
|
||||||
if param in SKIP_IN_PATH:
|
|
||||||
raise ValueError("Empty value passed for a required argument.")
|
|
||||||
return self.transport.perform_request('DELETE',
|
|
||||||
_make_path('_scripts', lang, id), params=params)
|
|
||||||
|
|
||||||
@query_params()
|
@query_params()
|
||||||
def put_template(self, id, body, params=None):
|
def put_template(self, id, body, params=None):
|
||||||
@@ -1512,48 +1316,17 @@ class Elasticsearch(object):
|
|||||||
'template', id), params=params)
|
'template', id), params=params)
|
||||||
|
|
||||||
@query_params()
|
@query_params()
|
||||||
def delete_template(self, id, params=None):
|
def delete_script(self, id, params=None):
|
||||||
"""
|
"""
|
||||||
Delete a search template.
|
Remove a stored script from elasticsearch.
|
||||||
`<http://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html>`_
|
`<http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html>`_
|
||||||
|
|
||||||
:arg id: Template ID
|
:arg id: Script ID
|
||||||
"""
|
"""
|
||||||
if id in SKIP_IN_PATH:
|
if id in SKIP_IN_PATH:
|
||||||
raise ValueError("Empty value passed for a required argument 'id'.")
|
raise ValueError("Empty value passed for a required argument 'id'.")
|
||||||
return self.transport.perform_request('DELETE', _make_path('_search',
|
return self.transport.perform_request('DELETE', _make_path('_scripts',
|
||||||
'template', id), params=params)
|
id), params=params)
|
||||||
|
|
||||||
@query_params('allow_no_indices', 'expand_wildcards', 'fields',
|
|
||||||
'ignore_unavailable', 'level')
|
|
||||||
def field_stats(self, index=None, body=None, params=None):
|
|
||||||
"""
|
|
||||||
The field stats api allows one to find statistical properties of a
|
|
||||||
field without executing a search, but looking up measurements that are
|
|
||||||
natively available in the Lucene index.
|
|
||||||
`<http://www.elastic.co/guide/en/elasticsearch/reference/current/search-field-stats.html>`_
|
|
||||||
|
|
||||||
:arg index: A comma-separated list of index names; use `_all` or empty
|
|
||||||
string to perform the operation on all indices
|
|
||||||
:arg body: Field json objects containing the name and optionally a range
|
|
||||||
to filter out indices result, that have results outside the defined
|
|
||||||
bounds
|
|
||||||
: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 'open', valid
|
|
||||||
choices are: 'open', 'closed', 'none', 'all'
|
|
||||||
:arg fields: A comma-separated list of fields for to get field
|
|
||||||
statistics for (min value, max value, and more)
|
|
||||||
:arg ignore_unavailable: Whether specified concrete indices should be
|
|
||||||
ignored when unavailable (missing or closed)
|
|
||||||
:arg level: Defines if field stats should be returned on a per index
|
|
||||||
level or on a cluster wide level, default 'cluster', valid choices
|
|
||||||
are: 'indices', 'cluster'
|
|
||||||
"""
|
|
||||||
return self.transport.perform_request('GET', _make_path(index,
|
|
||||||
'_field_stats'), params=params, body=body)
|
|
||||||
|
|
||||||
@query_params()
|
@query_params()
|
||||||
def render_search_template(self, id=None, body=None, params=None):
|
def render_search_template(self, id=None, body=None, params=None):
|
||||||
@@ -1566,7 +1339,7 @@ class Elasticsearch(object):
|
|||||||
return self.transport.perform_request('GET', _make_path('_render',
|
return self.transport.perform_request('GET', _make_path('_render',
|
||||||
'template', id), params=params, body=body)
|
'template', id), params=params, body=body)
|
||||||
|
|
||||||
@query_params('search_type')
|
@query_params('max_concurrent_searches', 'search_type', 'typed_keys')
|
||||||
def msearch_template(self, body, index=None, doc_type=None, params=None):
|
def msearch_template(self, body, index=None, doc_type=None, params=None):
|
||||||
"""
|
"""
|
||||||
The /_search/template endpoint allows to use the mustache language to
|
The /_search/template endpoint allows to use the mustache language to
|
||||||
@@ -1579,9 +1352,13 @@ class Elasticsearch(object):
|
|||||||
:arg index: A comma-separated list of index names to use as default
|
:arg index: A comma-separated list of index names to use as default
|
||||||
:arg doc_type: A comma-separated list of document types to use as
|
:arg doc_type: A comma-separated list of document types to use as
|
||||||
default
|
default
|
||||||
|
:arg max_concurrent_searches: Controls the maximum number of concurrent
|
||||||
|
searches the multi search api will execute
|
||||||
:arg search_type: Search operation type, valid choices are:
|
:arg search_type: Search operation type, valid choices are:
|
||||||
'query_then_fetch', 'query_and_fetch', 'dfs_query_then_fetch',
|
'query_then_fetch', 'query_and_fetch', 'dfs_query_then_fetch',
|
||||||
'dfs_query_and_fetch'
|
'dfs_query_and_fetch'
|
||||||
|
:arg typed_keys: Specify whether aggregation and suggester names should
|
||||||
|
be prefixed by their respective types in the response
|
||||||
"""
|
"""
|
||||||
if body in SKIP_IN_PATH:
|
if body in SKIP_IN_PATH:
|
||||||
raise ValueError("Empty value passed for a required argument 'body'.")
|
raise ValueError("Empty value passed for a required argument 'body'.")
|
||||||
|
|||||||
@@ -375,7 +375,7 @@ class CatClient(NamespacedClient):
|
|||||||
|
|
||||||
@query_params('format', 'h', 'help', 'ignore_unavailable', 'master_timeout',
|
@query_params('format', 'h', 'help', 'ignore_unavailable', 'master_timeout',
|
||||||
's', 'v')
|
's', 'v')
|
||||||
def snapshots(self, repository=None, params=None):
|
def snapshots(self, repository, params=None):
|
||||||
"""
|
"""
|
||||||
|
|
||||||
`<https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-snapshots.html>`_
|
`<https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-snapshots.html>`_
|
||||||
@@ -393,6 +393,8 @@ class CatClient(NamespacedClient):
|
|||||||
by
|
by
|
||||||
:arg v: Verbose mode. Display column headers, default False
|
:arg v: Verbose mode. Display column headers, default False
|
||||||
"""
|
"""
|
||||||
|
if repository in SKIP_IN_PATH:
|
||||||
|
raise ValueError("Empty value passed for a required argument 'repository'.")
|
||||||
return self.transport.perform_request('GET', _make_path('_cat',
|
return self.transport.perform_request('GET', _make_path('_cat',
|
||||||
'snapshots', repository), params=params)
|
'snapshots', repository), params=params)
|
||||||
|
|
||||||
|
|||||||
@@ -20,7 +20,7 @@ class ClusterClient(NamespacedClient):
|
|||||||
:arg wait_for_active_shards: Wait until the specified number of shards
|
:arg wait_for_active_shards: Wait until the specified number of shards
|
||||||
is active
|
is active
|
||||||
:arg wait_for_events: Wait until all currently queued events with the
|
:arg wait_for_events: Wait until all currently queued events with the
|
||||||
given priorty are processed, valid choices are: 'immediate',
|
given priority are processed, valid choices are: 'immediate',
|
||||||
'urgent', 'high', 'normal', 'low', 'languid'
|
'urgent', 'high', 'normal', 'low', 'languid'
|
||||||
:arg wait_for_no_relocating_shards: Whether to wait until there are no
|
:arg wait_for_no_relocating_shards: Whether to wait until there are no
|
||||||
relocating shards in the cluster
|
relocating shards in the cluster
|
||||||
@@ -75,7 +75,7 @@ class ClusterClient(NamespacedClient):
|
|||||||
return self.transport.perform_request('GET', _make_path('_cluster',
|
return self.transport.perform_request('GET', _make_path('_cluster',
|
||||||
'state', metric, index), params=params)
|
'state', metric, index), params=params)
|
||||||
|
|
||||||
@query_params('flat_settings', 'human', 'timeout')
|
@query_params('flat_settings', 'timeout')
|
||||||
def stats(self, node_id=None, params=None):
|
def stats(self, node_id=None, params=None):
|
||||||
"""
|
"""
|
||||||
The Cluster Stats API allows to retrieve statistics from a cluster wide
|
The Cluster Stats API allows to retrieve statistics from a cluster wide
|
||||||
@@ -88,8 +88,6 @@ class ClusterClient(NamespacedClient):
|
|||||||
node you're connecting to, leave empty to get information from all
|
node you're connecting to, leave empty to get information from all
|
||||||
nodes
|
nodes
|
||||||
:arg flat_settings: Return settings in flat format (default: false)
|
:arg flat_settings: Return settings in flat format (default: false)
|
||||||
:arg human: Whether to return time and byte values in human-readable
|
|
||||||
format., default False
|
|
||||||
:arg timeout: Explicit operation timeout
|
:arg timeout: Explicit operation timeout
|
||||||
"""
|
"""
|
||||||
url = '/_cluster/stats'
|
url = '/_cluster/stats'
|
||||||
@@ -169,4 +167,3 @@ class ClusterClient(NamespacedClient):
|
|||||||
return self.transport.perform_request('GET',
|
return self.transport.perform_request('GET',
|
||||||
'/_cluster/allocation/explain', params=params, body=body)
|
'/_cluster/allocation/explain', params=params, body=body)
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -1,38 +1,24 @@
|
|||||||
from .utils import NamespacedClient, query_params, _make_path, SKIP_IN_PATH
|
from .utils import NamespacedClient, query_params, _make_path, SKIP_IN_PATH
|
||||||
|
|
||||||
class IndicesClient(NamespacedClient):
|
class IndicesClient(NamespacedClient):
|
||||||
@query_params('analyzer', 'attributes', 'char_filter', 'explain', 'field',
|
@query_params('format', 'prefer_local')
|
||||||
'filter', 'format', 'prefer_local', 'text', 'tokenizer')
|
|
||||||
def analyze(self, index=None, body=None, params=None):
|
def analyze(self, index=None, body=None, params=None):
|
||||||
"""
|
"""
|
||||||
Perform the analysis process on a text and return the tokens breakdown of the text.
|
Perform the analysis process on a text and return the tokens breakdown of the text.
|
||||||
`<http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-analyze.html>`_
|
`<http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-analyze.html>`_
|
||||||
|
|
||||||
:arg index: The name of the index to scope the operation
|
:arg index: The name of the index to scope the operation
|
||||||
:arg body: The text on which the analysis should be performed
|
:arg body: Define analyzer/tokenizer parameters and the text on which
|
||||||
:arg analyzer: The name of the analyzer to use
|
the analysis should be performed
|
||||||
:arg attributes: A comma-separated list of token attributes to output,
|
|
||||||
this parameter works only with `explain=true`
|
|
||||||
:arg char_filter: A comma-separated list of character filters to use for
|
|
||||||
the analysis
|
|
||||||
:arg explain: With `true`, outputs more advanced details. (default:
|
|
||||||
false)
|
|
||||||
:arg field: Use the analyzer configured for this field (instead of
|
|
||||||
passing the analyzer name)
|
|
||||||
:arg filter: A comma-separated list of filters to use for the analysis
|
|
||||||
:arg format: Format of the output, default 'detailed', valid choices
|
:arg format: Format of the output, default 'detailed', valid choices
|
||||||
are: 'detailed', 'text'
|
are: 'detailed', 'text'
|
||||||
:arg prefer_local: With `true`, specify that a local shard should be
|
:arg prefer_local: With `true`, specify that a local shard should be
|
||||||
used if available, with `false`, use a random shard (default: true)
|
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
|
|
||||||
"""
|
"""
|
||||||
return self.transport.perform_request('GET', _make_path(index,
|
return self.transport.perform_request('GET', _make_path(index,
|
||||||
'_analyze'), params=params, body=body)
|
'_analyze'), params=params, body=body)
|
||||||
|
|
||||||
@query_params('allow_no_indices', 'expand_wildcards', 'force',
|
@query_params('allow_no_indices', 'expand_wildcards', 'ignore_unavailable')
|
||||||
'ignore_unavailable', 'operation_threading')
|
|
||||||
def refresh(self, index=None, params=None):
|
def refresh(self, index=None, params=None):
|
||||||
"""
|
"""
|
||||||
Explicitly refresh one or more index, making all operations performed
|
Explicitly refresh one or more index, making all operations performed
|
||||||
@@ -47,10 +33,8 @@ class IndicesClient(NamespacedClient):
|
|||||||
:arg expand_wildcards: Whether to expand wildcard expression to concrete
|
:arg expand_wildcards: Whether to expand wildcard expression to concrete
|
||||||
indices that are open, closed or both., default 'open', valid
|
indices that are open, closed or both., default 'open', valid
|
||||||
choices are: 'open', 'closed', 'none', 'all'
|
choices are: 'open', 'closed', 'none', 'all'
|
||||||
:arg force: Force a refresh even if not required, default False
|
|
||||||
:arg ignore_unavailable: Whether specified concrete indices should be
|
:arg ignore_unavailable: Whether specified concrete indices should be
|
||||||
ignored when unavailable (missing or closed)
|
ignored when unavailable (missing or closed)
|
||||||
:arg operation_threading: TODO: ?
|
|
||||||
"""
|
"""
|
||||||
return self.transport.perform_request('POST', _make_path(index,
|
return self.transport.perform_request('POST', _make_path(index,
|
||||||
'_refresh'), params=params)
|
'_refresh'), params=params)
|
||||||
@@ -107,22 +91,19 @@ class IndicesClient(NamespacedClient):
|
|||||||
params=params, body=body)
|
params=params, body=body)
|
||||||
|
|
||||||
@query_params('allow_no_indices', 'expand_wildcards', 'flat_settings',
|
@query_params('allow_no_indices', 'expand_wildcards', 'flat_settings',
|
||||||
'human', 'ignore_unavailable', 'include_defaults', 'local')
|
'ignore_unavailable', 'include_defaults', 'local')
|
||||||
def get(self, index, feature=None, params=None):
|
def get(self, index, feature=None, params=None):
|
||||||
"""
|
"""
|
||||||
The get index API allows to retrieve information about one or more indexes.
|
The get index API allows to retrieve information about one or more indexes.
|
||||||
`<http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-get-index.html>`_
|
`<http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-get-index.html>`_
|
||||||
|
|
||||||
:arg index: A comma-separated list of index names
|
: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
|
:arg allow_no_indices: Ignore if a wildcard expression resolves to no
|
||||||
concrete indices (default: false)
|
concrete indices (default: false)
|
||||||
:arg expand_wildcards: Whether wildcard expressions should get expanded
|
:arg expand_wildcards: Whether wildcard expressions should get expanded
|
||||||
to open or closed indices (default: open), default 'open', valid
|
to open or closed indices (default: open), default 'open', valid
|
||||||
choices are: 'open', 'closed', 'none', 'all'
|
choices are: 'open', 'closed', 'none', 'all'
|
||||||
:arg flat_settings: Return settings in flat format (default: false)
|
:arg flat_settings: Return settings in flat format (default: false)
|
||||||
:arg human: Whether to return version and creation date values in human-
|
|
||||||
readable format., default False
|
|
||||||
:arg ignore_unavailable: Ignore unavailable indexes (default: false)
|
:arg ignore_unavailable: Ignore unavailable indexes (default: false)
|
||||||
:arg include_defaults: Whether to return all default setting for each of
|
:arg include_defaults: Whether to return all default setting for each of
|
||||||
the indices., default False
|
the indices., default False
|
||||||
@@ -183,7 +164,8 @@ class IndicesClient(NamespacedClient):
|
|||||||
return self.transport.perform_request('POST', _make_path(index,
|
return self.transport.perform_request('POST', _make_path(index,
|
||||||
'_close'), params=params)
|
'_close'), params=params)
|
||||||
|
|
||||||
@query_params('master_timeout', 'timeout')
|
@query_params('allow_no_indices', 'expand_wildcards', 'ignore_unavailable',
|
||||||
|
'master_timeout', 'timeout')
|
||||||
def delete(self, index, params=None):
|
def delete(self, index, params=None):
|
||||||
"""
|
"""
|
||||||
Delete an index in Elasticsearch
|
Delete an index in Elasticsearch
|
||||||
@@ -191,6 +173,12 @@ class IndicesClient(NamespacedClient):
|
|||||||
|
|
||||||
:arg index: A comma-separated list of indices to delete; use `_all` or
|
:arg index: A comma-separated list of indices to delete; use `_all` or
|
||||||
`*` string to delete all indices
|
`*` string to delete all indices
|
||||||
|
: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), default 'open', valid
|
||||||
|
choices are: 'open', 'closed', 'none', 'all'
|
||||||
|
:arg ignore_unavailable: Ignore unavailable indexes (default: false)
|
||||||
:arg master_timeout: Specify timeout for connection to master
|
:arg master_timeout: Specify timeout for connection to master
|
||||||
:arg timeout: Explicit operation timeout
|
:arg timeout: Explicit operation timeout
|
||||||
"""
|
"""
|
||||||
@@ -199,22 +187,23 @@ class IndicesClient(NamespacedClient):
|
|||||||
return self.transport.perform_request('DELETE', _make_path(index),
|
return self.transport.perform_request('DELETE', _make_path(index),
|
||||||
params=params)
|
params=params)
|
||||||
|
|
||||||
@query_params('allow_no_indices', 'expand_wildcards', 'ignore_unavailable',
|
@query_params('allow_no_indices', 'expand_wildcards', 'flat_settings',
|
||||||
'local')
|
'ignore_unavailable', 'include_defaults', 'local')
|
||||||
def exists(self, index, params=None):
|
def exists(self, index, params=None):
|
||||||
"""
|
"""
|
||||||
Return a boolean indicating whether given index exists.
|
Return a boolean indicating whether given index exists.
|
||||||
`<http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-exists.html>`_
|
`<http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-exists.html>`_
|
||||||
|
|
||||||
:arg index: A comma-separated list of indices to check
|
:arg index: A comma-separated list of index names
|
||||||
:arg allow_no_indices: Whether to ignore if a wildcard indices
|
:arg allow_no_indices: Ignore if a wildcard expression resolves to no
|
||||||
expression resolves into no concrete indices. (This includes `_all`
|
concrete indices (default: false)
|
||||||
string or when no indices have been specified)
|
:arg expand_wildcards: Whether wildcard expressions should get expanded
|
||||||
:arg expand_wildcards: Whether to expand wildcard expression to concrete
|
to open or closed indices (default: open), default 'open', valid
|
||||||
indices that are open, closed or both., default 'open', valid
|
|
||||||
choices are: 'open', 'closed', 'none', 'all'
|
choices are: 'open', 'closed', 'none', 'all'
|
||||||
:arg ignore_unavailable: Whether specified concrete indices should be
|
:arg flat_settings: Return settings in flat format (default: false)
|
||||||
ignored when unavailable (missing or closed)
|
:arg ignore_unavailable: Ignore unavailable indexes (default: false)
|
||||||
|
:arg include_defaults: Whether to return all default setting for each of
|
||||||
|
the indices., default False
|
||||||
:arg local: Return local information, do not retrieve the state from
|
:arg local: Return local information, do not retrieve the state from
|
||||||
master node (default: false)
|
master node (default: false)
|
||||||
"""
|
"""
|
||||||
@@ -365,8 +354,8 @@ class IndicesClient(NamespacedClient):
|
|||||||
expression resolves into no concrete indices. (This includes `_all`
|
expression resolves into no concrete indices. (This includes `_all`
|
||||||
string or when no indices have been specified)
|
string or when no indices have been specified)
|
||||||
:arg expand_wildcards: Whether to expand wildcard expression to concrete
|
:arg expand_wildcards: Whether to expand wildcard expression to concrete
|
||||||
indices that are open, closed or both., default ['open', 'closed'],
|
indices that are open, closed or both., default 'all', valid choices
|
||||||
valid choices are: 'open', 'closed', 'none', 'all'
|
are: 'open', 'closed', 'none', 'all'
|
||||||
:arg ignore_unavailable: Whether specified concrete indices should be
|
:arg ignore_unavailable: Whether specified concrete indices should be
|
||||||
ignored when unavailable (missing or closed)
|
ignored when unavailable (missing or closed)
|
||||||
:arg local: Return local information, do not retrieve the state from
|
:arg local: Return local information, do not retrieve the state from
|
||||||
@@ -388,8 +377,8 @@ class IndicesClient(NamespacedClient):
|
|||||||
expression resolves into no concrete indices. (This includes `_all`
|
expression resolves into no concrete indices. (This includes `_all`
|
||||||
string or when no indices have been specified)
|
string or when no indices have been specified)
|
||||||
:arg expand_wildcards: Whether to expand wildcard expression to concrete
|
:arg expand_wildcards: Whether to expand wildcard expression to concrete
|
||||||
indices that are open, closed or both., default 'all', valid
|
indices that are open, closed or both., default 'all', valid choices
|
||||||
choices are: 'open', 'closed', 'none', 'all'
|
are: 'open', 'closed', 'none', 'all'
|
||||||
:arg ignore_unavailable: Whether specified concrete indices should be
|
:arg ignore_unavailable: Whether specified concrete indices should be
|
||||||
ignored when unavailable (missing or closed)
|
ignored when unavailable (missing or closed)
|
||||||
:arg local: Return local information, do not retrieve the state from
|
:arg local: Return local information, do not retrieve the state from
|
||||||
@@ -457,13 +446,14 @@ class IndicesClient(NamespacedClient):
|
|||||||
return self.transport.perform_request('PUT', _make_path('_template',
|
return self.transport.perform_request('PUT', _make_path('_template',
|
||||||
name), params=params, body=body)
|
name), params=params, body=body)
|
||||||
|
|
||||||
@query_params('local', 'master_timeout')
|
@query_params('flat_settings', 'local', 'master_timeout')
|
||||||
def exists_template(self, name, params=None):
|
def exists_template(self, name, params=None):
|
||||||
"""
|
"""
|
||||||
Return a boolean indicating whether given template exists.
|
Return a boolean indicating whether given template exists.
|
||||||
`<http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-templates.html>`_
|
`<http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-templates.html>`_
|
||||||
|
|
||||||
:arg name: The name of the template
|
:arg name: The comma separated names of the index templates
|
||||||
|
:arg flat_settings: Return settings in flat format (default: false)
|
||||||
:arg local: Return local information, do not retrieve the state from
|
:arg local: Return local information, do not retrieve the state from
|
||||||
master node (default: false)
|
master node (default: false)
|
||||||
:arg master_timeout: Explicit operation timeout for connection to master
|
:arg master_timeout: Explicit operation timeout for connection to master
|
||||||
@@ -506,7 +496,7 @@ class IndicesClient(NamespacedClient):
|
|||||||
_make_path('_template', name), params=params)
|
_make_path('_template', name), params=params)
|
||||||
|
|
||||||
@query_params('allow_no_indices', 'expand_wildcards', 'flat_settings',
|
@query_params('allow_no_indices', 'expand_wildcards', 'flat_settings',
|
||||||
'human', 'ignore_unavailable', 'include_defaults', 'local')
|
'ignore_unavailable', 'include_defaults', 'local')
|
||||||
def get_settings(self, index=None, name=None, params=None):
|
def get_settings(self, index=None, name=None, params=None):
|
||||||
"""
|
"""
|
||||||
Retrieve settings for one or more (or all) indices.
|
Retrieve settings for one or more (or all) indices.
|
||||||
@@ -522,8 +512,6 @@ class IndicesClient(NamespacedClient):
|
|||||||
indices that are open, closed or both., default ['open', 'closed'],
|
indices that are open, closed or both., default ['open', 'closed'],
|
||||||
valid choices are: 'open', 'closed', 'none', 'all'
|
valid choices are: 'open', 'closed', 'none', 'all'
|
||||||
:arg flat_settings: Return settings in flat format (default: false)
|
:arg flat_settings: Return settings in flat format (default: false)
|
||||||
:arg human: Whether to return version and creation date values in human-
|
|
||||||
readable format., default False
|
|
||||||
:arg ignore_unavailable: Whether specified concrete indices should be
|
:arg ignore_unavailable: Whether specified concrete indices should be
|
||||||
ignored when unavailable (missing or closed)
|
ignored when unavailable (missing or closed)
|
||||||
:arg include_defaults: Whether to return all default setting for each of
|
:arg include_defaults: Whether to return all default setting for each of
|
||||||
@@ -615,10 +603,9 @@ class IndicesClient(NamespacedClient):
|
|||||||
return self.transport.perform_request('GET', _make_path(index,
|
return self.transport.perform_request('GET', _make_path(index,
|
||||||
'_segments'), params=params)
|
'_segments'), params=params)
|
||||||
|
|
||||||
@query_params('allow_no_indices', 'analyze_wildcard', 'analyzer',
|
@query_params('all_shards', 'allow_no_indices', 'analyze_wildcard',
|
||||||
'default_operator', 'df', 'expand_wildcards', 'explain',
|
'analyzer', 'default_operator', 'df', 'expand_wildcards', 'explain',
|
||||||
'ignore_unavailable', 'lenient', 'lowercase_expanded_terms',
|
'ignore_unavailable', 'lenient', 'operation_threading', 'q', 'rewrite')
|
||||||
'operation_threading', 'q', 'rewrite')
|
|
||||||
def validate_query(self, index=None, doc_type=None, body=None, params=None):
|
def validate_query(self, index=None, doc_type=None, body=None, params=None):
|
||||||
"""
|
"""
|
||||||
Validate a potentially expensive query without executing it.
|
Validate a potentially expensive query without executing it.
|
||||||
@@ -630,6 +617,8 @@ class IndicesClient(NamespacedClient):
|
|||||||
:arg doc_type: A comma-separated list of document types to restrict the
|
:arg doc_type: A comma-separated list of document types to restrict the
|
||||||
operation; leave empty to perform the operation on all types
|
operation; leave empty to perform the operation on all types
|
||||||
:arg body: The query definition specified with the Query DSL
|
:arg body: The query definition specified with the Query DSL
|
||||||
|
:arg all_shards: Execute validation on all shards instead of one random
|
||||||
|
shard per index
|
||||||
:arg allow_no_indices: Whether to ignore if a wildcard indices
|
:arg allow_no_indices: Whether to ignore if a wildcard indices
|
||||||
expression resolves into no concrete indices. (This includes `_all`
|
expression resolves into no concrete indices. (This includes `_all`
|
||||||
string or when no indices have been specified)
|
string or when no indices have been specified)
|
||||||
@@ -648,8 +637,6 @@ class IndicesClient(NamespacedClient):
|
|||||||
ignored when unavailable (missing or closed)
|
ignored when unavailable (missing or closed)
|
||||||
:arg lenient: Specify whether format-based query failures (such as
|
:arg lenient: Specify whether format-based query failures (such as
|
||||||
providing text to a numeric field) should be ignored
|
providing text to a numeric field) should be ignored
|
||||||
:arg lowercase_expanded_terms: Specify whether query terms should be
|
|
||||||
lowercased
|
|
||||||
:arg operation_threading: TODO: ?
|
:arg operation_threading: TODO: ?
|
||||||
:arg q: Query in the Lucene query string syntax
|
:arg q: Query in the Lucene query string syntax
|
||||||
:arg rewrite: Provide a more detailed explanation showing the actual
|
:arg rewrite: Provide a more detailed explanation showing the actual
|
||||||
@@ -682,6 +669,7 @@ class IndicesClient(NamespacedClient):
|
|||||||
:arg query: Clear query caches
|
:arg query: Clear query caches
|
||||||
:arg recycler: Clear the recycler cache
|
:arg recycler: Clear the recycler cache
|
||||||
:arg request: Clear request cache
|
:arg request: Clear request cache
|
||||||
|
:arg request_cache: Clear request cache
|
||||||
"""
|
"""
|
||||||
return self.transport.perform_request('POST', _make_path(index,
|
return self.transport.perform_request('POST', _make_path(index,
|
||||||
'_cache', 'clear'), params=params)
|
'_cache', 'clear'), params=params)
|
||||||
|
|||||||
@@ -84,3 +84,22 @@ class NodesClient(NamespacedClient):
|
|||||||
params['type'] = params.pop('type_')
|
params['type'] = params.pop('type_')
|
||||||
return self.transport.perform_request('GET', _make_path('_cluster',
|
return self.transport.perform_request('GET', _make_path('_cluster',
|
||||||
'nodes', node_id, 'hotthreads'), params=params)
|
'nodes', node_id, 'hotthreads'), params=params)
|
||||||
|
|
||||||
|
@query_params('human', 'timeout')
|
||||||
|
def usage(self, node_id=None, metric=None, params=None):
|
||||||
|
"""
|
||||||
|
The cluster nodes usage API allows to retrieve information on the usage
|
||||||
|
of features for each node.
|
||||||
|
`<http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-usage.html>`_
|
||||||
|
|
||||||
|
:arg 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
|
||||||
|
:arg metric: Limit the information returned to the specified metrics
|
||||||
|
:arg human: Whether to return time and byte values in human-readable
|
||||||
|
format., default False
|
||||||
|
:arg timeout: Explicit operation timeout
|
||||||
|
"""
|
||||||
|
return self.transport.perform_request('GET', _make_path('_nodes',
|
||||||
|
node_id, 'usage', metric), params=params)
|
||||||
|
|||||||
@@ -38,7 +38,7 @@ class SnapshotClient(NamespacedClient):
|
|||||||
return self.transport.perform_request('DELETE',
|
return self.transport.perform_request('DELETE',
|
||||||
_make_path('_snapshot', repository, snapshot), params=params)
|
_make_path('_snapshot', repository, snapshot), params=params)
|
||||||
|
|
||||||
@query_params('ignore_unavailable', 'master_timeout')
|
@query_params('ignore_unavailable', 'master_timeout', 'verbose')
|
||||||
def get(self, repository, snapshot, params=None):
|
def get(self, repository, snapshot, params=None):
|
||||||
"""
|
"""
|
||||||
Retrieve information about a snapshot.
|
Retrieve information about a snapshot.
|
||||||
@@ -50,6 +50,8 @@ class SnapshotClient(NamespacedClient):
|
|||||||
defaults to false which means a SnapshotMissingException is thrown
|
defaults to false which means a SnapshotMissingException is thrown
|
||||||
:arg master_timeout: Explicit operation timeout for connection to master
|
:arg master_timeout: Explicit operation timeout for connection to master
|
||||||
node
|
node
|
||||||
|
:arg verbose: Whether to show verbose snapshot info or only show the
|
||||||
|
basic info found in the repository index blob
|
||||||
"""
|
"""
|
||||||
for param in (repository, snapshot):
|
for param in (repository, snapshot):
|
||||||
if param in SKIP_IN_PATH:
|
if param in SKIP_IN_PATH:
|
||||||
|
|||||||
@@ -3,11 +3,10 @@ from .utils import NamespacedClient, query_params, _make_path, SKIP_IN_PATH
|
|||||||
class TasksClient(NamespacedClient):
|
class TasksClient(NamespacedClient):
|
||||||
@query_params('actions', 'detailed', 'group_by', 'node_id', 'parent_node',
|
@query_params('actions', 'detailed', 'group_by', 'node_id', 'parent_node',
|
||||||
'parent_task', 'wait_for_completion')
|
'parent_task', 'wait_for_completion')
|
||||||
def list(self, task_id=None, params=None):
|
def list(self, params=None):
|
||||||
"""
|
"""
|
||||||
`<http://www.elastic.co/guide/en/elasticsearch/reference/current/tasks.html>`_
|
`<http://www.elastic.co/guide/en/elasticsearch/reference/current/tasks.html>`_
|
||||||
|
|
||||||
:arg task_id: Return the task with specified id (node_id:task_number)
|
|
||||||
:arg actions: A comma-separated list of actions that should be returned.
|
:arg actions: A comma-separated list of actions that should be returned.
|
||||||
Leave empty to return all.
|
Leave empty to return all.
|
||||||
:arg detailed: Return detailed task information (default: false)
|
:arg detailed: Return detailed task information (default: false)
|
||||||
@@ -23,8 +22,7 @@ class TasksClient(NamespacedClient):
|
|||||||
:arg wait_for_completion: Wait for the matching tasks to complete
|
:arg wait_for_completion: Wait for the matching tasks to complete
|
||||||
(default: false)
|
(default: false)
|
||||||
"""
|
"""
|
||||||
return self.transport.perform_request('GET', _make_path('_tasks',
|
return self.transport.perform_request('GET', '/_tasks', params=params)
|
||||||
task_id), params=params)
|
|
||||||
|
|
||||||
@query_params('actions', 'node_id', 'parent_node', 'parent_task')
|
@query_params('actions', 'node_id', 'parent_node', 'parent_task')
|
||||||
def cancel(self, task_id=None, params=None):
|
def cancel(self, task_id=None, params=None):
|
||||||
|
|||||||
@@ -191,22 +191,27 @@ class YamlTestCase(ElasticsearchTestCase):
|
|||||||
|
|
||||||
def run_gt(self, action):
|
def run_gt(self, action):
|
||||||
for key, value in action.items():
|
for key, value in action.items():
|
||||||
|
value = self._resolve(value)
|
||||||
self.assertGreater(self._lookup(key), value)
|
self.assertGreater(self._lookup(key), value)
|
||||||
|
|
||||||
def run_gte(self, action):
|
def run_gte(self, action):
|
||||||
for key, value in action.items():
|
for key, value in action.items():
|
||||||
|
value = self._resolve(value)
|
||||||
self.assertGreaterEqual(self._lookup(key), value)
|
self.assertGreaterEqual(self._lookup(key), value)
|
||||||
|
|
||||||
def run_lt(self, action):
|
def run_lt(self, action):
|
||||||
for key, value in action.items():
|
for key, value in action.items():
|
||||||
|
value = self._resolve(value)
|
||||||
self.assertLess(self._lookup(key), value)
|
self.assertLess(self._lookup(key), value)
|
||||||
|
|
||||||
def run_lte(self, action):
|
def run_lte(self, action):
|
||||||
for key, value in action.items():
|
for key, value in action.items():
|
||||||
|
value = self._resolve(value)
|
||||||
self.assertLessEqual(self._lookup(key), value)
|
self.assertLessEqual(self._lookup(key), value)
|
||||||
|
|
||||||
def run_set(self, action):
|
def run_set(self, action):
|
||||||
for key, value in action.items():
|
for key, value in action.items():
|
||||||
|
value = self._resolve(value)
|
||||||
self._state[value] = self._lookup(key)
|
self._state[value] = self._lookup(key)
|
||||||
|
|
||||||
def run_is_false(self, action):
|
def run_is_false(self, action):
|
||||||
|
|||||||
Reference in New Issue
Block a user