elasticsearch 8.18.1__py3-none-any.whl → 8.19.1__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- elasticsearch/_async/client/__init__.py +68 -82
- elasticsearch/_async/client/async_search.py +5 -9
- elasticsearch/_async/client/autoscaling.py +4 -4
- elasticsearch/_async/client/cat.py +744 -75
- elasticsearch/_async/client/ccr.py +13 -13
- elasticsearch/_async/client/cluster.py +38 -24
- elasticsearch/_async/client/connector.py +30 -30
- elasticsearch/_async/client/dangling_indices.py +3 -3
- elasticsearch/_async/client/enrich.py +5 -5
- elasticsearch/_async/client/eql.py +13 -5
- elasticsearch/_async/client/esql.py +54 -15
- elasticsearch/_async/client/features.py +2 -2
- elasticsearch/_async/client/fleet.py +13 -13
- elasticsearch/_async/client/graph.py +1 -1
- elasticsearch/_async/client/ilm.py +11 -11
- elasticsearch/_async/client/indices.py +132 -83
- elasticsearch/_async/client/inference.py +519 -112
- elasticsearch/_async/client/ingest.py +9 -16
- elasticsearch/_async/client/license.py +10 -10
- elasticsearch/_async/client/logstash.py +3 -3
- elasticsearch/_async/client/migration.py +3 -3
- elasticsearch/_async/client/ml.py +76 -88
- elasticsearch/_async/client/nodes.py +9 -8
- elasticsearch/_async/client/query_rules.py +8 -8
- elasticsearch/_async/client/rollup.py +8 -8
- elasticsearch/_async/client/search_application.py +10 -10
- elasticsearch/_async/client/searchable_snapshots.py +4 -4
- elasticsearch/_async/client/security.py +72 -80
- elasticsearch/_async/client/shutdown.py +3 -3
- elasticsearch/_async/client/simulate.py +1 -1
- elasticsearch/_async/client/slm.py +9 -9
- elasticsearch/_async/client/snapshot.py +286 -130
- elasticsearch/_async/client/sql.py +7 -7
- elasticsearch/_async/client/ssl.py +1 -1
- elasticsearch/_async/client/synonyms.py +7 -7
- elasticsearch/_async/client/tasks.py +3 -3
- elasticsearch/_async/client/text_structure.py +4 -4
- elasticsearch/_async/client/transform.py +69 -9
- elasticsearch/_async/client/xpack.py +1 -1
- elasticsearch/_sync/client/__init__.py +68 -82
- elasticsearch/_sync/client/async_search.py +5 -9
- elasticsearch/_sync/client/autoscaling.py +4 -4
- elasticsearch/_sync/client/cat.py +744 -75
- elasticsearch/_sync/client/ccr.py +13 -13
- elasticsearch/_sync/client/cluster.py +38 -24
- elasticsearch/_sync/client/connector.py +30 -30
- elasticsearch/_sync/client/dangling_indices.py +3 -3
- elasticsearch/_sync/client/enrich.py +5 -5
- elasticsearch/_sync/client/eql.py +13 -5
- elasticsearch/_sync/client/esql.py +54 -15
- elasticsearch/_sync/client/features.py +2 -2
- elasticsearch/_sync/client/fleet.py +13 -13
- elasticsearch/_sync/client/graph.py +1 -1
- elasticsearch/_sync/client/ilm.py +11 -11
- elasticsearch/_sync/client/indices.py +132 -83
- elasticsearch/_sync/client/inference.py +519 -112
- elasticsearch/_sync/client/ingest.py +9 -16
- elasticsearch/_sync/client/license.py +10 -10
- elasticsearch/_sync/client/logstash.py +3 -3
- elasticsearch/_sync/client/migration.py +3 -3
- elasticsearch/_sync/client/ml.py +76 -88
- elasticsearch/_sync/client/nodes.py +9 -8
- elasticsearch/_sync/client/query_rules.py +8 -8
- elasticsearch/_sync/client/rollup.py +8 -8
- elasticsearch/_sync/client/search_application.py +10 -10
- elasticsearch/_sync/client/searchable_snapshots.py +4 -4
- elasticsearch/_sync/client/security.py +72 -80
- elasticsearch/_sync/client/shutdown.py +3 -3
- elasticsearch/_sync/client/simulate.py +1 -1
- elasticsearch/_sync/client/slm.py +9 -9
- elasticsearch/_sync/client/snapshot.py +286 -130
- elasticsearch/_sync/client/sql.py +7 -7
- elasticsearch/_sync/client/ssl.py +1 -1
- elasticsearch/_sync/client/synonyms.py +7 -7
- elasticsearch/_sync/client/tasks.py +3 -3
- elasticsearch/_sync/client/text_structure.py +4 -4
- elasticsearch/_sync/client/transform.py +69 -9
- elasticsearch/_sync/client/xpack.py +1 -1
- elasticsearch/_version.py +1 -1
- elasticsearch/compat.py +5 -0
- elasticsearch/dsl/__init__.py +2 -1
- elasticsearch/dsl/_async/document.py +85 -1
- elasticsearch/dsl/_sync/document.py +85 -1
- elasticsearch/dsl/aggs.py +22 -3
- elasticsearch/dsl/document_base.py +219 -16
- elasticsearch/dsl/field.py +272 -48
- elasticsearch/dsl/query.py +49 -4
- elasticsearch/dsl/response/aggs.py +1 -1
- elasticsearch/dsl/types.py +247 -27
- elasticsearch/dsl/utils.py +2 -2
- elasticsearch/esql/__init__.py +19 -0
- elasticsearch/esql/esql.py +1156 -0
- elasticsearch/esql/functions.py +1750 -0
- elasticsearch/exceptions.py +2 -0
- {elasticsearch-8.18.1.dist-info → elasticsearch-8.19.1.dist-info}/METADATA +1 -5
- elasticsearch-8.19.1.dist-info/RECORD +164 -0
- elasticsearch-8.18.1.dist-info/RECORD +0 -163
- elasticsearch-8.18.1.dist-info/licenses/LICENSE.txt +0 -175
- elasticsearch-8.18.1.dist-info/licenses/NOTICE.txt +0 -559
- {elasticsearch-8.18.1.dist-info → elasticsearch-8.19.1.dist-info}/WHEEL +0 -0
- {elasticsearch-8.18.1.dist-info → elasticsearch-8.19.1.dist-info}/licenses/LICENSE +0 -0
- {elasticsearch-8.18.1.dist-info → elasticsearch-8.19.1.dist-info}/licenses/NOTICE +0 -0
|
@@ -700,6 +700,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
700
700
|
<li>JavaScript: Check out <code>client.helpers.*</code></li>
|
|
701
701
|
<li>.NET: Check out <code>BulkAllObservable</code></li>
|
|
702
702
|
<li>PHP: Check out bulk indexing.</li>
|
|
703
|
+
<li>Ruby: Check out <code>Elasticsearch::Helpers::BulkHelper</code></li>
|
|
703
704
|
</ul>
|
|
704
705
|
<p><strong>Submitting bulk requests with cURL</strong></p>
|
|
705
706
|
<p>If you're providing text file input to <code>curl</code>, you must use the <code>--data-binary</code> flag instead of plain <code>-d</code>.
|
|
@@ -731,7 +732,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
731
732
|
The other two shards that make up the index do not participate in the <code>_bulk</code> request at all.</p>
|
|
732
733
|
|
|
733
734
|
|
|
734
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
735
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/docs-bulk.html>`_
|
|
735
736
|
|
|
736
737
|
:param operations:
|
|
737
738
|
:param index: The name of the data stream, index, or index alias to perform bulk
|
|
@@ -856,7 +857,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
856
857
|
Clear the search context and results for a scrolling search.</p>
|
|
857
858
|
|
|
858
859
|
|
|
859
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
860
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/clear-scroll-api.html>`_
|
|
860
861
|
|
|
861
862
|
:param scroll_id: The scroll IDs to clear. To clear all scroll IDs, use `_all`.
|
|
862
863
|
"""
|
|
@@ -913,7 +914,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
913
914
|
However, keeping points in time has a cost; close them as soon as they are no longer required for search requests.</p>
|
|
914
915
|
|
|
915
916
|
|
|
916
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
917
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/point-in-time-api.html>`_
|
|
917
918
|
|
|
918
919
|
:param id: The ID of the point-in-time.
|
|
919
920
|
"""
|
|
@@ -997,7 +998,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
997
998
|
This means that replicas increase the scalability of the count.</p>
|
|
998
999
|
|
|
999
1000
|
|
|
1000
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1001
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/search-count.html>`_
|
|
1001
1002
|
|
|
1002
1003
|
:param index: A comma-separated list of data streams, indices, and aliases to
|
|
1003
1004
|
search. It supports wildcards (`*`). To search all data streams and indices,
|
|
@@ -1121,10 +1122,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
1121
1122
|
error_trace: t.Optional[bool] = None,
|
|
1122
1123
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
1123
1124
|
human: t.Optional[bool] = None,
|
|
1124
|
-
if_primary_term: t.Optional[int] = None,
|
|
1125
|
-
if_seq_no: t.Optional[int] = None,
|
|
1126
1125
|
include_source_on_error: t.Optional[bool] = None,
|
|
1127
|
-
op_type: t.Optional[t.Union[str, t.Literal["create", "index"]]] = None,
|
|
1128
1126
|
pipeline: t.Optional[str] = None,
|
|
1129
1127
|
pretty: t.Optional[bool] = None,
|
|
1130
1128
|
refresh: t.Optional[
|
|
@@ -1199,7 +1197,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
1199
1197
|
The <code>_shards</code> section of the API response reveals the number of shard copies on which replication succeeded and failed.</p>
|
|
1200
1198
|
|
|
1201
1199
|
|
|
1202
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1200
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/docs-index_.html>`_
|
|
1203
1201
|
|
|
1204
1202
|
:param index: The name of the data stream or index to target. If the target doesn't
|
|
1205
1203
|
exist and matches the name or wildcard (`*`) pattern of an index template
|
|
@@ -1209,18 +1207,8 @@ class AsyncElasticsearch(BaseClient):
|
|
|
1209
1207
|
:param id: A unique identifier for the document. To automatically generate a
|
|
1210
1208
|
document ID, use the `POST /<target>/_doc/` request format.
|
|
1211
1209
|
:param document:
|
|
1212
|
-
:param if_primary_term: Only perform the operation if the document has this primary
|
|
1213
|
-
term.
|
|
1214
|
-
:param if_seq_no: Only perform the operation if the document has this sequence
|
|
1215
|
-
number.
|
|
1216
1210
|
:param include_source_on_error: True or false if to include the document source
|
|
1217
1211
|
in the error message in case of parsing errors.
|
|
1218
|
-
:param op_type: Set to `create` to only index the document if it does not already
|
|
1219
|
-
exist (put if absent). If a document with the specified `_id` already exists,
|
|
1220
|
-
the indexing operation will fail. The behavior is the same as using the `<index>/_create`
|
|
1221
|
-
endpoint. If a document ID is specified, this paramater defaults to `index`.
|
|
1222
|
-
Otherwise, it defaults to `create`. If the request targets a data stream,
|
|
1223
|
-
an `op_type` of `create` is required.
|
|
1224
1212
|
:param pipeline: The ID of the pipeline to use to preprocess incoming documents.
|
|
1225
1213
|
If the index has a default ingest pipeline specified, setting the value to
|
|
1226
1214
|
`_none` turns off the default ingest pipeline for this request. If a final
|
|
@@ -1272,14 +1260,8 @@ class AsyncElasticsearch(BaseClient):
|
|
|
1272
1260
|
__query["filter_path"] = filter_path
|
|
1273
1261
|
if human is not None:
|
|
1274
1262
|
__query["human"] = human
|
|
1275
|
-
if if_primary_term is not None:
|
|
1276
|
-
__query["if_primary_term"] = if_primary_term
|
|
1277
|
-
if if_seq_no is not None:
|
|
1278
|
-
__query["if_seq_no"] = if_seq_no
|
|
1279
1263
|
if include_source_on_error is not None:
|
|
1280
1264
|
__query["include_source_on_error"] = include_source_on_error
|
|
1281
|
-
if op_type is not None:
|
|
1282
|
-
__query["op_type"] = op_type
|
|
1283
1265
|
if pipeline is not None:
|
|
1284
1266
|
__query["pipeline"] = pipeline
|
|
1285
1267
|
if pretty is not None:
|
|
@@ -1366,7 +1348,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
1366
1348
|
It then gets redirected into the primary shard within that ID group and replicated (if needed) to shard replicas within that ID group.</p>
|
|
1367
1349
|
|
|
1368
1350
|
|
|
1369
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1351
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/docs-delete.html>`_
|
|
1370
1352
|
|
|
1371
1353
|
:param index: The name of the target index.
|
|
1372
1354
|
:param id: A unique identifier for the document.
|
|
@@ -1435,7 +1417,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
1435
1417
|
)
|
|
1436
1418
|
|
|
1437
1419
|
@_rewrite_parameters(
|
|
1438
|
-
body_fields=("max_docs", "query", "slice"),
|
|
1420
|
+
body_fields=("max_docs", "query", "slice", "sort"),
|
|
1439
1421
|
parameter_aliases={"from": "from_"},
|
|
1440
1422
|
)
|
|
1441
1423
|
async def delete_by_query(
|
|
@@ -1479,7 +1461,12 @@ class AsyncElasticsearch(BaseClient):
|
|
|
1479
1461
|
] = None,
|
|
1480
1462
|
slice: t.Optional[t.Mapping[str, t.Any]] = None,
|
|
1481
1463
|
slices: t.Optional[t.Union[int, t.Union[str, t.Literal["auto"]]]] = None,
|
|
1482
|
-
sort: t.Optional[
|
|
1464
|
+
sort: t.Optional[
|
|
1465
|
+
t.Union[
|
|
1466
|
+
t.Sequence[t.Union[str, t.Mapping[str, t.Any]]],
|
|
1467
|
+
t.Union[str, t.Mapping[str, t.Any]],
|
|
1468
|
+
]
|
|
1469
|
+
] = None,
|
|
1483
1470
|
stats: t.Optional[t.Sequence[str]] = None,
|
|
1484
1471
|
terminate_after: t.Optional[int] = None,
|
|
1485
1472
|
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
@@ -1555,7 +1542,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
1555
1542
|
The get task status API will continue to list the delete by query task until this task checks that it has been cancelled and terminates itself.</p>
|
|
1556
1543
|
|
|
1557
1544
|
|
|
1558
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1545
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/docs-delete-by-query.html>`_
|
|
1559
1546
|
|
|
1560
1547
|
:param index: A comma-separated list of data streams, indices, and aliases to
|
|
1561
1548
|
search. It supports wildcards (`*`). To search all data streams or indices,
|
|
@@ -1611,7 +1598,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
1611
1598
|
:param slice: Slice the request manually using the provided slice ID and total
|
|
1612
1599
|
number of slices.
|
|
1613
1600
|
:param slices: The number of slices this task should be divided into.
|
|
1614
|
-
:param sort: A
|
|
1601
|
+
:param sort: A sort object that specifies the order of deleted documents.
|
|
1615
1602
|
:param stats: The specific `tag` of the request for logging and statistical purposes.
|
|
1616
1603
|
:param terminate_after: The maximum number of documents to collect for each shard.
|
|
1617
1604
|
If a query reaches this limit, Elasticsearch terminates the query early.
|
|
@@ -1701,8 +1688,6 @@ class AsyncElasticsearch(BaseClient):
|
|
|
1701
1688
|
__query["search_type"] = search_type
|
|
1702
1689
|
if slices is not None:
|
|
1703
1690
|
__query["slices"] = slices
|
|
1704
|
-
if sort is not None:
|
|
1705
|
-
__query["sort"] = sort
|
|
1706
1691
|
if stats is not None:
|
|
1707
1692
|
__query["stats"] = stats
|
|
1708
1693
|
if terminate_after is not None:
|
|
@@ -1722,6 +1707,8 @@ class AsyncElasticsearch(BaseClient):
|
|
|
1722
1707
|
__body["query"] = query
|
|
1723
1708
|
if slice is not None:
|
|
1724
1709
|
__body["slice"] = slice
|
|
1710
|
+
if sort is not None:
|
|
1711
|
+
__body["sort"] = sort
|
|
1725
1712
|
__headers = {"accept": "application/json", "content-type": "application/json"}
|
|
1726
1713
|
return await self.perform_request( # type: ignore[return-value]
|
|
1727
1714
|
"POST",
|
|
@@ -1752,7 +1739,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
1752
1739
|
Rethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts.</p>
|
|
1753
1740
|
|
|
1754
1741
|
|
|
1755
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1742
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/docs-delete-by-query.html#docs-delete-by-query-rethrottle>`_
|
|
1756
1743
|
|
|
1757
1744
|
:param task_id: The ID for the task.
|
|
1758
1745
|
:param requests_per_second: The throttle for this request in sub-requests per
|
|
@@ -1802,7 +1789,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
1802
1789
|
Deletes a stored script or search template.</p>
|
|
1803
1790
|
|
|
1804
1791
|
|
|
1805
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1792
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/delete-stored-script-api.html>`_
|
|
1806
1793
|
|
|
1807
1794
|
:param id: The identifier for the stored script or search template.
|
|
1808
1795
|
:param master_timeout: The period to wait for a connection to the master node.
|
|
@@ -1886,7 +1873,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
1886
1873
|
Elasticsearch cleans up deleted documents in the background as you continue to index more data.</p>
|
|
1887
1874
|
|
|
1888
1875
|
|
|
1889
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1876
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/docs-get.html>`_
|
|
1890
1877
|
|
|
1891
1878
|
:param index: A comma-separated list of data streams, indices, and aliases. It
|
|
1892
1879
|
supports wildcards (`*`).
|
|
@@ -2009,7 +1996,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
2009
1996
|
<p>A document's source is not available if it is disabled in the mapping.</p>
|
|
2010
1997
|
|
|
2011
1998
|
|
|
2012
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1999
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/docs-get.html>`_
|
|
2013
2000
|
|
|
2014
2001
|
:param index: A comma-separated list of data streams, indices, and aliases. It
|
|
2015
2002
|
supports wildcards (`*`).
|
|
@@ -2115,7 +2102,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
2115
2102
|
It computes a score explanation for a query and a specific document.</p>
|
|
2116
2103
|
|
|
2117
2104
|
|
|
2118
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2105
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/search-explain.html>`_
|
|
2119
2106
|
|
|
2120
2107
|
:param index: Index names that are used to limit the request. Only a single index
|
|
2121
2108
|
name can be provided to this parameter.
|
|
@@ -2250,7 +2237,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
2250
2237
|
For example, a runtime field with a type of keyword is returned the same as any other field that belongs to the <code>keyword</code> family.</p>
|
|
2251
2238
|
|
|
2252
2239
|
|
|
2253
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2240
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/search-field-caps.html>`_
|
|
2254
2241
|
|
|
2255
2242
|
:param index: A comma-separated list of data streams, indices, and aliases used
|
|
2256
2243
|
to limit the request. Supports wildcards (*). To target all data streams
|
|
@@ -2411,7 +2398,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
2411
2398
|
Elasticsearch cleans up deleted documents in the background as you continue to index more data.</p>
|
|
2412
2399
|
|
|
2413
2400
|
|
|
2414
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2401
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/docs-get.html>`_
|
|
2415
2402
|
|
|
2416
2403
|
:param index: The name of the index that contains the document.
|
|
2417
2404
|
:param id: A unique document identifier.
|
|
@@ -2518,7 +2505,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
2518
2505
|
Retrieves a stored script or search template.</p>
|
|
2519
2506
|
|
|
2520
2507
|
|
|
2521
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2508
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/get-stored-script-api.html>`_
|
|
2522
2509
|
|
|
2523
2510
|
:param id: The identifier for the stored script or search template.
|
|
2524
2511
|
:param master_timeout: The period to wait for the master node. If the master
|
|
@@ -2567,7 +2554,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
2567
2554
|
<p>Get a list of supported script contexts and their methods.</p>
|
|
2568
2555
|
|
|
2569
2556
|
|
|
2570
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2557
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/get-script-contexts-api.html>`_
|
|
2571
2558
|
"""
|
|
2572
2559
|
__path_parts: t.Dict[str, str] = {}
|
|
2573
2560
|
__path = "/_script_context"
|
|
@@ -2606,7 +2593,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
2606
2593
|
<p>Get a list of available script types, languages, and contexts.</p>
|
|
2607
2594
|
|
|
2608
2595
|
|
|
2609
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2596
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/get-script-languages-api.html>`_
|
|
2610
2597
|
"""
|
|
2611
2598
|
__path_parts: t.Dict[str, str] = {}
|
|
2612
2599
|
__path = "/_script_language"
|
|
@@ -2652,7 +2639,6 @@ class AsyncElasticsearch(BaseClient):
|
|
|
2652
2639
|
source: t.Optional[t.Union[bool, t.Union[str, t.Sequence[str]]]] = None,
|
|
2653
2640
|
source_excludes: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
2654
2641
|
source_includes: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
2655
|
-
stored_fields: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
2656
2642
|
version: t.Optional[int] = None,
|
|
2657
2643
|
version_type: t.Optional[
|
|
2658
2644
|
t.Union[str, t.Literal["external", "external_gte", "force", "internal"]]
|
|
@@ -2671,7 +2657,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
2671
2657
|
</code></pre>
|
|
2672
2658
|
|
|
2673
2659
|
|
|
2674
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2660
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/docs-get.html>`_
|
|
2675
2661
|
|
|
2676
2662
|
:param index: The name of the index that contains the document.
|
|
2677
2663
|
:param id: A unique document identifier.
|
|
@@ -2689,8 +2675,6 @@ class AsyncElasticsearch(BaseClient):
|
|
|
2689
2675
|
the response.
|
|
2690
2676
|
:param source_includes: A comma-separated list of source fields to include in
|
|
2691
2677
|
the response.
|
|
2692
|
-
:param stored_fields: A comma-separated list of stored fields to return as part
|
|
2693
|
-
of a hit.
|
|
2694
2678
|
:param version: The version number for concurrency control. It must match the
|
|
2695
2679
|
current version of the document for the request to succeed.
|
|
2696
2680
|
:param version_type: The version type.
|
|
@@ -2724,8 +2708,6 @@ class AsyncElasticsearch(BaseClient):
|
|
|
2724
2708
|
__query["_source_excludes"] = source_excludes
|
|
2725
2709
|
if source_includes is not None:
|
|
2726
2710
|
__query["_source_includes"] = source_includes
|
|
2727
|
-
if stored_fields is not None:
|
|
2728
|
-
__query["stored_fields"] = stored_fields
|
|
2729
2711
|
if version is not None:
|
|
2730
2712
|
__query["version"] = version
|
|
2731
2713
|
if version_type is not None:
|
|
@@ -2771,7 +2753,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
2771
2753
|
When setting up automated polling of the API for health status, set verbose to false to disable the more expensive analysis logic.</p>
|
|
2772
2754
|
|
|
2773
2755
|
|
|
2774
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2756
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/health-api.html>`_
|
|
2775
2757
|
|
|
2776
2758
|
:param feature: A feature of the cluster, as returned by the top-level health
|
|
2777
2759
|
report API.
|
|
@@ -2834,6 +2816,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
2834
2816
|
t.Union[bool, str, t.Literal["false", "true", "wait_for"]]
|
|
2835
2817
|
] = None,
|
|
2836
2818
|
require_alias: t.Optional[bool] = None,
|
|
2819
|
+
require_data_stream: t.Optional[bool] = None,
|
|
2837
2820
|
routing: t.Optional[str] = None,
|
|
2838
2821
|
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
2839
2822
|
version: t.Optional[int] = None,
|
|
@@ -2936,7 +2919,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
2936
2919
|
</code></pre>
|
|
2937
2920
|
|
|
2938
2921
|
|
|
2939
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2922
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/docs-index_.html>`_
|
|
2940
2923
|
|
|
2941
2924
|
:param index: The name of the data stream or index to target. If the target doesn't
|
|
2942
2925
|
exist and matches the name or wildcard (`*`) pattern of an index template
|
|
@@ -2969,6 +2952,8 @@ class AsyncElasticsearch(BaseClient):
|
|
|
2969
2952
|
this operation visible to search. If `wait_for`, it waits for a refresh to
|
|
2970
2953
|
make this operation visible to search. If `false`, it does nothing with refreshes.
|
|
2971
2954
|
:param require_alias: If `true`, the destination must be an index alias.
|
|
2955
|
+
:param require_data_stream: If `true`, the request's actions must target a data
|
|
2956
|
+
stream (existing or to be created).
|
|
2972
2957
|
:param routing: A custom value that is used to route operations to a specific
|
|
2973
2958
|
shard.
|
|
2974
2959
|
:param timeout: The period the request waits for the following operations: automatic
|
|
@@ -3030,6 +3015,8 @@ class AsyncElasticsearch(BaseClient):
|
|
|
3030
3015
|
__query["refresh"] = refresh
|
|
3031
3016
|
if require_alias is not None:
|
|
3032
3017
|
__query["require_alias"] = require_alias
|
|
3018
|
+
if require_data_stream is not None:
|
|
3019
|
+
__query["require_data_stream"] = require_data_stream
|
|
3033
3020
|
if routing is not None:
|
|
3034
3021
|
__query["routing"] = routing
|
|
3035
3022
|
if timeout is not None:
|
|
@@ -3065,10 +3052,11 @@ class AsyncElasticsearch(BaseClient):
|
|
|
3065
3052
|
.. raw:: html
|
|
3066
3053
|
|
|
3067
3054
|
<p>Get cluster info.
|
|
3068
|
-
Get basic build, version, and cluster information
|
|
3055
|
+
Get basic build, version, and cluster information.
|
|
3056
|
+
::: In Serverless, this API is retained for backward compatibility only. Some response fields, such as the version number, should be ignored.</p>
|
|
3069
3057
|
|
|
3070
3058
|
|
|
3071
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3059
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/rest-api-root.html>`_
|
|
3072
3060
|
"""
|
|
3073
3061
|
__path_parts: t.Dict[str, str] = {}
|
|
3074
3062
|
__path = "/"
|
|
@@ -3142,7 +3130,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
3142
3130
|
</ul>
|
|
3143
3131
|
|
|
3144
3132
|
|
|
3145
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3133
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/knn-search-api.html>`_
|
|
3146
3134
|
|
|
3147
3135
|
:param index: A comma-separated list of index names to search; use `_all` or
|
|
3148
3136
|
to perform the operation on all indices.
|
|
@@ -3258,7 +3246,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
3258
3246
|
You can include the <code>stored_fields</code> query parameter in the request URI to specify the defaults to use when there are no per-document instructions.</p>
|
|
3259
3247
|
|
|
3260
3248
|
|
|
3261
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3249
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/docs-multi-get.html>`_
|
|
3262
3250
|
|
|
3263
3251
|
:param index: Name of the index to retrieve documents from when `ids` are specified,
|
|
3264
3252
|
or when a document in the `docs` array does not specify an index.
|
|
@@ -3393,7 +3381,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
3393
3381
|
When sending requests to this endpoint the <code>Content-Type</code> header should be set to <code>application/x-ndjson</code>.</p>
|
|
3394
3382
|
|
|
3395
3383
|
|
|
3396
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3384
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/search-multi-search.html>`_
|
|
3397
3385
|
|
|
3398
3386
|
:param searches:
|
|
3399
3387
|
:param index: Comma-separated list of data streams, indices, and index aliases
|
|
@@ -3539,7 +3527,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
3539
3527
|
</code></pre>
|
|
3540
3528
|
|
|
3541
3529
|
|
|
3542
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3530
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/multi-search-template.html>`_
|
|
3543
3531
|
|
|
3544
3532
|
:param search_templates:
|
|
3545
3533
|
:param index: A comma-separated list of data streams, indices, and aliases to
|
|
@@ -3644,7 +3632,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
3644
3632
|
The mapping used is determined by the specified <code>_index</code>.</p>
|
|
3645
3633
|
|
|
3646
3634
|
|
|
3647
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3635
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/docs-multi-termvectors.html>`_
|
|
3648
3636
|
|
|
3649
3637
|
:param index: The name of the index that contains the documents.
|
|
3650
3638
|
:param docs: An array of existing or artificial documents.
|
|
@@ -3785,7 +3773,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
3785
3773
|
You can check how many point-in-times (that is, search contexts) are open with the nodes stats API.</p>
|
|
3786
3774
|
|
|
3787
3775
|
|
|
3788
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3776
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/point-in-time-api.html>`_
|
|
3789
3777
|
|
|
3790
3778
|
:param index: A comma-separated list of index names to open point in time; use
|
|
3791
3779
|
`_all` or empty string to perform the operation on all indices
|
|
@@ -3798,8 +3786,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
3798
3786
|
:param expand_wildcards: The type of index that wildcard patterns can match.
|
|
3799
3787
|
If the request can target data streams, this argument determines whether
|
|
3800
3788
|
wildcard expressions match hidden data streams. It supports comma-separated
|
|
3801
|
-
values, such as `open,hidden`.
|
|
3802
|
-
`hidden`, `none`.
|
|
3789
|
+
values, such as `open,hidden`.
|
|
3803
3790
|
:param ignore_unavailable: If `false`, the request returns an error if it targets
|
|
3804
3791
|
a missing or closed index.
|
|
3805
3792
|
:param index_filter: Filter indices if the provided query rewrites to `match_none`
|
|
@@ -3883,7 +3870,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
3883
3870
|
Creates or updates a stored script or search template.</p>
|
|
3884
3871
|
|
|
3885
3872
|
|
|
3886
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3873
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/create-stored-script-api.html>`_
|
|
3887
3874
|
|
|
3888
3875
|
:param id: The identifier for the stored script or search template. It must be
|
|
3889
3876
|
unique within the cluster.
|
|
@@ -3973,7 +3960,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
3973
3960
|
<p>Evaluate the quality of ranked search results over a set of typical search queries.</p>
|
|
3974
3961
|
|
|
3975
3962
|
|
|
3976
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3963
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/search-rank-eval.html>`_
|
|
3977
3964
|
|
|
3978
3965
|
:param requests: A set of typical search requests, together with their provided
|
|
3979
3966
|
ratings.
|
|
@@ -4205,7 +4192,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
4205
4192
|
It is not possible to configure SSL in the body of the reindex request.</p>
|
|
4206
4193
|
|
|
4207
4194
|
|
|
4208
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4195
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/docs-reindex.html>`_
|
|
4209
4196
|
|
|
4210
4197
|
:param dest: The destination you are copying to.
|
|
4211
4198
|
:param source: The source you are copying from.
|
|
@@ -4329,7 +4316,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
4329
4316
|
This behavior prevents scroll timeouts.</p>
|
|
4330
4317
|
|
|
4331
4318
|
|
|
4332
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4319
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/docs-reindex.html>`_
|
|
4333
4320
|
|
|
4334
4321
|
:param task_id: The task identifier, which can be found by using the tasks API.
|
|
4335
4322
|
:param requests_per_second: The throttle for this request in sub-requests per
|
|
@@ -4385,7 +4372,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
4385
4372
|
<p>Render a search template as a search request body.</p>
|
|
4386
4373
|
|
|
4387
4374
|
|
|
4388
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4375
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/render-search-template-api.html>`_
|
|
4389
4376
|
|
|
4390
4377
|
:param id: The ID of the search template to render. If no `source` is specified,
|
|
4391
4378
|
this or the `id` request body parameter is required.
|
|
@@ -4479,7 +4466,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
4479
4466
|
<p>Each context requires a script, but additional parameters depend on the context you're using for that script.</p>
|
|
4480
4467
|
|
|
4481
4468
|
|
|
4482
|
-
`<https://www.elastic.co/guide/en/elasticsearch/painless/8.
|
|
4469
|
+
`<https://www.elastic.co/guide/en/elasticsearch/painless/8.19/painless-execute-api.html>`_
|
|
4483
4470
|
|
|
4484
4471
|
:param context: The context that the script should run in. NOTE: Result ordering
|
|
4485
4472
|
in the field contexts is not guaranteed.
|
|
@@ -4552,7 +4539,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
4552
4539
|
<p>IMPORTANT: Results from a scrolling search reflect the state of the index at the time of the initial search request. Subsequent indexing or document changes only affect later search and scroll requests.</p>
|
|
4553
4540
|
|
|
4554
4541
|
|
|
4555
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4542
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/scroll-api.html>`_
|
|
4556
4543
|
|
|
4557
4544
|
:param scroll_id: The scroll ID of the search.
|
|
4558
4545
|
:param rest_total_hits_as_int: If true, the API response’s hit.total property
|
|
@@ -4758,7 +4745,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
4758
4745
|
This situation can occur because the splitting criterion is based on Lucene document IDs, which are not stable across changes to the index.</p>
|
|
4759
4746
|
|
|
4760
4747
|
|
|
4761
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4748
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/search-search.html>`_
|
|
4762
4749
|
|
|
4763
4750
|
:param index: A comma-separated list of data streams, indices, and aliases to
|
|
4764
4751
|
search. It supports wildcards (`*`). To search all data streams and indices,
|
|
@@ -4839,7 +4826,8 @@ class AsyncElasticsearch(BaseClient):
|
|
|
4839
4826
|
:param min_compatible_shard_node: The minimum version of the node that can handle
|
|
4840
4827
|
the request Any handling node with a lower version will fail the request.
|
|
4841
4828
|
:param min_score: The minimum `_score` for matching documents. Documents with
|
|
4842
|
-
a lower `_score` are not included in
|
|
4829
|
+
a lower `_score` are not included in search results and results collected
|
|
4830
|
+
by aggregations.
|
|
4843
4831
|
:param pit: Limit the search to a point in time (PIT). If you provide a PIT,
|
|
4844
4832
|
you cannot specify an `<index>` in the request path.
|
|
4845
4833
|
:param post_filter: Use the `post_filter` parameter to filter search results.
|
|
@@ -5508,7 +5496,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
5508
5496
|
Elasticsearch uses the H3 resolution that is closest to the corresponding geotile density.</p>
|
|
5509
5497
|
|
|
5510
5498
|
|
|
5511
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
5499
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/search-vector-tile-api.html>`_
|
|
5512
5500
|
|
|
5513
5501
|
:param index: Comma-separated list of data streams, indices, or aliases to search
|
|
5514
5502
|
:param field: Field containing geospatial data to return
|
|
@@ -5682,7 +5670,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
5682
5670
|
<p>If the Elasticsearch security features are enabled, you must have the <code>view_index_metadata</code> or <code>manage</code> index privilege for the target data stream, index, or alias.</p>
|
|
5683
5671
|
|
|
5684
5672
|
|
|
5685
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
5673
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/search-shards.html>`_
|
|
5686
5674
|
|
|
5687
5675
|
:param index: A comma-separated list of data streams, indices, and aliases to
|
|
5688
5676
|
search. It supports wildcards (`*`). To search all data streams and indices,
|
|
@@ -5695,7 +5683,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
5695
5683
|
:param expand_wildcards: Type of index that wildcard patterns can match. If the
|
|
5696
5684
|
request can target data streams, this argument determines whether wildcard
|
|
5697
5685
|
expressions match hidden data streams. Supports comma-separated values, such
|
|
5698
|
-
as `open,hidden`.
|
|
5686
|
+
as `open,hidden`.
|
|
5699
5687
|
:param ignore_unavailable: If `false`, the request returns an error if it targets
|
|
5700
5688
|
a missing or closed index.
|
|
5701
5689
|
:param local: If `true`, the request retrieves information from the local node
|
|
@@ -5793,7 +5781,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
5793
5781
|
<p>Run a search with a search template.</p>
|
|
5794
5782
|
|
|
5795
5783
|
|
|
5796
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
5784
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/search-template-api.html>`_
|
|
5797
5785
|
|
|
5798
5786
|
:param index: A comma-separated list of data streams, indices, and aliases to
|
|
5799
5787
|
search. It supports wildcards (`*`).
|
|
@@ -5807,8 +5795,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
5807
5795
|
:param expand_wildcards: The type of index that wildcard patterns can match.
|
|
5808
5796
|
If the request can target data streams, this argument determines whether
|
|
5809
5797
|
wildcard expressions match hidden data streams. Supports comma-separated
|
|
5810
|
-
values, such as `open,hidden`.
|
|
5811
|
-
`hidden`, `none`.
|
|
5798
|
+
values, such as `open,hidden`.
|
|
5812
5799
|
:param explain: If `true`, returns detailed information about score calculation
|
|
5813
5800
|
as part of each hit. If you specify both this and the `explain` query parameter,
|
|
5814
5801
|
the API uses only the query parameter.
|
|
@@ -5936,7 +5923,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
5936
5923
|
</blockquote>
|
|
5937
5924
|
|
|
5938
5925
|
|
|
5939
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
5926
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/search-terms-enum.html>`_
|
|
5940
5927
|
|
|
5941
5928
|
:param index: A comma-separated list of data streams, indices, and index aliases
|
|
5942
5929
|
to search. Wildcard (`*`) expressions are supported. To search all data streams
|
|
@@ -6029,7 +6016,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
6029
6016
|
doc: t.Optional[t.Mapping[str, t.Any]] = None,
|
|
6030
6017
|
error_trace: t.Optional[bool] = None,
|
|
6031
6018
|
field_statistics: t.Optional[bool] = None,
|
|
6032
|
-
fields: t.Optional[t.
|
|
6019
|
+
fields: t.Optional[t.Sequence[str]] = None,
|
|
6033
6020
|
filter: t.Optional[t.Mapping[str, t.Any]] = None,
|
|
6034
6021
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
6035
6022
|
human: t.Optional[bool] = None,
|
|
@@ -6085,7 +6072,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
6085
6072
|
Use <code>routing</code> only to hit a particular shard.</p>
|
|
6086
6073
|
|
|
6087
6074
|
|
|
6088
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
6075
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/docs-termvectors.html>`_
|
|
6089
6076
|
|
|
6090
6077
|
:param index: The name of the index that contains the document.
|
|
6091
6078
|
:param id: A unique identifier for the document.
|
|
@@ -6256,7 +6243,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
6256
6243
|
In addition to <code>_source</code>, you can access the following variables through the <code>ctx</code> map: <code>_index</code>, <code>_type</code>, <code>_id</code>, <code>_version</code>, <code>_routing</code>, and <code>_now</code> (the current timestamp).</p>
|
|
6257
6244
|
|
|
6258
6245
|
|
|
6259
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
6246
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/docs-update.html>`_
|
|
6260
6247
|
|
|
6261
6248
|
:param index: The name of the target index. By default, the index is created
|
|
6262
6249
|
automatically if it doesn't exist.
|
|
@@ -6494,7 +6481,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
6494
6481
|
This API enables you to only modify the source of matching documents; you cannot move them.</p>
|
|
6495
6482
|
|
|
6496
6483
|
|
|
6497
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
6484
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/docs-update-by-query.html>`_
|
|
6498
6485
|
|
|
6499
6486
|
:param index: A comma-separated list of data streams, indices, and aliases to
|
|
6500
6487
|
search. It supports wildcards (`*`). To search all data streams or indices,
|
|
@@ -6519,8 +6506,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
6519
6506
|
:param expand_wildcards: The type of index that wildcard patterns can match.
|
|
6520
6507
|
If the request can target data streams, this argument determines whether
|
|
6521
6508
|
wildcard expressions match hidden data streams. It supports comma-separated
|
|
6522
|
-
values, such as `open,hidden`.
|
|
6523
|
-
`hidden`, `none`.
|
|
6509
|
+
values, such as `open,hidden`.
|
|
6524
6510
|
:param from_: Skips the specified number of documents.
|
|
6525
6511
|
:param ignore_unavailable: If `false`, the request returns an error if it targets
|
|
6526
6512
|
a missing or closed index.
|
|
@@ -6714,7 +6700,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
6714
6700
|
Rethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts.</p>
|
|
6715
6701
|
|
|
6716
6702
|
|
|
6717
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
6703
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/docs-update-by-query.html#docs-update-by-query-rethrottle>`_
|
|
6718
6704
|
|
|
6719
6705
|
:param task_id: The ID for the task.
|
|
6720
6706
|
:param requests_per_second: The throttle for this request in sub-requests per
|
|
@@ -44,7 +44,7 @@ class AsyncSearchClient(NamespacedClient):
|
|
|
44
44
|
If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the <code>cancel_task</code> cluster privilege.</p>
|
|
45
45
|
|
|
46
46
|
|
|
47
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
47
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/async-search.html>`_
|
|
48
48
|
|
|
49
49
|
:param id: A unique identifier for the async search.
|
|
50
50
|
"""
|
|
@@ -94,7 +94,7 @@ class AsyncSearchClient(NamespacedClient):
|
|
|
94
94
|
If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it.</p>
|
|
95
95
|
|
|
96
96
|
|
|
97
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
97
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/async-search.html>`_
|
|
98
98
|
|
|
99
99
|
:param id: A unique identifier for the async search.
|
|
100
100
|
:param keep_alive: The length of time that the async search should be available
|
|
@@ -164,7 +164,7 @@ class AsyncSearchClient(NamespacedClient):
|
|
|
164
164
|
</ul>
|
|
165
165
|
|
|
166
166
|
|
|
167
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
167
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/async-search.html>`_
|
|
168
168
|
|
|
169
169
|
:param id: A unique identifier for the async search.
|
|
170
170
|
:param keep_alive: The length of time that the async search needs to be available.
|
|
@@ -281,7 +281,6 @@ class AsyncSearchClient(NamespacedClient):
|
|
|
281
281
|
] = None,
|
|
282
282
|
lenient: t.Optional[bool] = None,
|
|
283
283
|
max_concurrent_shard_requests: t.Optional[int] = None,
|
|
284
|
-
min_compatible_shard_node: t.Optional[str] = None,
|
|
285
284
|
min_score: t.Optional[float] = None,
|
|
286
285
|
pit: t.Optional[t.Mapping[str, t.Any]] = None,
|
|
287
286
|
post_filter: t.Optional[t.Mapping[str, t.Any]] = None,
|
|
@@ -346,7 +345,7 @@ class AsyncSearchClient(NamespacedClient):
|
|
|
346
345
|
The maximum allowed size for a stored async search response can be set by changing the <code>search.max_async_search_response_size</code> cluster level setting.</p>
|
|
347
346
|
|
|
348
347
|
|
|
349
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
348
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/async-search.html>`_
|
|
350
349
|
|
|
351
350
|
:param index: A comma-separated list of index names to search; use `_all` or
|
|
352
351
|
empty string to perform the operation on all indices
|
|
@@ -401,9 +400,8 @@ class AsyncSearchClient(NamespacedClient):
|
|
|
401
400
|
per node this search executes concurrently. This value should be used to
|
|
402
401
|
limit the impact of the search on the cluster in order to limit the number
|
|
403
402
|
of concurrent shard requests
|
|
404
|
-
:param min_compatible_shard_node:
|
|
405
403
|
:param min_score: Minimum _score for matching documents. Documents with a lower
|
|
406
|
-
_score are not included in
|
|
404
|
+
_score are not included in search results and results collected by aggregations.
|
|
407
405
|
:param pit: Limits the search to a point in time (PIT). If you provide a PIT,
|
|
408
406
|
you cannot specify an <index> in the request path.
|
|
409
407
|
:param post_filter:
|
|
@@ -526,8 +524,6 @@ class AsyncSearchClient(NamespacedClient):
|
|
|
526
524
|
__query["lenient"] = lenient
|
|
527
525
|
if max_concurrent_shard_requests is not None:
|
|
528
526
|
__query["max_concurrent_shard_requests"] = max_concurrent_shard_requests
|
|
529
|
-
if min_compatible_shard_node is not None:
|
|
530
|
-
__query["min_compatible_shard_node"] = min_compatible_shard_node
|
|
531
527
|
if preference is not None:
|
|
532
528
|
__query["preference"] = preference
|
|
533
529
|
if pretty is not None:
|