elasticsearch-api 7.3.0 → 7.5.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Rakefile +16 -23
- data/elasticsearch-api.gemspec +1 -1
- data/lib/elasticsearch/api/actions/abort_benchmark.rb +1 -2
- data/lib/elasticsearch/api/actions/benchmark.rb +2 -3
- data/lib/elasticsearch/api/actions/bulk.rb +35 -68
- data/lib/elasticsearch/api/actions/cat/aliases.rb +30 -52
- data/lib/elasticsearch/api/actions/cat/allocation.rb +36 -50
- data/lib/elasticsearch/api/actions/cat/count.rb +25 -46
- data/lib/elasticsearch/api/actions/cat/fielddata.rb +31 -33
- data/lib/elasticsearch/api/actions/cat/health.rb +27 -37
- data/lib/elasticsearch/api/actions/cat/help.rb +14 -10
- data/lib/elasticsearch/api/actions/cat/indices.rb +45 -62
- data/lib/elasticsearch/api/actions/cat/master.rb +24 -34
- data/lib/elasticsearch/api/actions/cat/nodeattrs.rb +20 -16
- data/lib/elasticsearch/api/actions/cat/nodes.rb +34 -46
- data/lib/elasticsearch/api/actions/cat/params_registry.rb +0 -1
- data/lib/elasticsearch/api/actions/cat/pending_tasks.rb +29 -35
- data/lib/elasticsearch/api/actions/cat/plugins.rb +21 -18
- data/lib/elasticsearch/api/actions/cat/recovery.rb +40 -56
- data/lib/elasticsearch/api/actions/cat/repositories.rb +21 -24
- data/lib/elasticsearch/api/actions/cat/segments.rb +29 -22
- data/lib/elasticsearch/api/actions/cat/shards.rb +38 -59
- data/lib/elasticsearch/api/actions/cat/snapshots.rb +32 -27
- data/lib/elasticsearch/api/actions/cat/tasks.rb +25 -19
- data/lib/elasticsearch/api/actions/cat/templates.rb +26 -18
- data/lib/elasticsearch/api/actions/cat/thread_pool.rb +36 -46
- data/lib/elasticsearch/api/actions/clear_scroll.rb +21 -8
- data/lib/elasticsearch/api/actions/cluster/allocation_explain.rb +15 -13
- data/lib/elasticsearch/api/actions/cluster/get_settings.rb +18 -18
- data/lib/elasticsearch/api/actions/cluster/health.rb +42 -44
- data/lib/elasticsearch/api/actions/cluster/params_registry.rb +0 -1
- data/lib/elasticsearch/api/actions/cluster/pending_tasks.rb +15 -17
- data/lib/elasticsearch/api/actions/cluster/put_settings.rb +20 -17
- data/lib/elasticsearch/api/actions/cluster/remote_info.rb +8 -6
- data/lib/elasticsearch/api/actions/cluster/reroute.rb +25 -37
- data/lib/elasticsearch/api/actions/cluster/state.rb +37 -41
- data/lib/elasticsearch/api/actions/cluster/stats.rb +20 -12
- data/lib/elasticsearch/api/actions/count.rb +52 -39
- data/lib/elasticsearch/api/actions/create.rb +25 -26
- data/lib/elasticsearch/api/actions/delete.rb +43 -36
- data/lib/elasticsearch/api/actions/delete_by_query.rb +74 -62
- data/lib/elasticsearch/api/actions/delete_by_query_rethrottle.rb +39 -0
- data/lib/elasticsearch/api/actions/delete_by_rethrottle.rb +4 -3
- data/lib/elasticsearch/api/actions/delete_script.rb +19 -13
- data/lib/elasticsearch/api/actions/exists.rb +44 -34
- data/lib/elasticsearch/api/actions/exists_source.rb +43 -25
- data/lib/elasticsearch/api/actions/explain.rb +46 -51
- data/lib/elasticsearch/api/actions/field_caps.rb +27 -20
- data/lib/elasticsearch/api/actions/get.rb +42 -41
- data/lib/elasticsearch/api/actions/get_script.rb +19 -14
- data/lib/elasticsearch/api/actions/get_source.rb +38 -44
- data/lib/elasticsearch/api/actions/index.rb +60 -89
- data/lib/elasticsearch/api/actions/indices/analyze.rb +19 -48
- data/lib/elasticsearch/api/actions/indices/clear_cache.rb +29 -41
- data/lib/elasticsearch/api/actions/indices/clone.rb +50 -0
- data/lib/elasticsearch/api/actions/indices/close.rb +28 -32
- data/lib/elasticsearch/api/actions/indices/create.rb +22 -70
- data/lib/elasticsearch/api/actions/indices/delete.rb +23 -35
- data/lib/elasticsearch/api/actions/indices/delete_alias.rb +24 -20
- data/lib/elasticsearch/api/actions/indices/delete_template.rb +18 -20
- data/lib/elasticsearch/api/actions/indices/exists.rb +32 -34
- data/lib/elasticsearch/api/actions/indices/exists_alias.rb +33 -29
- data/lib/elasticsearch/api/actions/indices/exists_template.rb +21 -16
- data/lib/elasticsearch/api/actions/indices/exists_type.rb +29 -29
- data/lib/elasticsearch/api/actions/indices/flush.rb +28 -28
- data/lib/elasticsearch/api/actions/indices/flush_synced.rb +23 -12
- data/lib/elasticsearch/api/actions/indices/forcemerge.rb +26 -41
- data/lib/elasticsearch/api/actions/indices/freeze.rb +7 -8
- data/lib/elasticsearch/api/actions/indices/get.rb +25 -19
- data/lib/elasticsearch/api/actions/indices/get_alias.rb +31 -23
- data/lib/elasticsearch/api/actions/indices/get_field_mapping.rb +42 -38
- data/lib/elasticsearch/api/actions/indices/get_mapping.rb +39 -31
- data/lib/elasticsearch/api/actions/indices/get_settings.rb +34 -37
- data/lib/elasticsearch/api/actions/indices/get_template.rb +21 -23
- data/lib/elasticsearch/api/actions/indices/get_upgrade.rb +48 -0
- data/lib/elasticsearch/api/actions/indices/open.rb +24 -21
- data/lib/elasticsearch/api/actions/indices/params_registry.rb +0 -1
- data/lib/elasticsearch/api/actions/indices/put_alias.rb +25 -27
- data/lib/elasticsearch/api/actions/indices/put_mapping.rb +40 -39
- data/lib/elasticsearch/api/actions/indices/put_settings.rb +30 -37
- data/lib/elasticsearch/api/actions/indices/put_template.rb +23 -23
- data/lib/elasticsearch/api/actions/indices/recovery.rb +20 -23
- data/lib/elasticsearch/api/actions/indices/refresh.rb +22 -26
- data/lib/elasticsearch/api/actions/indices/rollover.rb +28 -19
- data/lib/elasticsearch/api/actions/indices/segments.rb +24 -17
- data/lib/elasticsearch/api/actions/indices/shard_stores.rb +27 -15
- data/lib/elasticsearch/api/actions/indices/shrink.rb +23 -17
- data/lib/elasticsearch/api/actions/indices/split.rb +23 -17
- data/lib/elasticsearch/api/actions/indices/stats.rb +53 -104
- data/lib/elasticsearch/api/actions/indices/unfreeze.rb +7 -7
- data/lib/elasticsearch/api/actions/indices/update_aliases.rb +15 -32
- data/lib/elasticsearch/api/actions/indices/upgrade.rb +26 -16
- data/lib/elasticsearch/api/actions/indices/validate_query.rb +46 -59
- data/lib/elasticsearch/api/actions/info.rb +9 -6
- data/lib/elasticsearch/api/actions/ingest/delete_pipeline.rb +18 -12
- data/lib/elasticsearch/api/actions/ingest/get_pipeline.rb +21 -11
- data/lib/elasticsearch/api/actions/ingest/params_registry.rb +0 -1
- data/lib/elasticsearch/api/actions/ingest/processor_grok.rb +12 -13
- data/lib/elasticsearch/api/actions/ingest/put_pipeline.rb +19 -14
- data/lib/elasticsearch/api/actions/ingest/simulate.rb +23 -13
- data/lib/elasticsearch/api/actions/mget.rb +37 -44
- data/lib/elasticsearch/api/actions/msearch.rb +54 -54
- data/lib/elasticsearch/api/actions/msearch_template.rb +46 -35
- data/lib/elasticsearch/api/actions/mtermvectors.rb +39 -35
- data/lib/elasticsearch/api/actions/nodes/hot_threads.rb +30 -25
- data/lib/elasticsearch/api/actions/nodes/info.rb +29 -63
- data/lib/elasticsearch/api/actions/nodes/params_registry.rb +0 -1
- data/lib/elasticsearch/api/actions/nodes/reload_secure_settings.rb +24 -22
- data/lib/elasticsearch/api/actions/nodes/shutdown.rb +4 -4
- data/lib/elasticsearch/api/actions/nodes/stats.rb +43 -36
- data/lib/elasticsearch/api/actions/nodes/usage.rb +31 -10
- data/lib/elasticsearch/api/actions/params_registry.rb +0 -1
- data/lib/elasticsearch/api/actions/ping.rb +12 -13
- data/lib/elasticsearch/api/actions/put_script.rb +26 -30
- data/lib/elasticsearch/api/actions/rank_eval.rb +24 -15
- data/lib/elasticsearch/api/actions/reindex.rb +25 -48
- data/lib/elasticsearch/api/actions/reindex_rethrottle.rb +18 -12
- data/lib/elasticsearch/api/actions/remote/info.rb +1 -2
- data/lib/elasticsearch/api/actions/render_search_template.rb +17 -15
- data/lib/elasticsearch/api/actions/scripts_painless_execute.rb +8 -6
- data/lib/elasticsearch/api/actions/scroll.rb +28 -51
- data/lib/elasticsearch/api/actions/search.rb +104 -165
- data/lib/elasticsearch/api/actions/search_shards.rb +31 -28
- data/lib/elasticsearch/api/actions/search_template.rb +48 -40
- data/lib/elasticsearch/api/actions/snapshot/cleanup_repository.rb +44 -0
- data/lib/elasticsearch/api/actions/snapshot/create.rb +22 -29
- data/lib/elasticsearch/api/actions/snapshot/create_repository.rb +19 -24
- data/lib/elasticsearch/api/actions/snapshot/delete.rb +20 -22
- data/lib/elasticsearch/api/actions/snapshot/delete_repository.rb +16 -18
- data/lib/elasticsearch/api/actions/snapshot/get.rb +22 -31
- data/lib/elasticsearch/api/actions/snapshot/get_repository.rb +21 -25
- data/lib/elasticsearch/api/actions/snapshot/params_registry.rb +0 -1
- data/lib/elasticsearch/api/actions/snapshot/restore.rb +21 -32
- data/lib/elasticsearch/api/actions/snapshot/status.rb +23 -24
- data/lib/elasticsearch/api/actions/snapshot/verify_repository.rb +18 -13
- data/lib/elasticsearch/api/actions/tasks/cancel.rb +19 -13
- data/lib/elasticsearch/api/actions/tasks/get.rb +16 -13
- data/lib/elasticsearch/api/actions/tasks/list.rb +20 -18
- data/lib/elasticsearch/api/actions/tasks/params_registry.rb +0 -1
- data/lib/elasticsearch/api/actions/termvectors.rb +52 -70
- data/lib/elasticsearch/api/actions/update.rb +53 -98
- data/lib/elasticsearch/api/actions/update_by_query.rb +77 -66
- data/lib/elasticsearch/api/actions/update_by_query_rethrottle.rb +17 -11
- data/lib/elasticsearch/api/version.rb +1 -1
- data/spec/elasticsearch/api/actions/cat/segments_spec.rb +9 -11
- data/spec/elasticsearch/api/actions/cluster/put_settings_spec.rb +1 -1
- data/spec/elasticsearch/api/actions/count_spec.rb +8 -8
- data/spec/elasticsearch/api/actions/delete_by_query_spec.rb +12 -7
- data/spec/elasticsearch/api/actions/delete_script_spec.rb +0 -14
- data/spec/elasticsearch/api/actions/exists_document_spec.rb +1 -1
- data/spec/elasticsearch/api/actions/get_document_source_spec.rb +1 -1
- data/spec/elasticsearch/api/actions/index_document_spec.rb +6 -15
- data/spec/elasticsearch/api/actions/indices/analyze_spec.rb +0 -4
- data/spec/elasticsearch/api/actions/indices/clear_cache_spec.rb +1 -5
- data/spec/elasticsearch/api/actions/indices/clone_spec.rb +109 -0
- data/spec/elasticsearch/api/actions/indices/delete_alias_spec.rb +2 -2
- data/spec/elasticsearch/api/actions/indices/get_spec.rb +0 -11
- data/spec/elasticsearch/api/actions/indices/put_alias_spec.rb +3 -3
- data/spec/elasticsearch/api/actions/indices/put_mapping_spec.rb +3 -3
- data/spec/elasticsearch/api/actions/indices/stats_spec.rb +0 -1
- data/spec/elasticsearch/api/actions/nodes/hot_threads_spec.rb +3 -3
- data/spec/elasticsearch/api/actions/put_script_spec.rb +20 -15
- data/spec/elasticsearch/api/actions/render_search_template_spec.rb +23 -7
- data/spec/elasticsearch/api/actions/scroll_spec.rb +37 -0
- data/spec/elasticsearch/api/actions/search_spec.rb +0 -15
- data/spec/elasticsearch/api/actions/tasks/list_spec.rb +0 -11
- data/spec/elasticsearch/api/actions/update_document_spec.rb +3 -7
- data/spec/elasticsearch/api/rest_api_yaml_spec.rb +1 -1
- data/spec/rest_yaml_tests_helper.rb +12 -0
- data/utils/Gemfile +1 -0
- data/utils/Thorfile +0 -1
- data/utils/thor/generate_source.rb +192 -85
- data/utils/thor/generator/endpoint_specifics.rb +157 -0
- data/utils/thor/generator/files_helper.rb +37 -0
- data/utils/thor/lister.rb +3 -4
- data/utils/thor/templates/_documentation_top.erb +27 -0
- data/utils/thor/templates/_method_setup.erb +35 -0
- data/utils/thor/templates/_params_registry.erb +12 -0
- data/utils/thor/templates/_perform_request.erb +37 -0
- data/utils/thor/templates/method.erb +59 -0
- data/utils/thor/templates/{ruby/test.erb → test.erb} +0 -0
- data/utils/thor/templates/{ruby/test_helper.rb → test_helper.rb} +0 -0
- metadata +31 -14
- data/spec/elasticsearch/api/actions/scoll_spec.rb +0 -21
- data/utils/thor/generate_api.rb +0 -193
- data/utils/thor/templates/ruby/method.erb +0 -62
@@ -5,40 +5,35 @@
|
|
5
5
|
module Elasticsearch
|
6
6
|
module API
|
7
7
|
module Actions
|
8
|
-
|
9
|
-
# Delete documents which match specified query.
|
10
|
-
#
|
11
|
-
# Provide the query either as a "query string" query in the `:q` argument, or using the Elasticsearch's
|
12
|
-
# [Query DSL](https://www.elastic.co/guide/reference/query-dsl/) in the `:body` argument.
|
13
|
-
#
|
14
|
-
# @example Deleting documents with a simple query
|
15
|
-
#
|
16
|
-
# client.delete_by_query index: 'myindex', q: 'title:test'
|
17
|
-
#
|
18
|
-
# @example Deleting documents using the Query DSL
|
19
|
-
#
|
20
|
-
# client.delete_by_query index: 'myindex', body: { query: { term: { published: false } } }
|
8
|
+
# Deletes documents matching the provided query.
|
21
9
|
#
|
22
|
-
# @option arguments [List] :index A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
|
10
|
+
# @option arguments [List] :index A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices (*Required*)
|
23
11
|
# @option arguments [List] :type A comma-separated list of document types to search; leave empty to perform the operation on all types
|
24
|
-
# @option arguments [Hash] :body The search definition using the Query DSL (*Required*)
|
25
|
-
# @option arguments [String] :analyzer The analyzer to use for the query string
|
26
12
|
# @option arguments [Boolean] :analyze_wildcard Specify whether wildcard and prefix queries should be analyzed (default: false)
|
27
|
-
# @option arguments [String] :default_operator The default operator for query string query (AND or OR)
|
13
|
+
# @option arguments [String] :default_operator The default operator for query string query (AND or OR)
|
14
|
+
# (options: AND,OR)
|
15
|
+
|
28
16
|
# @option arguments [String] :df The field to use as default where no field prefix is given in the query string
|
29
17
|
# @option arguments [Number] :from Starting offset (default: 0)
|
30
18
|
# @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
|
31
19
|
# @option arguments [Boolean] :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)
|
32
|
-
# @option arguments [String] :conflicts What to do when the delete by query hits version conflicts?
|
33
|
-
#
|
20
|
+
# @option arguments [String] :conflicts What to do when the delete by query hits version conflicts?
|
21
|
+
# (options: abort,proceed)
|
22
|
+
|
23
|
+
# @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
|
24
|
+
# (options: open,closed,none,all)
|
25
|
+
|
34
26
|
# @option arguments [Boolean] :lenient Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
|
35
27
|
# @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random)
|
36
28
|
# @option arguments [String] :q Query in the Lucene query string syntax
|
37
29
|
# @option arguments [List] :routing A comma-separated list of specific routing values
|
38
30
|
# @option arguments [Time] :scroll Specify how long a consistent view of the index should be maintained for scrolled search
|
39
|
-
# @option arguments [String] :search_type Search operation type
|
31
|
+
# @option arguments [String] :search_type Search operation type
|
32
|
+
# (options: query_then_fetch,dfs_query_then_fetch)
|
33
|
+
|
40
34
|
# @option arguments [Time] :search_timeout Explicit timeout for each search request. Defaults to no timeout.
|
41
|
-
# @option arguments [Number] :size
|
35
|
+
# @option arguments [Number] :size Deprecated, please use `max_docs` instead
|
36
|
+
# @option arguments [Number] :max_docs Maximum number of documents to process (default: all documents)
|
42
37
|
# @option arguments [List] :sort A comma-separated list of <field>:<direction> pairs
|
43
38
|
# @option arguments [List] :_source True or false to return the _source field or not, or a list of fields to return
|
44
39
|
# @option arguments [List] :_source_excludes A list of fields to exclude from the returned _source field
|
@@ -54,58 +49,75 @@ module Elasticsearch
|
|
54
49
|
# @option arguments [Boolean] :wait_for_completion Should the request should block until the delete by query is complete.
|
55
50
|
# @option arguments [Number] :requests_per_second The throttle for this request in sub-requests per second. -1 means no throttle.
|
56
51
|
# @option arguments [Number] :slices The number of slices this task should be divided into. Defaults to 1 meaning the task isn't sliced into subtasks.
|
52
|
+
|
53
|
+
# @option arguments [Hash] :body The search definition using the Query DSL (*Required*)
|
54
|
+
#
|
55
|
+
# *Deprecation notice*:
|
56
|
+
# Specifying types in urls has been deprecated
|
57
|
+
# Deprecated since version 7.0.0
|
57
58
|
#
|
58
|
-
# @see https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete-by-query.html
|
59
59
|
#
|
60
|
-
|
60
|
+
# @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/docs-delete-by-query.html
|
61
|
+
#
|
62
|
+
def delete_by_query(arguments = {})
|
63
|
+
raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
|
61
64
|
raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
|
62
|
-
method = HTTP_POST
|
63
|
-
path = Utils.__pathify Utils.__listify(arguments[:index]),
|
64
|
-
Utils.__listify(arguments[:type]),
|
65
|
-
'/_delete_by_query'
|
66
65
|
|
66
|
+
arguments = arguments.clone
|
67
|
+
|
68
|
+
_index = arguments.delete(:index)
|
69
|
+
|
70
|
+
_type = arguments.delete(:type)
|
71
|
+
|
72
|
+
method = Elasticsearch::API::HTTP_POST
|
73
|
+
path = if _index && _type
|
74
|
+
"#{Utils.__listify(_index)}/#{Utils.__listify(_type)}/_delete_by_query"
|
75
|
+
else
|
76
|
+
"#{Utils.__listify(_index)}/_delete_by_query"
|
77
|
+
end
|
67
78
|
params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
|
68
|
-
body = arguments[:body]
|
69
79
|
|
80
|
+
body = arguments[:body]
|
70
81
|
perform_request(method, path, params, body).body
|
71
82
|
end
|
72
83
|
|
73
84
|
# Register this action with its valid params when the module is loaded.
|
74
85
|
#
|
75
|
-
# @since 6.
|
86
|
+
# @since 6.2.0
|
76
87
|
ParamsRegistry.register(:delete_by_query, [
|
77
|
-
|
78
|
-
|
79
|
-
|
80
|
-
|
81
|
-
|
82
|
-
|
83
|
-
|
84
|
-
|
85
|
-
|
86
|
-
|
87
|
-
|
88
|
-
|
89
|
-
|
90
|
-
|
91
|
-
|
92
|
-
|
93
|
-
|
94
|
-
|
95
|
-
|
96
|
-
|
97
|
-
|
98
|
-
|
99
|
-
|
100
|
-
|
101
|
-
|
102
|
-
|
103
|
-
|
104
|
-
|
105
|
-
|
106
|
-
|
107
|
-
|
108
|
-
|
88
|
+
:analyze_wildcard,
|
89
|
+
:default_operator,
|
90
|
+
:df,
|
91
|
+
:from,
|
92
|
+
:ignore_unavailable,
|
93
|
+
:allow_no_indices,
|
94
|
+
:conflicts,
|
95
|
+
:expand_wildcards,
|
96
|
+
:lenient,
|
97
|
+
:preference,
|
98
|
+
:q,
|
99
|
+
:routing,
|
100
|
+
:scroll,
|
101
|
+
:search_type,
|
102
|
+
:search_timeout,
|
103
|
+
:size,
|
104
|
+
:max_docs,
|
105
|
+
:sort,
|
106
|
+
:_source,
|
107
|
+
:_source_excludes,
|
108
|
+
:_source_includes,
|
109
|
+
:terminate_after,
|
110
|
+
:stats,
|
111
|
+
:version,
|
112
|
+
:request_cache,
|
113
|
+
:refresh,
|
114
|
+
:timeout,
|
115
|
+
:wait_for_active_shards,
|
116
|
+
:scroll_size,
|
117
|
+
:wait_for_completion,
|
118
|
+
:requests_per_second,
|
119
|
+
:slices
|
120
|
+
].freeze)
|
121
|
+
end
|
109
122
|
end
|
110
|
-
end
|
111
123
|
end
|
@@ -0,0 +1,39 @@
|
|
1
|
+
# Licensed to Elasticsearch B.V under one or more agreements.
|
2
|
+
# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
|
3
|
+
# See the LICENSE file in the project root for more information
|
4
|
+
|
5
|
+
module Elasticsearch
|
6
|
+
module API
|
7
|
+
module Actions
|
8
|
+
# Changes the number of requests per second for a particular Delete By Query operation.
|
9
|
+
#
|
10
|
+
# @option arguments [String] :task_id The task id to rethrottle
|
11
|
+
# @option arguments [Number] :requests_per_second The throttle to set on this request in floating sub-requests per second. -1 means set no throttle. (*Required*)
|
12
|
+
|
13
|
+
#
|
14
|
+
# @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/docs-delete-by-query.html
|
15
|
+
#
|
16
|
+
def delete_by_query_rethrottle(arguments = {})
|
17
|
+
raise ArgumentError, "Required argument 'task_id' missing" unless arguments[:task_id]
|
18
|
+
|
19
|
+
arguments = arguments.clone
|
20
|
+
|
21
|
+
_task_id = arguments.delete(:task_id)
|
22
|
+
|
23
|
+
method = Elasticsearch::API::HTTP_POST
|
24
|
+
path = "_delete_by_query/#{Utils.__listify(_task_id)}/_rethrottle"
|
25
|
+
params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
|
26
|
+
|
27
|
+
body = nil
|
28
|
+
perform_request(method, path, params, body).body
|
29
|
+
end
|
30
|
+
|
31
|
+
# Register this action with its valid params when the module is loaded.
|
32
|
+
#
|
33
|
+
# @since 6.2.0
|
34
|
+
ParamsRegistry.register(:delete_by_query_rethrottle, [
|
35
|
+
:requests_per_second
|
36
|
+
].freeze)
|
37
|
+
end
|
38
|
+
end
|
39
|
+
end
|
@@ -5,7 +5,6 @@
|
|
5
5
|
module Elasticsearch
|
6
6
|
module API
|
7
7
|
module Actions
|
8
|
-
|
9
8
|
# The value of requests_per_second can be changed on a running delete by query using the _rethrottle API
|
10
9
|
#
|
11
10
|
# @option arguments [String] :task_id The task id to rethrottle (*Required*)
|
@@ -13,8 +12,9 @@ module Elasticsearch
|
|
13
12
|
#
|
14
13
|
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-delete-by-query.html
|
15
14
|
#
|
16
|
-
def delete_by_query_rethrottle(arguments={})
|
15
|
+
def delete_by_query_rethrottle(arguments = {})
|
17
16
|
raise ArgumentError, "Required argument 'task_id' missing" unless arguments[:task_id]
|
17
|
+
|
18
18
|
method = Elasticsearch::API::HTTP_POST
|
19
19
|
path = "_delete_by_query/#{arguments[:task_id]}/_rethrottle"
|
20
20
|
params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
|
@@ -27,7 +27,8 @@ module Elasticsearch
|
|
27
27
|
#
|
28
28
|
# @since 6.2.0
|
29
29
|
ParamsRegistry.register(:delete_by_query_rethrottle, [
|
30
|
-
|
30
|
+
:requests_per_second
|
31
|
+
].freeze)
|
31
32
|
end
|
32
33
|
end
|
33
34
|
end
|
@@ -5,31 +5,37 @@
|
|
5
5
|
module Elasticsearch
|
6
6
|
module API
|
7
7
|
module Actions
|
8
|
-
|
9
|
-
# Remove an indexed script from Elasticsearch
|
8
|
+
# Deletes a script.
|
10
9
|
#
|
11
|
-
# @option arguments [String] :id Script ID
|
10
|
+
# @option arguments [String] :id Script ID
|
12
11
|
# @option arguments [Time] :timeout Explicit operation timeout
|
13
12
|
# @option arguments [Time] :master_timeout Specify timeout for connection to master
|
13
|
+
|
14
14
|
#
|
15
|
-
# @see https://www.elastic.co/guide/en/elasticsearch/reference/
|
15
|
+
# @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/modules-scripting.html
|
16
16
|
#
|
17
|
-
def delete_script(arguments={})
|
18
|
-
raise ArgumentError, "Required argument 'id' missing"
|
19
|
-
|
20
|
-
|
17
|
+
def delete_script(arguments = {})
|
18
|
+
raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
|
19
|
+
|
20
|
+
arguments = arguments.clone
|
21
|
+
|
22
|
+
_id = arguments.delete(:id)
|
23
|
+
|
24
|
+
method = Elasticsearch::API::HTTP_DELETE
|
25
|
+
path = "_scripts/#{Utils.__listify(_id)}"
|
21
26
|
params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
|
22
|
-
body = nil
|
23
27
|
|
28
|
+
body = nil
|
24
29
|
perform_request(method, path, params, body).body
|
25
30
|
end
|
26
31
|
|
27
32
|
# Register this action with its valid params when the module is loaded.
|
28
33
|
#
|
29
|
-
# @since 6.
|
34
|
+
# @since 6.2.0
|
30
35
|
ParamsRegistry.register(:delete_script, [
|
31
|
-
|
32
|
-
|
36
|
+
:timeout,
|
37
|
+
:master_timeout
|
38
|
+
].freeze)
|
39
|
+
end
|
33
40
|
end
|
34
|
-
end
|
35
41
|
end
|
@@ -5,18 +5,12 @@
|
|
5
5
|
module Elasticsearch
|
6
6
|
module API
|
7
7
|
module Actions
|
8
|
-
|
9
|
-
# Return true if the specified document exists, false otherwise.
|
10
|
-
#
|
11
|
-
# @example
|
8
|
+
# Returns information about whether a document exists in an index.
|
12
9
|
#
|
13
|
-
#
|
14
|
-
#
|
15
|
-
# @option arguments [String] :
|
16
|
-
# @option arguments [String] :index The name of the index (*Required*)
|
17
|
-
# @option arguments [String] :type The type of the document (use `_all` to fetch the first document matching the ID across all types)
|
10
|
+
# @option arguments [String] :id The document ID
|
11
|
+
# @option arguments [String] :index The name of the index
|
12
|
+
# @option arguments [String] :type The type of the document (use `_all` to fetch the first document matching the ID across all types) *Deprecated*
|
18
13
|
# @option arguments [List] :stored_fields A comma-separated list of stored fields to return in the response
|
19
|
-
# @option arguments [String] :parent The ID of the parent document
|
20
14
|
# @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random)
|
21
15
|
# @option arguments [Boolean] :realtime Specify whether to perform the operation in realtime or search mode
|
22
16
|
# @option arguments [Boolean] :refresh Refresh the shard containing the document before performing the operation
|
@@ -25,44 +19,60 @@ module Elasticsearch
|
|
25
19
|
# @option arguments [List] :_source_excludes A list of fields to exclude from the returned _source field
|
26
20
|
# @option arguments [List] :_source_includes A list of fields to extract and return from the _source field
|
27
21
|
# @option arguments [Number] :version Explicit version number for concurrency control
|
28
|
-
# @option arguments [String] :version_type Specific version type
|
22
|
+
# @option arguments [String] :version_type Specific version type
|
23
|
+
# (options: internal,external,external_gte,force)
|
29
24
|
|
30
25
|
#
|
31
|
-
#
|
26
|
+
# *Deprecation notice*:
|
27
|
+
# Specifying types in urls has been deprecated
|
28
|
+
# Deprecated since version 7.0.0
|
29
|
+
#
|
32
30
|
#
|
33
|
-
|
34
|
-
|
31
|
+
# @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/docs-get.html
|
32
|
+
#
|
33
|
+
def exists(arguments = {})
|
35
34
|
raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
|
36
|
-
arguments[:
|
37
|
-
|
38
|
-
|
39
|
-
|
40
|
-
|
35
|
+
raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
|
36
|
+
|
37
|
+
arguments = arguments.clone
|
38
|
+
|
39
|
+
_id = arguments.delete(:id)
|
40
|
+
|
41
|
+
_index = arguments.delete(:index)
|
41
42
|
|
43
|
+
_type = arguments.delete(:type)
|
44
|
+
|
45
|
+
method = Elasticsearch::API::HTTP_HEAD
|
46
|
+
path = if _index && _type && _id
|
47
|
+
"#{Utils.__listify(_index)}/#{Utils.__listify(_type)}/#{Utils.__listify(_id)}"
|
48
|
+
else
|
49
|
+
"#{Utils.__listify(_index)}/_doc/#{Utils.__listify(_id)}"
|
50
|
+
end
|
42
51
|
params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
|
43
|
-
|
52
|
+
|
53
|
+
body = nil
|
44
54
|
|
45
55
|
Utils.__rescue_from_not_found do
|
46
56
|
perform_request(method, path, params, body).status == 200 ? true : false
|
47
57
|
end
|
48
58
|
end
|
49
|
-
alias_method :exists?, :exists
|
50
59
|
|
60
|
+
alias_method :exists?, :exists
|
51
61
|
# Register this action with its valid params when the module is loaded.
|
52
62
|
#
|
53
|
-
# @since 6.
|
63
|
+
# @since 6.2.0
|
54
64
|
ParamsRegistry.register(:exists, [
|
55
|
-
|
56
|
-
|
57
|
-
|
58
|
-
|
59
|
-
|
60
|
-
|
61
|
-
|
62
|
-
|
63
|
-
|
64
|
-
|
65
|
-
|
65
|
+
:stored_fields,
|
66
|
+
:preference,
|
67
|
+
:realtime,
|
68
|
+
:refresh,
|
69
|
+
:routing,
|
70
|
+
:_source,
|
71
|
+
:_source_excludes,
|
72
|
+
:_source_includes,
|
73
|
+
:version,
|
74
|
+
:version_type
|
75
|
+
].freeze)
|
76
|
+
end
|
66
77
|
end
|
67
|
-
end
|
68
78
|
end
|
@@ -5,13 +5,11 @@
|
|
5
5
|
module Elasticsearch
|
6
6
|
module API
|
7
7
|
module Actions
|
8
|
-
|
9
|
-
# The get API allows to get a typed JSON document from the index based on its id.
|
8
|
+
# Returns information about whether a document source exists in an index.
|
10
9
|
#
|
11
|
-
# @option arguments [String] :id The document ID
|
12
|
-
# @option arguments [String] :index The name of the index
|
13
|
-
# @option arguments [String] :type The type of the document;
|
14
|
-
# @option arguments [String] :parent The ID of the parent document
|
10
|
+
# @option arguments [String] :id The document ID
|
11
|
+
# @option arguments [String] :index The name of the index
|
12
|
+
# @option arguments [String] :type The type of the document; deprecated and optional starting with 7.0 *Deprecated*
|
15
13
|
# @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random)
|
16
14
|
# @option arguments [Boolean] :realtime Specify whether to perform the operation in realtime or search mode
|
17
15
|
# @option arguments [Boolean] :refresh Refresh the shard containing the document before performing the operation
|
@@ -20,36 +18,56 @@ module Elasticsearch
|
|
20
18
|
# @option arguments [List] :_source_excludes A list of fields to exclude from the returned _source field
|
21
19
|
# @option arguments [List] :_source_includes A list of fields to extract and return from the _source field
|
22
20
|
# @option arguments [Number] :version Explicit version number for concurrency control
|
23
|
-
# @option arguments [String] :version_type Specific version type
|
21
|
+
# @option arguments [String] :version_type Specific version type
|
22
|
+
# (options: internal,external,external_gte,force)
|
23
|
+
|
24
24
|
#
|
25
|
-
#
|
25
|
+
# *Deprecation notice*:
|
26
|
+
# Specifying types in urls has been deprecated
|
27
|
+
# Deprecated since version 7.0.0
|
26
28
|
#
|
27
|
-
|
28
|
-
|
29
|
+
#
|
30
|
+
# @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/docs-get.html
|
31
|
+
#
|
32
|
+
def exists_source(arguments = {})
|
29
33
|
raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
|
30
|
-
raise ArgumentError, "Required argument '
|
34
|
+
raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
|
35
|
+
|
36
|
+
arguments = arguments.clone
|
37
|
+
|
38
|
+
_id = arguments.delete(:id)
|
39
|
+
|
40
|
+
_index = arguments.delete(:index)
|
41
|
+
|
42
|
+
_type = arguments.delete(:type)
|
43
|
+
|
31
44
|
method = Elasticsearch::API::HTTP_HEAD
|
32
|
-
path =
|
33
|
-
|
34
|
-
|
45
|
+
path = if _index && _type && _id
|
46
|
+
"#{Utils.__listify(_index)}/#{Utils.__listify(_type)}/#{Utils.__listify(_id)}/_source"
|
47
|
+
else
|
48
|
+
"#{Utils.__listify(_index)}/_source/#{Utils.__listify(_id)}"
|
49
|
+
end
|
50
|
+
params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
|
35
51
|
|
52
|
+
body = nil
|
36
53
|
perform_request(method, path, params, body).body
|
37
54
|
end
|
38
55
|
|
56
|
+
alias_method :exists_source?, :exists_source
|
39
57
|
# Register this action with its valid params when the module is loaded.
|
40
58
|
#
|
41
59
|
# @since 6.2.0
|
42
60
|
ParamsRegistry.register(:exists_source, [
|
43
|
-
|
44
|
-
|
45
|
-
|
46
|
-
|
47
|
-
|
48
|
-
|
49
|
-
|
50
|
-
|
51
|
-
|
52
|
-
|
61
|
+
:preference,
|
62
|
+
:realtime,
|
63
|
+
:refresh,
|
64
|
+
:routing,
|
65
|
+
:_source,
|
66
|
+
:_source_excludes,
|
67
|
+
:_source_includes,
|
68
|
+
:version,
|
69
|
+
:version_type
|
70
|
+
].freeze)
|
71
|
+
end
|
53
72
|
end
|
54
|
-
end
|
55
73
|
end
|
@@ -5,81 +5,76 @@
|
|
5
5
|
module Elasticsearch
|
6
6
|
module API
|
7
7
|
module Actions
|
8
|
-
|
9
|
-
# Return information if and how well a document matches a query.
|
10
|
-
#
|
11
|
-
# The returned information contains a `_score` and its explanation, if the document matches the query.
|
12
|
-
#
|
13
|
-
# @example Passing the query in the Lucene query syntax as the `:q` URL parameter
|
14
|
-
#
|
15
|
-
# client.explain index: 'myindex', type: 'mytype', id: '1', q: 'test'
|
16
|
-
#
|
17
|
-
# @example Passing the query in the Query DSL as the request `:body`
|
8
|
+
# Returns information about why a specific matches (or doesn't match) a query.
|
18
9
|
#
|
19
|
-
#
|
20
|
-
#
|
21
|
-
#
|
22
|
-
# @option arguments [String] :id The document ID (*Required*)
|
23
|
-
# @option arguments [String] :index The name of the index (*Required*)
|
24
|
-
# @option arguments [String] :type The type of the document
|
25
|
-
# @option arguments [Hash] :body The query definition using the Query DSL
|
10
|
+
# @option arguments [String] :id The document ID
|
11
|
+
# @option arguments [String] :index The name of the index
|
12
|
+
# @option arguments [String] :type The type of the document *Deprecated*
|
26
13
|
# @option arguments [Boolean] :analyze_wildcard Specify whether wildcards and prefix queries in the query string query should be analyzed (default: false)
|
27
14
|
# @option arguments [String] :analyzer The analyzer for the query string query
|
28
|
-
# @option arguments [String] :default_operator The default operator for query string query (AND or OR)
|
15
|
+
# @option arguments [String] :default_operator The default operator for query string query (AND or OR)
|
16
|
+
# (options: AND,OR)
|
17
|
+
|
29
18
|
# @option arguments [String] :df The default field for query string query (default: _all)
|
30
19
|
# @option arguments [List] :stored_fields A comma-separated list of stored fields to return in the response
|
31
20
|
# @option arguments [Boolean] :lenient Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
|
32
|
-
# @option arguments [String] :parent The ID of the parent document
|
33
21
|
# @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random)
|
34
22
|
# @option arguments [String] :q Query in the Lucene query string syntax
|
35
23
|
# @option arguments [String] :routing Specific routing value
|
36
24
|
# @option arguments [List] :_source True or false to return the _source field or not, or a list of fields to return
|
37
25
|
# @option arguments [List] :_source_excludes A list of fields to exclude from the returned _source field
|
38
26
|
# @option arguments [List] :_source_includes A list of fields to extract and return from the _source field
|
27
|
+
|
28
|
+
# @option arguments [Hash] :body The query definition using the Query DSL
|
39
29
|
#
|
40
|
-
#
|
30
|
+
# *Deprecation notice*:
|
31
|
+
# Specifying types in urls has been deprecated
|
32
|
+
# Deprecated since version 7.0.0
|
41
33
|
#
|
42
|
-
|
34
|
+
#
|
35
|
+
# @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/search-explain.html
|
36
|
+
#
|
37
|
+
def explain(arguments = {})
|
43
38
|
raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
|
44
|
-
raise ArgumentError, "Required argument 'id' missing"
|
45
|
-
method = HTTP_GET
|
39
|
+
raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
|
46
40
|
|
47
|
-
|
48
|
-
path = Utils.__pathify Utils.__escape(arguments[:index]),
|
49
|
-
Utils.__escape(arguments[:type]),
|
50
|
-
Utils.__escape(arguments[:id]),
|
51
|
-
'_explain'
|
52
|
-
else
|
53
|
-
path = Utils.__pathify Utils.__escape(arguments[:index]),
|
54
|
-
'_explain',
|
55
|
-
Utils.__escape(arguments[:id])
|
56
|
-
end
|
41
|
+
arguments = arguments.clone
|
57
42
|
|
58
|
-
|
59
|
-
body = arguments[:body]
|
43
|
+
_id = arguments.delete(:id)
|
60
44
|
|
61
|
-
|
45
|
+
_index = arguments.delete(:index)
|
62
46
|
|
47
|
+
_type = arguments.delete(:type)
|
48
|
+
|
49
|
+
method = Elasticsearch::API::HTTP_GET
|
50
|
+
path = if _index && _type && _id
|
51
|
+
"#{Utils.__listify(_index)}/#{Utils.__listify(_type)}/#{Utils.__listify(_id)}/_explain"
|
52
|
+
else
|
53
|
+
"#{Utils.__listify(_index)}/_explain/#{Utils.__listify(_id)}"
|
54
|
+
end
|
55
|
+
params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
|
56
|
+
|
57
|
+
body = arguments[:body]
|
63
58
|
perform_request(method, path, params, body).body
|
64
59
|
end
|
65
60
|
|
66
61
|
# Register this action with its valid params when the module is loaded.
|
67
62
|
#
|
68
|
-
# @since 6.
|
63
|
+
# @since 6.2.0
|
69
64
|
ParamsRegistry.register(:explain, [
|
70
|
-
|
71
|
-
|
72
|
-
|
73
|
-
|
74
|
-
|
75
|
-
|
76
|
-
|
77
|
-
|
78
|
-
|
79
|
-
|
80
|
-
|
81
|
-
|
82
|
-
|
65
|
+
:analyze_wildcard,
|
66
|
+
:analyzer,
|
67
|
+
:default_operator,
|
68
|
+
:df,
|
69
|
+
:stored_fields,
|
70
|
+
:lenient,
|
71
|
+
:preference,
|
72
|
+
:q,
|
73
|
+
:routing,
|
74
|
+
:_source,
|
75
|
+
:_source_excludes,
|
76
|
+
:_source_includes
|
77
|
+
].freeze)
|
78
|
+
end
|
83
79
|
end
|
84
|
-
end
|
85
80
|
end
|