You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/reference.asciidoc
+10
Original file line number
Diff line number
Diff line change
@@ -419,6 +419,9 @@ client.get({ id, index })
419
419
* *Request (object):*
420
420
** *`id` (string)*: Unique identifier of the document.
421
421
** *`index` (string)*: Name of the index that contains the document.
422
+
** *`force_synthetic_source` (Optional, boolean)*: Should this request force synthetic _source?
423
+
Use this to test if the mapping supports synthetic _source and to get a sense of the worst case performance.
424
+
Fetches with this enabled will be slower the enabling synthetic source natively in the index.
422
425
** *`preference` (Optional, string)*: Specifies the node or shard the operation should be performed on. Random by default.
423
426
** *`realtime` (Optional, boolean)*: If `true`, the request is real-time as opposed to near-real-time.
424
427
** *`refresh` (Optional, boolean)*: If true, Elasticsearch refreshes the affected shards to make this operation visible to search. If false, do nothing with refreshes.
@@ -607,6 +610,9 @@ client.mget({ ... })
607
610
** *`index` (Optional, string)*: Name of the index to retrieve documents from when `ids` are specified, or when a document in the `docs` array does not specify an index.
608
611
** *`docs` (Optional, { _id, _index, routing, _source, stored_fields, version, version_type }[])*: The documents you want to retrieve. Required if no index is specified in the request URI.
609
612
** *`ids` (Optional, string | string[])*: The IDs of the documents you want to retrieve. Allowed when the index is specified in the request URI.
613
+
** *`force_synthetic_source` (Optional, boolean)*: Should this request force synthetic _source?
614
+
Use this to test if the mapping supports synthetic _source and to get a sense of the worst case performance.
615
+
Fetches with this enabled will be slower the enabling synthetic source natively in the index.
610
616
** *`preference` (Optional, string)*: Specifies the node or shard the operation should be performed on. Random by default.
611
617
** *`realtime` (Optional, boolean)*: If `true`, the request is real-time as opposed to near-real-time.
612
618
** *`refresh` (Optional, boolean)*: If `true`, the request refreshes relevant shards before retrieving documents.
@@ -1031,6 +1037,9 @@ You can exclude fields from this subset using the `_source_excludes` query param
1031
1037
If the `_source` parameter is `false`, this parameter is ignored.
1032
1038
** *`q` (Optional, string)*: Query in the Lucene query string syntax using query parameter search.
1033
1039
Query parameter searches do not support the full Elasticsearch Query DSL but are handy for testing.
1040
+
** *`force_synthetic_source` (Optional, boolean)*: Should this request force synthetic _source?
1041
+
Use this to test if the mapping supports synthetic _source and to get a sense of the worst case performance.
1042
+
Fetches with this enabled will be slower the enabling synthetic source natively in the index.
1034
1043
1035
1044
[discrete]
1036
1045
=== search_mvt
@@ -8340,6 +8349,7 @@ To page through more hits, use the `search_after` parameter.
8340
8349
** *`search_after` (Optional, number | number | string | boolean | null | User-defined value[])*: Search after definition
8341
8350
** *`with_limited_by` (Optional, boolean)*: Return the snapshot of the owner user's role descriptors associated with the API key.
8342
8351
An API key's actual permission is the intersection of its assigned role descriptors and the owner user's role descriptors.
8352
+
** *`typed_keys` (Optional, boolean)*: Determines whether aggregation names are prefixed by their respective types in the response.
0 commit comments