Elasticsearch Store: `Elasticsearch Client Method Helpers Search`
Table of contents
Functions
Functions
convertSearchParams
▸ convertSearchParams(params
, distributionMeta
): Object
Parameters
Name | Type |
---|---|
params | SearchParams |
distributionMeta | ClientMetadata |
Returns
Object
Name | Type | ||||||
---|---|---|---|---|---|---|---|
_source? | string \ | boolean \ | string [] | ||||
_source_excludes? | string \ | string [] | |||||
_source_includes? | string \ | string [] | |||||
allow_no_indices? | boolean | ||||||
allow_partial_search_results? | boolean | ||||||
analyze_wildcard? | boolean | ||||||
analyzer? | string | ||||||
batched_reduce_size? | number | ||||||
body? | Record <string , any > | ||||||
ccs_minimize_roundtrips? | boolean | ||||||
default_operator? | string | ||||||
df? | string | ||||||
docvalue_fields? | string | ||||||
expand_wildcards? | ExpandWildcards | ||||||
explain? | boolean | ||||||
from? | number | ||||||
ignore? | number \ | number [] | |||||
ignore_throttled? | boolean | ||||||
ignore_unavailable? | boolean | ||||||
index? | string \ | string [] | |||||
lenient? | boolean | ||||||
max_concurrent_shard_requests? | number | ||||||
min_compatible_shard_node? | string | ||||||
pre_filter_shard_size? | number | ||||||
preference? | string | ||||||
q? | string | ||||||
request_cache? | boolean | ||||||
rest_total_hits_as_int? | boolean | ||||||
routing? | string \ | string [] | |||||
scroll? | `${number}d` \ | `${number}h` \ | `${number}m` \ | `${number}s` \ | `${number}ms` \ | `${number}micros` \ | `${number}nanos` |
search_type? | SearchTypes | ||||||
seq_no_primary_term? | boolean | ||||||
size? | number | ||||||
sort? | string | ||||||
stats? | string \ | string [] | |||||
stored_fields? | string | ||||||
suggest_field? | string | ||||||
suggest_mode? | SuggestMode | ||||||
suggest_size? | number | ||||||
suggest_text? | string | ||||||
terminate_after? | number | ||||||
timeout? | `${number}d` \ | `${number}h` \ | `${number}m` \ | `${number}s` \ | `${number}ms` \ | `${number}micros` \ | `${number}nanos` |
track_scores? | boolean | ||||||
track_total_hits? | number \ | boolean | |||||
typed_keys? | boolean | ||||||
version? | boolean |
Defined in
elasticsearch-store/src/elasticsearch-client/method-helpers/search.ts:3