Elasticsearch Store: `Elasticsearch Client Method Helpers Update`
Table of contents
Functions
Functions
convertUpdateParams
▸ convertUpdateParams(params
, distributionMeta
): { _source?
: string
| boolean
| string
[] ; _source_excludes?
: string
| string
[] ; _source_includes?
: string
| string
[] ; body?
: { _source?
: boolean
| SearchSourceFilter
; detect_noop?
: boolean
; doc?
: unknown
; doc_as_upsert?
: boolean
; script?
: Script
; scripted_upsert?
: boolean
; upsert?
: unknown
} ; id
: string
; if_primary_term?
: number
; if_seq_no?
: number
; index
: string
; lang?
: string
; refresh?
: boolean
; require_alias?
: boolean
; retry_on_conflict?
: number
; routing?
: string
; source_enabled?
: boolean
; timeout?
: string
| number
; version?
: number
; wait_for_active_shards?
: WaitForActiveShards
} | { _source?
: string
| boolean
| string
[] | SearchSourceFilter
; _source_excludes?
: string
| string
[] ; _source_includes?
: string
| string
[] ; detect_noop?
: boolean
; doc?
: unknown
; doc_as_upsert?
: boolean
; id
: string
; if_primary_term?
: number
; if_seq_no?
: number
; index
: string
; lang?
: string
; refresh?
: boolean
; require_alias?
: boolean
; retry_on_conflict?
: number
; routing?
: string
; script?
: Script
; scripted_upsert?
: boolean
; source_enabled?
: boolean
; timeout?
: string
| number
; upsert?
: unknown
; version?
: number
; wait_for_active_shards?
: WaitForActiveShards
} | { _source?
: string
| boolean
| string
[] ; _source_excludes?
: string
| string
[] ; _source_includes?
: string
| string
[] ; body?
: { _source?
: boolean
| SearchSourceFilter
; detect_noop?
: boolean
; doc?
: unknown
; doc_as_upsert?
: boolean
; script?
: Script
; scripted_upsert?
: boolean
; upsert?
: unknown
} ; id
: string
; if_primary_term?
: number
; if_seq_no?
: number
; index
: string
; lang?
: string
; refresh?
: boolean
; require_alias?
: boolean
; retry_on_conflict?
: number
; routing?
: string
; source_enabled?
: boolean
; timeout?
: string
| number
; type
: string
; version?
: number
; wait_for_active_shards?
: WaitForActiveShards
}
Parameters
Name | Type |
---|---|
params | UpdateParams <unknown , unknown > |
distributionMeta | ClientMetadata |
Returns
{ _source?
: string
| boolean
| string
[] ; _source_excludes?
: string
| string
[] ; _source_includes?
: string
| string
[] ; body?
: { _source?
: boolean
| SearchSourceFilter
; detect_noop?
: boolean
; doc?
: unknown
; doc_as_upsert?
: boolean
; script?
: Script
; scripted_upsert?
: boolean
; upsert?
: unknown
} ; id
: string
; if_primary_term?
: number
; if_seq_no?
: number
; index
: string
; lang?
: string
; refresh?
: boolean
; require_alias?
: boolean
; retry_on_conflict?
: number
; routing?
: string
; source_enabled?
: boolean
; timeout?
: string
| number
; version?
: number
; wait_for_active_shards?
: WaitForActiveShards
} | { _source?
: string
| boolean
| string
[] | SearchSourceFilter
; _source_excludes?
: string
| string
[] ; _source_includes?
: string
| string
[] ; detect_noop?
: boolean
; doc?
: unknown
; doc_as_upsert?
: boolean
; id
: string
; if_primary_term?
: number
; if_seq_no?
: number
; index
: string
; lang?
: string
; refresh?
: boolean
; require_alias?
: boolean
; retry_on_conflict?
: number
; routing?
: string
; script?
: Script
; scripted_upsert?
: boolean
; source_enabled?
: boolean
; timeout?
: string
| number
; upsert?
: unknown
; version?
: number
; wait_for_active_shards?
: WaitForActiveShards
} | { _source?
: string
| boolean
| string
[] ; _source_excludes?
: string
| string
[] ; _source_includes?
: string
| string
[] ; body?
: { _source?
: boolean
| SearchSourceFilter
; detect_noop?
: boolean
; doc?
: unknown
; doc_as_upsert?
: boolean
; script?
: Script
; scripted_upsert?
: boolean
; upsert?
: unknown
} ; id
: string
; if_primary_term?
: number
; if_seq_no?
: number
; index
: string
; lang?
: string
; refresh?
: boolean
; require_alias?
: boolean
; retry_on_conflict?
: number
; routing?
: string
; source_enabled?
: boolean
; timeout?
: string
| number
; type
: string
; version?
: number
; wait_for_active_shards?
: WaitForActiveShards
}
Defined in
elasticsearch-store/src/elasticsearch-client/method-helpers/update.ts:3