habsi/elasticsearch-js
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

API generation

Browse Source
This commit is contained in:
delvedor
2020-03-24 08:48:18 +01:00
parent 8de88b0154
commit f99fe71b67
1 changed files with 13 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
docs/reference.asciidoc
View File

@ -3898,8 +3898,7 @@ link:{ref}/search-multi-search.html[Documentation] +
|`boolean` - Specify whether aggregation and suggester names should be prefixed by their respective types in the response
|`pre_filter_shard_size` or `preFilterShardSize`
|`number` - 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`
|`number` - 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 its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint.
|`max_concurrent_shard_requests` or `maxConcurrentShardRequests`
|`number` - The number of concurrent shard requests each sub search executes concurrently per node. 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 +
@ -4603,8 +4602,7 @@ _Default:_ `512`
_Default:_ `5`
|`pre_filter_shard_size` or `preFilterShardSize`
|`number` - 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`
|`number` - 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 its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint.
|`rest_total_hits_as_int` or `restTotalHitsAsInt`
|`boolean` - Indicates whether hits.total should be rendered as an integer or an object in the rest search response
@ -5433,7 +5431,7 @@ link:{ref}/docs-update-by-query.html[Documentation] +
|===
=== asyncSearch.delete
*Stability:* experimental
[source,ts]
----
client.asyncSearch.delete({
@ -5449,7 +5447,7 @@ link:{ref}/async-search.html[Documentation] +
|===
=== asyncSearch.get
*Stability:* experimental
[source,ts]
----
client.asyncSearch.get({
@ -5479,14 +5477,16 @@ _Default:_ `5d`
|===
=== asyncSearch.submit
*Stability:* experimental
[source,ts]
----
client.asyncSearch.submit({
index: string | string[],
wait_for_completion: string,
clean_on_completion: boolean,
keep_alive: string,
batched_reduce_size: number,
request_cache: boolean,
analyzer: string,
analyze_wildcard: boolean,
default_operator: 'AND' | 'OR',
@ -5522,9 +5522,7 @@ client.asyncSearch.submit({
typed_keys: boolean,
version: boolean,
seq_no_primary_term: boolean,
request_cache: boolean,
max_concurrent_shard_requests: number,
clean_on_completion: boolean,
body: object
})
----
@ -5538,6 +5536,9 @@ link:{ref}/async-search.html[Documentation] +
|`string` - Specify the time that the request should block waiting for the final response +
_Default:_ `1s`
|`clean_on_completion` or `cleanOnCompletion`
|`boolean` - Control whether the response should not be stored in the cluster if it completed within the provided [wait_for_completion] time (default: true)
|`keep_alive` or `keepAlive`
|`string` - Update the time interval in which the results (partial or final) for this search will be available
@ -5545,6 +5546,9 @@ _Default:_ `1s`
|`number` - The number of shard results that should be reduced at once on the coordinating node. This value should be used as the granularity at which progress results will be made available. +
_Default:_ `5`
|`request_cache` or `requestCache`
|`boolean` - Specify if request cache should be used for this request or not, defaults to true
|`analyzer`
|`string` - The analyzer to use for the query string
@ -5654,16 +5658,10 @@ _Default:_ `true`
|`seq_no_primary_term` or `seqNoPrimaryTerm`
|`boolean` - Specify whether to return sequence number and primary term of the last modification of each hit
|`request_cache` or `requestCache`
|`boolean` - Specify if request cache should be used for this request or not, defaults to index level setting
|`max_concurrent_shard_requests` or `maxConcurrentShardRequests`
|`number` - The number of concurrent shard requests per node 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:_ `5`
|`clean_on_completion` or `cleanOnCompletion`
|`boolean` - Control whether the response should not be stored in the cluster if it completed within the provided [wait_for_completion] time (default: true)
|`body`
|`object` - The search definition using the Query DSL