@terascope/opensearch-client / client/method-helpers/search

client/method-helpers/search

Functions

convertSearchParams()

convertSearchParams(params, distributionMeta): object

Defined in: opensearch-client/src/client/method-helpers/search.ts:4

Parameters

Parameter	Type
params	SearchParams
distributionMeta	ClientMetadata

Returns

object

_source?

optional _source: string | boolean | string[]

_source_excludes?

optional _source_excludes: string | string[]

_source_includes?

optional _source_includes: string | string[]

allow_no_indices?

optional allow_no_indices: boolean

allow_partial_search_results?

optional allow_partial_search_results: boolean

analyze_wildcard?

optional analyze_wildcard: boolean

analyzer?

optional analyzer: string

batched_reduce_size?

optional batched_reduce_size: number

body?

optional body: Record<string, any>

ccs_minimize_roundtrips?

optional ccs_minimize_roundtrips: boolean

default_operator?

optional default_operator: string

df?

optional df: string

docvalue_fields?

optional docvalue_fields: string

expand_wildcards?

optional expand_wildcards: ExpandWildcards

explain?

optional explain: boolean

from?

optional from: number

ignore?

optional ignore: number | number[]

ignore_throttled?

optional ignore_throttled: boolean

ignore_unavailable?

optional ignore_unavailable: boolean

index?

optional index: string | string[]

lenient?

optional lenient: boolean

max_concurrent_shard_requests?

optional max_concurrent_shard_requests: number

min_compatible_shard_node?

optional min_compatible_shard_node: string

pre_filter_shard_size?

optional pre_filter_shard_size: number

preference?

optional preference: string

q?

optional q: string

request_cache?

optional request_cache: boolean

rest_total_hits_as_int?

optional rest_total_hits_as_int: boolean

routing?

optional routing: string | string[]

scroll?

optional scroll: `${number}d` | `${number}h` | `${number}m` | `${number}s` | `${number}ms` | `${number}micros` | `${number}nanos`

search_type?

optional search_type: SearchTypes

seq_no_primary_term?

optional seq_no_primary_term: boolean

size?

optional size: number

sort?

optional sort: string

stats?

optional stats: string | string[]

stored_fields?

optional stored_fields: string

suggest_field?

optional suggest_field: string

suggest_mode?

optional suggest_mode: SuggestMode

suggest_size?

optional suggest_size: number

suggest_text?

optional suggest_text: string

terminate_after?

optional terminate_after: number

timeout?

optional timeout: `${number}d` | `${number}h` | `${number}m` | `${number}s` | `${number}ms` | `${number}micros` | `${number}nanos`

track_scores?

optional track_scores: boolean

track_total_hits?

optional track_total_hits: number | boolean = trackTotal

type?

optional type: string

typed_keys?

optional typed_keys: boolean

version?

optional version: boolean