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

84
docs/reference/mget.asciidoc Normal file
View File

@ -0,0 +1,84 @@
[[reference-mget]]
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| 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.mget]]
=== client.mget
Get multiple documents. Get multiple JSON documents by ID from one or more indices. If you specify an index in the request URI, you only need to specify the document IDs in the request body. To ensure fast responses, this multi get (mget) API responds with partial results if one or more shards fail.
{ref}/docs-multi-get.html[{es} documentation]
[discrete]
==== Function signature
[source,ts]
----
(MgetRequest, options?): Promise<MgetResponse>
----
[discrete]
==== Request
[pass]
++++
<pre>
++++
interface MgetRequest extends <<RequestBase>> {
index?: <<IndexName>>
force_synthetic_source?: boolean
preference?: string
realtime?: boolean
refresh?: boolean
routing?: <<Routing>>
_source?: <<SearchSourceConfigParam>>
_source_excludes?: <<Fields>>
_source_includes?: <<Fields>>
stored_fields?: <<Fields>>
docs?: <<MgetOperation>>[]
ids?: <<Ids>>
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
[pass]
++++
<pre>
++++
interface MgetResponse<TDocument = unknown> {
docs: <<MgetResponseItem>><TDocument>[]
}
[pass]
++++
</pre>
++++