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

client/method-helpers/deleteByQuery

Functions

convertDeleteByQueryParams()

convertDeleteByQueryParams(params, distributionMeta): object

Defined in: opensearch-client/src/client/method-helpers/deleteByQuery.ts:3

Parameters

Parameter	Type
params	DeleteByQueryParams
distributionMeta	ClientMetadata

Returns

object

allow_no_indices?

optional allow_no_indices: boolean

analyze_wildcard?

optional analyze_wildcard: boolean

analyzer?

optional analyzer: string

body

body: Record<string, any>

conflicts?

optional conflicts: "abort" | "proceed"

expand_wildcards?

optional expand_wildcards: ExpandWildcards

from?

optional from: number

ignore_unavailable?

optional ignore_unavailable: boolean

index

index: string | string[]

lenient?

optional lenient: boolean

max_docs?

optional max_docs: number

preference?

optional preference: string

q?

optional q: string

refresh?

optional refresh: boolean

request_cache?

optional request_cache: boolean

requests_per_second?

optional requests_per_second: number

routing?

optional routing: string | string[]

scroll?

optional scroll: string

scroll_size?

optional scroll_size: number

search_timeout?

optional search_timeout: string

search_type?

optional search_type: "query_then_fetch" | "dfs_query_then_fetch"

size?

optional size: number

slices?

optional slices: string | number

sort?

optional sort: string | string[]

stats?

optional stats: string | string[]

terminate_after?

optional terminate_after: number

timeout?

optional timeout: string

version?

optional version: boolean

wait_for_active_shards?

optional wait_for_active_shards: string

wait_for_completion?

optional wait_for_completion: boolean