mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-02-17 18:35:25 +00:00
f4bf0d5112
* `ignore_unavailable` - Controls whether to ignore if any specified indices are unavailable, this includes indices that don't exist or closed indices. Either `true` or `false` can be specified. * `allow_no_indices` - Controls whether to fail if a wildcard indices expressions results into no concrete indices. Either `true` or `false` can be specified. For example if the wildcard expression `foo*` is specified and no indices are available that start with `foo` then depending on this setting the request will fail. This setting is also applicable when `_all`, `*` or no index has been specified. * `expand_wildcards` - Controls to what kind of concrete indices wildcard indices expression expand to. If `open` is specified then the wildcard expression if expanded to only open indices and if `closed` is specified then the wildcard expression if expanded only to closed indices. Also both values (`open,closed`) can be specified to expand to all indices. Closes to #4436
82 lines
2.8 KiB
JSON
82 lines
2.8 KiB
JSON
{
|
|
"delete_by_query": {
|
|
"documentation": "http://www.elasticsearch.org/guide/reference/api/delete-by-query/",
|
|
"methods": ["DELETE"],
|
|
"url": {
|
|
"path": "/{index}/_query",
|
|
"paths": ["/{index}/_query", "/{index}/{type}/_query"],
|
|
"parts": {
|
|
"index": {
|
|
"type" : "list",
|
|
"required": true,
|
|
"description" : "A comma-separated list of indices to restrict the operation; use `_all` to perform the operation on all indices"
|
|
},
|
|
"type": {
|
|
"type" : "list",
|
|
"description" : "A comma-separated list of types to restrict the operation"
|
|
}
|
|
},
|
|
"params": {
|
|
"analyzer": {
|
|
"type" : "string",
|
|
"description" : "The analyzer to use for the query string"
|
|
},
|
|
"consistency": {
|
|
"type" : "enum",
|
|
"options" : ["one", "quorum", "all"],
|
|
"description" : "Specific write consistency setting for the operation"
|
|
},
|
|
"default_operator": {
|
|
"type" : "enum",
|
|
"options" : ["AND","OR"],
|
|
"default" : "OR",
|
|
"description" : "The default operator for query string query (AND or OR)"
|
|
},
|
|
"df": {
|
|
"type" : "string",
|
|
"description" : "The field to use as default where no field prefix is given in the query string"
|
|
},
|
|
"ignore_unavailable": {
|
|
"type" : "boolean",
|
|
"description" : "Whether specified concrete indices should be ignored when unavailable (missing or closed)"
|
|
},
|
|
"allow_no_indices": {
|
|
"type" : "boolean",
|
|
"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)"
|
|
},
|
|
"expand_wildcards": {
|
|
"type" : "enum",
|
|
"options" : ["open","closed"],
|
|
"default" : "open",
|
|
"description" : "Whether to expand wildcard expression to concrete indices that are open, closed or both."
|
|
},
|
|
"replication": {
|
|
"type" : "enum",
|
|
"options" : ["sync","async"],
|
|
"default" : "sync",
|
|
"description" : "Specific replication type"
|
|
},
|
|
"q": {
|
|
"type" : "string",
|
|
"description" : "Query in the Lucene query string syntax"
|
|
},
|
|
"routing": {
|
|
"type" : "string",
|
|
"description" : "Specific routing value"
|
|
},
|
|
"source": {
|
|
"type" : "string",
|
|
"description" : "The URL-encoded query definition (instead of using the request body)"
|
|
},
|
|
"timeout": {
|
|
"type" : "time",
|
|
"description" : "Explicit operation timeout"
|
|
}
|
|
}
|
|
},
|
|
"body": {
|
|
"description" : "A query to restrict the operation specified with the Query DSL"
|
|
}
|
|
}
|
|
}
|