@@ -262,6 +262,7 @@ async def close(self):
262
262
async def ping (self , params = None , headers = None ):
263
263
"""
264
264
Returns whether the cluster is running.
265
+
265
266
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/index.html>`_
266
267
"""
267
268
try :
@@ -275,6 +276,7 @@ async def ping(self, params=None, headers=None):
275
276
async def info (self , params = None , headers = None ):
276
277
"""
277
278
Returns basic information about the cluster.
279
+
278
280
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/index.html>`_
279
281
"""
280
282
return await self .transport .perform_request (
@@ -294,6 +296,7 @@ async def create(self, index, id, body, doc_type=None, params=None, headers=None
294
296
"""
295
297
Creates a new document in the index. Returns a 409 response when a document
296
298
with a same ID already exists in the index.
299
+
297
300
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html>`_
298
301
299
302
:arg index: The name of the index
@@ -350,6 +353,7 @@ async def create(self, index, id, body, doc_type=None, params=None, headers=None
350
353
async def index (self , index , body , id = None , params = None , headers = None ):
351
354
"""
352
355
Creates or updates a document in an index.
356
+
353
357
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html>`_
354
358
355
359
:arg index: The name of the index
@@ -409,6 +413,7 @@ async def index(self, index, body, id=None, params=None, headers=None):
409
413
async def bulk (self , body , index = None , doc_type = None , params = None , headers = None ):
410
414
"""
411
415
Allows to perform multiple index/update/delete operations in a single request.
416
+
412
417
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-bulk.html>`_
413
418
414
419
:arg body: The operation definition and data (action-data
@@ -455,6 +460,7 @@ async def bulk(self, body, index=None, doc_type=None, params=None, headers=None)
455
460
async def clear_scroll (self , body = None , scroll_id = None , params = None , headers = None ):
456
461
"""
457
462
Explicitly clears the search context for a scroll.
463
+
458
464
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/clear-scroll-api.html>`_
459
465
460
466
:arg body: A comma-separated list of scroll IDs to clear if none
@@ -491,6 +497,7 @@ async def clear_scroll(self, body=None, scroll_id=None, params=None, headers=Non
491
497
async def count (self , body = None , index = None , params = None , headers = None ):
492
498
"""
493
499
Returns number of documents matching a query.
500
+
494
501
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/search-count.html>`_
495
502
496
503
:arg body: A query to restrict the results specified with the
@@ -546,6 +553,7 @@ async def count(self, body=None, index=None, params=None, headers=None):
546
553
async def delete (self , index , id , doc_type = None , params = None , headers = None ):
547
554
"""
548
555
Removes a document from the index.
556
+
549
557
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete.html>`_
550
558
551
559
:arg index: The name of the index
@@ -620,6 +628,7 @@ async def delete(self, index, id, doc_type=None, params=None, headers=None):
620
628
async def delete_by_query (self , index , body , params = None , headers = None ):
621
629
"""
622
630
Deletes documents matching the provided query.
631
+
623
632
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete-by-query.html>`_
624
633
625
634
:arg index: A comma-separated list of index names to search; use
@@ -713,6 +722,7 @@ async def delete_by_query_rethrottle(self, task_id, params=None, headers=None):
713
722
"""
714
723
Changes the number of requests per second for a particular Delete By Query
715
724
operation.
725
+
716
726
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete-by-query.html>`_
717
727
718
728
:arg task_id: The task id to rethrottle
@@ -733,6 +743,7 @@ async def delete_by_query_rethrottle(self, task_id, params=None, headers=None):
733
743
async def delete_script (self , id , params = None , headers = None ):
734
744
"""
735
745
Deletes a script.
746
+
736
747
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html>`_
737
748
738
749
:arg id: Script ID
@@ -761,6 +772,7 @@ async def delete_script(self, id, params=None, headers=None):
761
772
async def exists (self , index , id , params = None , headers = None ):
762
773
"""
763
774
Returns information about whether a document exists in an index.
775
+
764
776
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html>`_
765
777
766
778
:arg index: The name of the index
@@ -806,6 +818,7 @@ async def exists(self, index, id, params=None, headers=None):
806
818
async def exists_source (self , index , id , doc_type = None , params = None , headers = None ):
807
819
"""
808
820
Returns information about whether a document source exists in an index.
821
+
809
822
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html>`_
810
823
811
824
:arg index: The name of the index
@@ -857,6 +870,7 @@ async def exists_source(self, index, id, doc_type=None, params=None, headers=Non
857
870
async def explain (self , index , id , body = None , params = None , headers = None ):
858
871
"""
859
872
Returns information about why a specific matches (or doesn't match) a query.
873
+
860
874
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/search-explain.html>`_
861
875
862
876
:arg index: The name of the index
@@ -907,6 +921,7 @@ async def field_caps(self, body=None, index=None, params=None, headers=None):
907
921
"""
908
922
Returns the information about the capabilities of fields among multiple
909
923
indices.
924
+
910
925
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/search-field-caps.html>`_
911
926
912
927
:arg body: An index filter specified with the Query DSL
@@ -947,6 +962,7 @@ async def field_caps(self, body=None, index=None, params=None, headers=None):
947
962
async def get (self , index , id , params = None , headers = None ):
948
963
"""
949
964
Returns a document.
965
+
950
966
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html>`_
951
967
952
968
:arg index: The name of the index
@@ -982,6 +998,7 @@ async def get(self, index, id, params=None, headers=None):
982
998
async def get_script (self , id , params = None , headers = None ):
983
999
"""
984
1000
Returns a script.
1001
+
985
1002
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html>`_
986
1003
987
1004
:arg id: Script ID
@@ -1008,6 +1025,7 @@ async def get_script(self, id, params=None, headers=None):
1008
1025
async def get_source (self , index , id , params = None , headers = None ):
1009
1026
"""
1010
1027
Returns the source of a document.
1028
+
1011
1029
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html>`_
1012
1030
1013
1031
:arg index: The name of the index
@@ -1050,6 +1068,7 @@ async def get_source(self, index, id, params=None, headers=None):
1050
1068
async def mget (self , body , index = None , params = None , headers = None ):
1051
1069
"""
1052
1070
Allows to get multiple documents in one request.
1071
+
1053
1072
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-get.html>`_
1054
1073
1055
1074
:arg body: Document identifiers; can be either `docs`
@@ -1095,6 +1114,7 @@ async def mget(self, body, index=None, params=None, headers=None):
1095
1114
async def msearch (self , body , index = None , params = None , headers = None ):
1096
1115
"""
1097
1116
Allows to execute several search operations in one request.
1117
+
1098
1118
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/search-multi-search.html>`_
1099
1119
1100
1120
:arg body: The request definitions (metadata-search request
@@ -1141,6 +1161,7 @@ async def msearch(self, body, index=None, params=None, headers=None):
1141
1161
async def put_script (self , id , body , context = None , params = None , headers = None ):
1142
1162
"""
1143
1163
Creates or updates a script.
1164
+
1144
1165
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html>`_
1145
1166
1146
1167
:arg id: Script ID
@@ -1168,6 +1189,7 @@ async def rank_eval(self, body, index=None, params=None, headers=None):
1168
1189
"""
1169
1190
Allows to evaluate the quality of ranked search results over a set of typical
1170
1191
search queries
1192
+
1171
1193
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/search-rank-eval.html>`_
1172
1194
1173
1195
:arg body: The ranking evaluation search definition, including
@@ -1211,6 +1233,7 @@ async def reindex(self, body, params=None, headers=None):
1211
1233
Allows to copy documents from one index to another, optionally filtering the
1212
1234
source documents by a query, changing the destination index settings, or
1213
1235
fetching the documents from a remote cluster.
1236
+
1214
1237
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-reindex.html>`_
1215
1238
1216
1239
:arg body: The search definition using the Query DSL and the
@@ -1246,6 +1269,7 @@ async def reindex(self, body, params=None, headers=None):
1246
1269
async def reindex_rethrottle (self , task_id , params = None , headers = None ):
1247
1270
"""
1248
1271
Changes the number of requests per second for a particular Reindex operation.
1272
+
1249
1273
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-reindex.html>`_
1250
1274
1251
1275
:arg task_id: The task id to rethrottle
@@ -1268,6 +1292,7 @@ async def render_search_template(
1268
1292
):
1269
1293
"""
1270
1294
Allows to use the Mustache language to pre-render a search definition.
1295
+
1271
1296
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/search-template.html#_validating_templates>`_
1272
1297
1273
1298
:arg body: The search definition template and its params
@@ -1285,6 +1310,7 @@ async def render_search_template(
1285
1310
async def scripts_painless_execute (self , body = None , params = None , headers = None ):
1286
1311
"""
1287
1312
Allows an arbitrary script to be executed and a result to be returned
1313
+
1288
1314
`<https://www.elastic.co/guide/en/elasticsearch/painless/master/painless-execute-api.html>`_
1289
1315
1290
1316
:arg body: The script to execute
@@ -1301,6 +1327,7 @@ async def scripts_painless_execute(self, body=None, params=None, headers=None):
1301
1327
async def scroll (self , body = None , scroll_id = None , params = None , headers = None ):
1302
1328
"""
1303
1329
Allows to retrieve a large numbers of results from a single search request.
1330
+
1304
1331
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/search-request-body.html#request-body-search-scroll>`_
1305
1332
1306
1333
:arg body: The scroll ID if not passed by URL or query
@@ -1369,6 +1396,7 @@ async def scroll(self, body=None, scroll_id=None, params=None, headers=None):
1369
1396
async def search (self , body = None , index = None , params = None , headers = None ):
1370
1397
"""
1371
1398
Returns results matching a query.
1399
+
1372
1400
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/search-search.html>`_
1373
1401
1374
1402
:arg body: The search definition using the Query DSL
@@ -1490,6 +1518,7 @@ async def search_shards(self, index=None, params=None, headers=None):
1490
1518
"""
1491
1519
Returns information about the indices and shards that a search request would be
1492
1520
executed against.
1521
+
1493
1522
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/search-shards.html>`_
1494
1523
1495
1524
:arg index: A comma-separated list of index names to search; use
@@ -1529,6 +1558,7 @@ async def search_shards(self, index=None, params=None, headers=None):
1529
1558
async def update (self , index , id , body , doc_type = None , params = None , headers = None ):
1530
1559
"""
1531
1560
Updates a document with a script or partial document.
1561
+
1532
1562
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update.html>`_
1533
1563
1534
1564
:arg index: The name of the index
@@ -1583,6 +1613,7 @@ async def update_by_query_rethrottle(self, task_id, params=None, headers=None):
1583
1613
"""
1584
1614
Changes the number of requests per second for a particular Update By Query
1585
1615
operation.
1616
+
1586
1617
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update-by-query.html>`_
1587
1618
1588
1619
:arg task_id: The task id to rethrottle
@@ -1603,6 +1634,7 @@ async def update_by_query_rethrottle(self, task_id, params=None, headers=None):
1603
1634
async def get_script_context (self , params = None , headers = None ):
1604
1635
"""
1605
1636
Returns all script contexts.
1637
+
1606
1638
`<https://www.elastic.co/guide/en/elasticsearch/painless/master/painless-contexts.html>`_
1607
1639
"""
1608
1640
return await self .transport .perform_request (
@@ -1613,6 +1645,7 @@ async def get_script_context(self, params=None, headers=None):
1613
1645
async def get_script_languages (self , params = None , headers = None ):
1614
1646
"""
1615
1647
Returns available script types, languages and contexts
1648
+
1616
1649
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html>`_
1617
1650
"""
1618
1651
return await self .transport .perform_request (
@@ -1629,6 +1662,7 @@ async def get_script_languages(self, params=None, headers=None):
1629
1662
async def msearch_template (self , body , index = None , params = None , headers = None ):
1630
1663
"""
1631
1664
Allows to execute several search template operations in one request.
1665
+
1632
1666
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/search-multi-search.html>`_
1633
1667
1634
1668
:arg body: The request definitions (metadata-search request
@@ -1677,6 +1711,7 @@ async def msearch_template(self, body, index=None, params=None, headers=None):
1677
1711
async def mtermvectors (self , body = None , index = None , params = None , headers = None ):
1678
1712
"""
1679
1713
Returns multiple termvectors in one request.
1714
+
1680
1715
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-termvectors.html>`_
1681
1716
1682
1717
:arg body: Define ids, documents, parameters or a list of
@@ -1741,6 +1776,7 @@ async def mtermvectors(self, body=None, index=None, params=None, headers=None):
1741
1776
async def search_template (self , body , index = None , params = None , headers = None ):
1742
1777
"""
1743
1778
Allows to use the Mustache language to pre-render a search definition.
1779
+
1744
1780
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/search-template.html>`_
1745
1781
1746
1782
:arg body: The search definition template and its params
@@ -1803,6 +1839,7 @@ async def termvectors(self, index, body=None, id=None, params=None, headers=None
1803
1839
"""
1804
1840
Returns information and statistics about terms in the fields of a particular
1805
1841
document.
1842
+
1806
1843
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-termvectors.html>`_
1807
1844
1808
1845
:arg index: The index in which the document resides.
@@ -1882,6 +1919,7 @@ async def update_by_query(self, index, body=None, params=None, headers=None):
1882
1919
"""
1883
1920
Performs an update on every document in the index without changing the source,
1884
1921
for example to pick up a mapping change.
1922
+
1885
1923
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update-by-query.html>`_
1886
1924
1887
1925
:arg index: A comma-separated list of index names to search; use
@@ -1977,6 +2015,7 @@ async def update_by_query(self, index, body=None, params=None, headers=None):
1977
2015
async def close_point_in_time (self , body = None , params = None , headers = None ):
1978
2016
"""
1979
2017
Close a point in time
2018
+
1980
2019
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/point-in-time-api.html>`_
1981
2020
1982
2021
:arg body: a point-in-time id to close
@@ -1991,6 +2030,7 @@ async def close_point_in_time(self, body=None, params=None, headers=None):
1991
2030
async def open_point_in_time (self , index = None , params = None , headers = None ):
1992
2031
"""
1993
2032
Open a point in time that can be used in subsequent searches
2033
+
1994
2034
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/point-in-time-api.html>`_
1995
2035
1996
2036
:arg index: A comma-separated list of index names to open point
0 commit comments