Files
elasticsearch-js/docs/reference-reindex.asciidoc
2024-12-05 14:46:46 -06:00

91 lines
5.3 KiB
Plaintext

[[reference-reindex]]
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
[discrete]
=== client.reindex
Reindex documents. Copies documents from a source to a destination. The source can be any existing index, alias, or data stream. The destination must differ from the source. For example, you cannot reindex a data stream into itself.
{ref}/docs-reindex.html[{es} documentation]
[discrete]
==== Function signature
[source,ts]
----
(ReindexRequest, options?): Promise<ReindexResponse>
----
[discrete]
===== `ReindexRequest`
[source,ts]
----
interface ReindexRequest extends <<shared-type-request-base, RequestBase>> {
refresh?: boolean
requests_per_second?: <<shared-type-float, float>>
scroll?: <<shared-type-duration, Duration>>
slices?: <<shared-type-slices, Slices>>
timeout?: <<shared-type-duration, Duration>>
wait_for_active_shards?: <<shared-type-wait-for-active-shards, WaitForActiveShards>>
wait_for_completion?: boolean
require_alias?: boolean
conflicts?: <<shared-type-conflicts, Conflicts>>
dest: ReindexDestination
max_docs?: <<shared-type-long, long>>
script?: <<shared-type-script, Script>> | string
size?: <<shared-type-long, long>>
source: ReindexSource
}
----
[discrete]
===== `ReindexResponse`
[source,ts]
----
interface ReindexResponse {
batches?: <<shared-type-long, long>>
created?: <<shared-type-long, long>>
deleted?: <<shared-type-long, long>>
failures?: <<shared-type-bulk-index-by-scroll-failure, BulkIndexByScrollFailure>>[]
noops?: <<shared-type-long, long>>
retries?: <<shared-type-retries, Retries>>
requests_per_second?: <<shared-type-float, float>>
slice_id?: <<shared-type-integer, integer>>
task?: <<shared-type-task-id, TaskId>>
throttled_millis?: <<shared-type-epoch-time, EpochTime>><<<shared-type-unit-millis, UnitMillis>>>
throttled_until_millis?: <<shared-type-epoch-time, EpochTime>><<<shared-type-unit-millis, UnitMillis>>>
timed_out?: boolean
took?: <<shared-type-duration-value, DurationValue>><<<shared-type-unit-millis, UnitMillis>>>
total?: <<shared-type-long, long>>
updated?: <<shared-type-long, long>>
version_conflicts?: <<shared-type-long, long>>
}
----