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

client/method-helpers/deleteByQuery

Functions

convertDeleteByQueryParams()

convertDeleteByQueryParams(params, distributionMeta): { allow_no_indices?: boolean; analyze_wildcard?: boolean; analyzer?: string; body: Record<string, any>; conflicts?: "abort" | "proceed"; expand_wildcards?: ExpandWildcards; from?: number; ignore_unavailable?: boolean; index: string | string[]; lenient?: boolean; max_docs?: number; preference?: string; q?: string; refresh?: boolean; request_cache?: boolean; requests_per_second?: number; routing?: string | string[]; scroll?: string; scroll_size?: number; search_timeout?: string; search_type?: "query_then_fetch" | "dfs_query_then_fetch"; size?: number; slices?: string | number; sort?: string | string[]; stats?: string | string[]; terminate_after?: number; timeout?: string; version?: boolean; wait_for_active_shards?: string; wait_for_completion?: boolean; } | { allow_no_indices?: boolean; analyze_wildcard?: boolean; analyzer?: string; body: Record<string, any>; conflicts?: "abort" | "proceed"; expand_wildcards?: ExpandWildcards; from?: number; ignore_unavailable?: boolean; index: string | string[]; lenient?: boolean; max_docs?: number; preference?: string; q?: string; refresh?: boolean; request_cache?: boolean; requests_per_second?: number; routing?: string | string[]; scroll?: string; scroll_size?: number; search_timeout?: string; search_type?: "query_then_fetch" | "dfs_query_then_fetch"; size?: number; slices?: string | number; sort?: string | string[]; stats?: string | string[]; terminate_after?: number; timeout?: string; type: string | string[]; version?: boolean; wait_for_active_shards?: string; wait_for_completion?: boolean; }

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

Parameters

Parameter	Type
params	DeleteByQueryParams
distributionMeta	ClientMetadata

Returns

{ allow_no_indices?: boolean; analyze_wildcard?: boolean; analyzer?: string; body: Record<string, any>; conflicts?: "abort" | "proceed"; expand_wildcards?: ExpandWildcards; from?: number; ignore_unavailable?: boolean; index: string | string[]; lenient?: boolean; max_docs?: number; preference?: string; q?: string; refresh?: boolean; request_cache?: boolean; requests_per_second?: number; routing?: string | string[]; scroll?: string; scroll_size?: number; search_timeout?: string; search_type?: "query_then_fetch" | "dfs_query_then_fetch"; size?: number; slices?: string | number; sort?: string | string[]; stats?: string | string[]; terminate_after?: number; timeout?: string; version?: boolean; wait_for_active_shards?: string; wait_for_completion?: boolean; } | { allow_no_indices?: boolean; analyze_wildcard?: boolean; analyzer?: string; body: Record<string, any>; conflicts?: "abort" | "proceed"; expand_wildcards?: ExpandWildcards; from?: number; ignore_unavailable?: boolean; index: string | string[]; lenient?: boolean; max_docs?: number; preference?: string; q?: string; refresh?: boolean; request_cache?: boolean; requests_per_second?: number; routing?: string | string[]; scroll?: string; scroll_size?: number; search_timeout?: string; search_type?: "query_then_fetch" | "dfs_query_then_fetch"; size?: number; slices?: string | number; sort?: string | string[]; stats?: string | string[]; terminate_after?: number; timeout?: string; type: string | string[]; version?: boolean; wait_for_active_shards?: string; wait_for_completion?: boolean; }