89 lines
4.5 KiB
Plaintext
89 lines
4.5 KiB
Plaintext
[[reference-bulk]]
|
|
== client.bulk
|
|
|
|
////////
|
|
===========================================================================================================================
|
|
|| ||
|
|
|| ||
|
|
|| ||
|
|
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
|
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
|
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
|
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
|
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
|
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
|
|| ||
|
|
|| ||
|
|
|| 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> ||
|
|
|| ||
|
|
|| ||
|
|
|| ||
|
|
===========================================================================================================================
|
|
////////
|
|
++++
|
|
<style>
|
|
.lang-ts a.xref {
|
|
text-decoration: underline !important;
|
|
}
|
|
</style>
|
|
++++
|
|
|
|
|
|
[discrete]
|
|
[[client.bulk]]
|
|
== `client.bulk()`
|
|
|
|
Bulk index or delete documents. Performs multiple indexing or delete operations in a single API call. This reduces overhead and can greatly increase indexing speed.
|
|
|
|
{ref}/docs-bulk.html[{es} documentation]
|
|
[discrete]
|
|
=== Function signature
|
|
|
|
[source,ts]
|
|
----
|
|
(request: BulkRequest, options?: TransportRequestOptions) => Promise<BulkResponse>
|
|
----
|
|
|
|
[discrete]
|
|
=== Request
|
|
|
|
[source,ts,subs=+macros]
|
|
----
|
|
interface BulkRequest<TDocument = unknown, TPartialDocument = unknown> extends <<RequestBase>> {
|
|
index?: <<IndexName>>
|
|
pipeline?: string
|
|
refresh?: <<Refresh>>
|
|
routing?: <<Routing>>
|
|
_source?: <<SearchSourceConfigParam>>
|
|
_source_excludes?: <<Fields>>
|
|
_source_includes?: <<Fields>>
|
|
timeout?: <<Duration>>
|
|
wait_for_active_shards?: <<WaitForActiveShards>>
|
|
require_alias?: boolean
|
|
operations?: (<<BulkOperationContainer>> | <<BulkUpdateAction>><TDocument, TPartialDocument> | TDocument)[]
|
|
}
|
|
|
|
----
|
|
|
|
|
|
[discrete]
|
|
=== Response
|
|
|
|
[source,ts,subs=+macros]
|
|
----
|
|
interface BulkResponse {
|
|
errors: boolean
|
|
items: Partial<Record<<<BulkOperationType>>, <<BulkResponseItem>>>>[]
|
|
took: <<long>>
|
|
ingest_took?: <<long>>
|
|
}
|
|
|
|
----
|
|
|
|
|