habsi/elasticsearch-js
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Restructure reference docs directory

Browse Source
This commit is contained in:
Josh Mock
2024-12-02 16:58:55 -06:00
parent 647dac8069
commit c3e7619621
583 changed files with 1186 additions and 1305 deletions
Download Patch File Download Diff File Expand all files Collapse all files

86
docs/reference/bulk.asciidoc Normal file
View File

@ -0,0 +1,86 @@
[[reference-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> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
[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]
----
(BulkRequest, options?): Promise<BulkResponse>
----
[discrete]
==== Request
[pass]
++++
<pre>
++++
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)[]
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
[pass]
++++
<pre>
++++
interface BulkResponse {
errors: boolean
items: Partial<Record<<<BulkOperationType>>, <<BulkResponseItem>>>>[]
took: <<long>>
ingest_took?: <<long>>
}
[pass]
++++
</pre>
++++