|
| 1 | +{ |
| 2 | + "update_by_query": { |
| 3 | + "documentation": "https://www.elastic.co/guide/en/elasticsearch/plugins/master/plugins-reindex.html", |
| 4 | + "methods": ["POST"], |
| 5 | + "url": { |
| 6 | + "path": "/{index}/_update_by_query", |
| 7 | + "paths": ["/{index}/_update_by_query", "/{index}/{type}/_update_by_query"], |
| 8 | + "comment": "most things below this are just copied from search.json", |
| 9 | + "parts": { |
| 10 | + "index": { |
| 11 | + "type" : "list", |
| 12 | + "description" : "A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices" |
| 13 | + }, |
| 14 | + "type": { |
| 15 | + "type" : "list", |
| 16 | + "description" : "A comma-separated list of document types to search; leave empty to perform the operation on all types" |
| 17 | + } |
| 18 | + }, |
| 19 | + "params": { |
| 20 | + "analyzer": { |
| 21 | + "type" : "string", |
| 22 | + "description" : "The analyzer to use for the query string" |
| 23 | + }, |
| 24 | + "analyze_wildcard": { |
| 25 | + "type" : "boolean", |
| 26 | + "description" : "Specify whether wildcard and prefix queries should be analyzed (default: false)" |
| 27 | + }, |
| 28 | + "default_operator": { |
| 29 | + "type" : "enum", |
| 30 | + "options" : ["AND","OR"], |
| 31 | + "default" : "OR", |
| 32 | + "description" : "The default operator for query string query (AND or OR)" |
| 33 | + }, |
| 34 | + "df": { |
| 35 | + "type" : "string", |
| 36 | + "description" : "The field to use as default where no field prefix is given in the query string" |
| 37 | + }, |
| 38 | + "explain": { |
| 39 | + "type" : "boolean", |
| 40 | + "description" : "Specify whether to return detailed information about score computation as part of a hit" |
| 41 | + }, |
| 42 | + "fields": { |
| 43 | + "type" : "list", |
| 44 | + "description" : "A comma-separated list of fields to return as part of a hit" |
| 45 | + }, |
| 46 | + "fielddata_fields": { |
| 47 | + "type" : "list", |
| 48 | + "description" : "A comma-separated list of fields to return as the field data representation of a field for each hit" |
| 49 | + }, |
| 50 | + "from": { |
| 51 | + "type" : "number", |
| 52 | + "description" : "Starting offset (default: 0)" |
| 53 | + }, |
| 54 | + "ignore_unavailable": { |
| 55 | + "type" : "boolean", |
| 56 | + "description" : "Whether specified concrete indices should be ignored when unavailable (missing or closed)" |
| 57 | + }, |
| 58 | + "allow_no_indices": { |
| 59 | + "type" : "boolean", |
| 60 | + "description" : "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)" |
| 61 | + }, |
| 62 | + "conflicts": { |
| 63 | + "note": "This is not copied from search", |
| 64 | + "type" : "enum", |
| 65 | + "options": ["abort", "proceed"], |
| 66 | + "default": "abort", |
| 67 | + "description" : "What to do when the reindex hits version conflicts?" |
| 68 | + }, |
| 69 | + "expand_wildcards": { |
| 70 | + "type" : "enum", |
| 71 | + "options" : ["open","closed","none","all"], |
| 72 | + "default" : "open", |
| 73 | + "description" : "Whether to expand wildcard expression to concrete indices that are open, closed or both." |
| 74 | + }, |
| 75 | + "lenient": { |
| 76 | + "type" : "boolean", |
| 77 | + "description" : "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored" |
| 78 | + }, |
| 79 | + "lowercase_expanded_terms": { |
| 80 | + "type" : "boolean", |
| 81 | + "description" : "Specify whether query terms should be lowercased" |
| 82 | + }, |
| 83 | + "preference": { |
| 84 | + "type" : "string", |
| 85 | + "description" : "Specify the node or shard the operation should be performed on (default: random)" |
| 86 | + }, |
| 87 | + "q": { |
| 88 | + "type" : "string", |
| 89 | + "description" : "Query in the Lucene query string syntax" |
| 90 | + }, |
| 91 | + "routing": { |
| 92 | + "type" : "list", |
| 93 | + "description" : "A comma-separated list of specific routing values" |
| 94 | + }, |
| 95 | + "scroll": { |
| 96 | + "type" : "duration", |
| 97 | + "description" : "Specify how long a consistent view of the index should be maintained for scrolled search" |
| 98 | + }, |
| 99 | + "search_type": { |
| 100 | + "type" : "enum", |
| 101 | + "options" : ["query_then_fetch", "dfs_query_then_fetch"], |
| 102 | + "description" : "Search operation type" |
| 103 | + }, |
| 104 | + "search_timeout": { |
| 105 | + "type" : "time", |
| 106 | + "description" : "Explicit timeout for each search request. Defaults to no timeout." |
| 107 | + }, |
| 108 | + "size": { |
| 109 | + "type" : "number", |
| 110 | + "description" : "Number of hits to return (default: 10)" |
| 111 | + }, |
| 112 | + "sort": { |
| 113 | + "type" : "list", |
| 114 | + "description" : "A comma-separated list of <field>:<direction> pairs" |
| 115 | + }, |
| 116 | + "_source": { |
| 117 | + "type" : "list", |
| 118 | + "description" : "True or false to return the _source field or not, or a list of fields to return" |
| 119 | + }, |
| 120 | + "_source_exclude": { |
| 121 | + "type" : "list", |
| 122 | + "description" : "A list of fields to exclude from the returned _source field" |
| 123 | + }, |
| 124 | + "_source_include": { |
| 125 | + "type" : "list", |
| 126 | + "description" : "A list of fields to extract and return from the _source field" |
| 127 | + }, |
| 128 | + "terminate_after": { |
| 129 | + "type" : "number", |
| 130 | + "description" : "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early." |
| 131 | + }, |
| 132 | + "stats": { |
| 133 | + "type" : "list", |
| 134 | + "description" : "Specific 'tag' of the request for logging and statistical purposes" |
| 135 | + }, |
| 136 | + "suggest_field": { |
| 137 | + "type" : "string", |
| 138 | + "description" : "Specify which field to use for suggestions" |
| 139 | + }, |
| 140 | + "suggest_mode": { |
| 141 | + "type" : "enum", |
| 142 | + "options" : ["missing", "popular", "always"], |
| 143 | + "default" : "missing", |
| 144 | + "description" : "Specify suggest mode" |
| 145 | + }, |
| 146 | + "suggest_size": { |
| 147 | + "type" : "number", |
| 148 | + "description" : "How many suggestions to return in response" |
| 149 | + }, |
| 150 | + "suggest_text": { |
| 151 | + "type" : "text", |
| 152 | + "description" : "The source text for which the suggestions should be returned" |
| 153 | + }, |
| 154 | + "timeout": { |
| 155 | + "type" : "time", |
| 156 | + "description" : "Explicit operation timeout" |
| 157 | + }, |
| 158 | + "track_scores": { |
| 159 | + "type" : "boolean", |
| 160 | + "description": "Whether to calculate and return scores even if they are not used for sorting" |
| 161 | + }, |
| 162 | + "version": { |
| 163 | + "type" : "boolean", |
| 164 | + "description" : "Specify whether to return document version as part of a hit" |
| 165 | + }, |
| 166 | + "version_type": { |
| 167 | + "type" : "boolean", |
| 168 | + "description" : "Should the document increment the version number (internal) on hit or not (reindex)" |
| 169 | + }, |
| 170 | + "request_cache": { |
| 171 | + "type" : "boolean", |
| 172 | + "description" : "Specify if request cache should be used for this request or not, defaults to index level setting" |
| 173 | + }, |
| 174 | + "refresh": { |
| 175 | + "type" : "boolean", |
| 176 | + "description" : "Should the effected indexes be refreshed?" |
| 177 | + }, |
| 178 | + "timeout": { |
| 179 | + "type" : "time", |
| 180 | + "default": "1m", |
| 181 | + "description" : "Time each individual bulk request should wait for shards that are unavailable." |
| 182 | + }, |
| 183 | + "consistency": { |
| 184 | + "type" : "enum", |
| 185 | + "options" : ["one", "quorum", "all"], |
| 186 | + "description" : "Explicit write consistency setting for the operation" |
| 187 | + }, |
| 188 | + "scroll_size": { |
| 189 | + "type": "integer", |
| 190 | + "defaut_value": 100, |
| 191 | + "description": "Size on the scroll request powering the update_by_query" |
| 192 | + }, |
| 193 | + "wait_for_completion": { |
| 194 | + "type" : "boolean", |
| 195 | + "default": false, |
| 196 | + "description" : "Should the request should block until the reindex is complete." |
| 197 | + } |
| 198 | + } |
| 199 | + }, |
| 200 | + "body": { |
| 201 | + "description": "The search definition using the Query DSL" |
| 202 | + } |
| 203 | + } |
| 204 | +} |
0 commit comments