This repository has been archived by the owner on Nov 7, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 29
/
__init__.py
1327 lines (1214 loc) · 53.3 KB
/
__init__.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import asyncio
import json
from .cat import CatClient
from .cluster import ClusterClient
from .indices import IndicesClient
from .nodes import NodesClient
from .snapshot import SnapshotClient
from aioes.transport import Transport
from .utils import _make_path
from aioes.exception import (NotFoundError, TransportError)
default = object()
class Elasticsearch:
def __init__(self, endpoints, *, loop=None, verify_ssl=True, **kwargs):
self._transport = Transport(endpoints,
loop=loop,
verify_ssl=verify_ssl,
**kwargs)
self._cat = CatClient(self)
self._cluster = ClusterClient(self)
self._indices = IndicesClient(self)
self._nodes = NodesClient(self)
self._snapshot = SnapshotClient(self)
@property
def indices(self):
return self._indices
@property
def cluster(self):
return self._cluster
@property
def cat(self):
return self._cat
@property
def nodes(self):
return self._nodes
@property
def snapshot(self):
return self._snapshot
@property
def transport(self):
return self._transport
def __repr__(self):
return "<Elasticsearch [{!r}]>".format(self.transport)
def _bulk_body(self, body):
return '\n'.join(map(json.dumps, body)) + '\n'
def close(self):
return self.transport.close()
@asyncio.coroutine
def ping(self):
"""
Returns True if the cluster is up, False otherwise.
"""
try:
yield from self.transport.perform_request('HEAD', '/')
except TransportError:
return False
return True
@asyncio.coroutine
def info(self):
"""
Get the basic info from the current cluster.
"""
_, data = yield from self.transport.perform_request('GET', '/')
return data
# index API
@asyncio.coroutine
def create(self, index, doc_type, body, id=None, *,
consistency=default, parent=default, percolate=default,
refresh=default, replication=default, routing=default,
timeout=default, timestamp=default, ttl=default,
version=default, version_type=default):
"""
Adds a typed JSON document in a specific index, making it searchable.
Behind the scenes this method calls index(..., op_type='create')
"""
data = yield from self.index(
index, doc_type, body, id,
consistency=consistency, parent=parent, percolate=percolate,
refresh=refresh, replication=replication, routing=routing,
timeout=timeout, timestamp=timestamp, ttl=ttl,
version=version, version_type=version_type, op_type='create')
return data
@asyncio.coroutine
def index(self, index, doc_type, body, id=None, *,
consistency=default, op_type=default, parent=default,
percolate=default, refresh=default, replication=default,
routing=default, timeout=default, timestamp=default,
ttl=default, version=default, version_type=default):
"""
Adds or updates a typed JSON document in a specific index, making it
searchable.
"""
params = {}
if consistency is not default:
if not isinstance(consistency, str):
raise TypeError("'consistency' parameter is not a string")
elif consistency.lower() in ('one', 'quorum', 'all'):
params['consistency'] = consistency.lower()
else:
raise ValueError("'consistency' parameter should be one of"
" 'one', 'quorum', 'all'")
if op_type is not default:
if not isinstance(op_type, str):
raise TypeError("'op_type' parameter is not a string")
elif op_type.lower() in ('index', 'create'):
params['op_type'] = op_type.lower()
else:
raise ValueError(
"'op_type' parameter should be one of 'index', 'create'")
if parent is not default:
params['parent'] = parent
if percolate is not default:
params['percolate'] = percolate
if refresh is not default:
if refresh != 'wait_for':
refresh = str(bool(refresh)).lower()
params['refresh'] = refresh
if replication is not default:
if not isinstance(replication, str):
raise TypeError("'replication' parameter is not a string")
elif replication.lower() in ('async', 'sync'):
params['replication'] = replication.lower()
else:
raise ValueError(
"'replication' parameter should be one of 'async', 'sync'")
if routing is not default:
params['routing'] = routing
if timeout is not default:
params['timeout'] = timeout
if timestamp is not default:
params['timestamp'] = timestamp
if ttl is not default:
params['ttl'] = ttl
if version is not default:
params['version'] = int(version)
if version_type is not default:
if not isinstance(version_type, str):
raise TypeError("'version_type' parameter is not a string")
elif version_type.lower() in ('internal', 'external',
'external_gt', 'external_gte',
'force'):
params['version_type'] = version_type.lower()
else:
raise ValueError("'version_type' parameter should be one of "
"'internal', 'external', 'external_gt', "
"'external_gte', 'force'")
_, data = yield from self.transport.perform_request(
'PUT' if id else 'POST',
_make_path(index, doc_type, id),
params=params,
body=body)
return data
# get API
@asyncio.coroutine
def exists(self, index, id, doc_type='_all', *, parent=default,
preference=default, realtime=default, refresh=default,
routing=default):
"""
Returns a boolean indicating whether or not given document exists
in Elasticsearch.
"""
params = {}
if parent is not default:
params['parent'] = parent
if preference is not default:
params['preference'] = preference
if realtime is not default:
params['realtime'] = bool(realtime)
if refresh is not default:
params['refresh'] = bool(refresh)
if routing is not default:
params['routing'] = routing
try:
yield from self.transport.perform_request(
'HEAD',
_make_path(index, doc_type, id),
params=params)
except NotFoundError:
return False
return True
@asyncio.coroutine
def get(self, index, id, doc_type='_all', *,
_source=default, _source_exclude=default,
_source_include=default, fields=default,
parent=default, preference=default, realtime=default,
refresh=default, routing=default, version=default,
version_type=default):
"""
Get a typed JSON document from the index based on its id.
"""
params = {}
if _source is not default:
params['_source'] = _source
if _source_exclude is not default:
params['_source_exclude'] = _source_exclude
if _source_include is not default:
params['_source_include'] = _source_include
if fields is not default:
params['fields'] = fields
if parent is not default:
params['parent'] = parent
if preference is not default:
params['preference'] = preference
if realtime is not default:
params['realtime'] = bool(realtime)
if refresh is not default:
params['refresh'] = bool(refresh)
if routing is not default:
params['routing'] = routing
if version is not default:
params['version'] = int(version)
if version_type is not default:
if not isinstance(version_type, str):
raise TypeError("'version_type' parameter is not a string")
elif version_type.lower() in ('internal', 'external',
'external_gt', 'external_gte',
'force'):
params['version_type'] = version_type.lower()
else:
raise ValueError("'version_type' parameter should be one of "
"'internal', 'external', 'external_gt', "
"'external_gte', 'force'")
_, data = yield from self.transport.perform_request(
'GET',
_make_path(index, doc_type, id),
params=params)
return data
@asyncio.coroutine
def get_source(self, index, id, doc_type='_all', *,
_source=default, _source_exclude=default,
_source_include=default, parent=default,
preference=default, realtime=default, refresh=default,
routing=default, version=default,
version_type=default):
"""
Get the source of a document by it's index, type and id.
"""
params = {}
if _source is not default:
params['_source'] = _source
if _source_exclude is not default:
params['_source_exclude'] = _source_exclude
if _source_include is not default:
params['_source_include'] = _source_include
if parent is not default:
params['parent'] = parent
if preference is not default:
params['preference'] = preference
if realtime is not default:
params['realtime'] = bool(realtime)
if refresh is not default:
if refresh != 'wait_for':
refresh = str(bool(refresh)).lower()
params['refresh'] = refresh
if routing is not default:
params['routing'] = routing
if version is not default:
params['version'] = int(version)
if version_type is not default:
if not isinstance(version_type, str):
raise TypeError("'version_type' parameter is not a string")
elif version_type.lower() in ('internal', 'external',
'external_gt', 'external_gte',
'force'):
params['version_type'] = version_type.lower()
else:
raise ValueError("'version_type' parameter should be one of "
"'internal', 'external', 'external_gt', "
"'external_gte', 'force'")
_, data = yield from self.transport.perform_request(
'GET',
_make_path(index, doc_type, id, '_source'),
params=params)
return data
@asyncio.coroutine
def update(self, index, doc_type, id, body=None, *,
consistency=default, fields=default, lang=default,
parent=default, refresh=default, replication=default,
retry_on_conflict=default, routing=default, script=default,
timeout=default, timestamp=default, ttl=default,
version=default, version_type=default):
"""
Update a document based on a script or partial data provided.
"""
params = {}
if consistency is not default:
if not isinstance(consistency, str):
raise TypeError("'consistency' parameter is not a string")
elif consistency.lower() in ('one', 'quorum', 'all'):
params['consistency'] = consistency.lower()
else:
raise ValueError("'consistency' parameter should be one of "
"'one', 'quorum', 'all'")
if fields is not default:
params['fields'] = fields
if lang is not default:
params['lang'] = lang
if parent is not default:
params['parent'] = parent
if refresh is not default:
if refresh != 'wait_for':
refresh = str(bool(refresh)).lower()
params['refresh'] = refresh
if replication is not default:
if not isinstance(replication, str):
raise TypeError("'replication' parameter is not a string")
elif replication.lower() in ('async', 'sync'):
params['replication'] = replication.lower()
else:
raise ValueError(
"'replication' parameter should be one of 'async', 'sync'")
if retry_on_conflict is not default:
params['retry_on_conflict'] = retry_on_conflict
if routing is not default:
params['routing'] = routing
if script is not default:
params['script'] = script
if timeout is not default:
params['timeout'] = timeout
if timestamp is not default:
params['timestamp'] = timestamp
if ttl is not default:
params['ttl'] = ttl
if version is not default:
params['version'] = int(version)
if version_type is not default:
if not isinstance(version_type, str):
raise TypeError("'version_type' parameter is not a string")
elif version_type.lower() in ('internal', 'external',
'external_gt', 'external_gte',
'force'):
params['version_type'] = version_type.lower()
else:
raise ValueError("'version_type' parameter should be one of "
"'internal', 'external', 'external_gt', "
"'external_gte', 'force'")
_, data = yield from self.transport.perform_request(
'POST',
_make_path(index, doc_type, id, '_update'),
params=params,
body=body)
return data
@asyncio.coroutine
def mget(self, body, index=None, doc_type=None, *,
_source=default, _source_exclude=default,
_source_include=default, fields=default, parent=default,
preference=default, realtime=default, refresh=default,
routing=default, stored_fields=default):
"""
Get multiple documents based on an index, type (optional) and ids.
"""
params = {}
if _source is not default:
params['_source'] = _source
if _source_exclude is not default:
params['_source_exclude'] = _source_exclude
if _source_include is not default:
params['_source_include'] = _source_include
if fields is not default:
params['fields'] = fields
if parent is not default:
params['parent'] = parent
if preference is not default:
params['preference'] = preference
if realtime is not default:
params['realtime'] = bool(realtime)
if refresh is not default:
params['refresh'] = bool(refresh)
if routing is not default:
params['routing'] = routing
if stored_fields is not default:
params['stored_fields'] = stored_fields
_, data = yield from self.transport.perform_request(
'GET',
_make_path(index, doc_type, '_mget'),
params=params,
body=body)
return data
@asyncio.coroutine
def search(self, index=None, doc_type=None, body=None, *,
_source=default, _source_exclude=default,
_source_include=default, analyze_wildcard=default,
analyzer=default, default_operator=default, df=default,
explain=default, fields=default, indices_boost=default,
lenient=default, allow_no_indices=default,
expand_wildcards=default, ignore_unavailable=default,
lowercase_expanded_terms=default, from_=default,
preference=default, q=default, routing=default,
scroll=default, search_type=default, size=default,
sort=default, source=default, stats=default,
suggest_field=default, suggest_mode=default,
suggest_size=default, suggest_text=default,
timeout=default, version=default,
stored_fields=default):
"""
Execute a search query and get back search hits that match the query.
"""
if doc_type and index is None:
index = '_all'
params = {}
if _source is not default:
params['_source'] = _source
if _source_exclude is not default:
params['_source_exclude'] = _source_exclude
if _source_include is not default:
params['_source_include'] = _source_include
if analyze_wildcard is not default:
params['analyze_wildcard'] = bool(analyze_wildcard)
if df is not default:
params['df'] = df
if explain is not default:
params['explain'] = bool(explain)
if fields is not default:
params['fields'] = fields
if indices_boost is not default:
params['indices_boost'] = indices_boost
if lenient is not default:
params['lenient'] = bool(lenient)
if allow_no_indices is not default:
params['allow_no_indices'] = bool(allow_no_indices)
if ignore_unavailable is not default:
params['ignore_unavailable'] = bool(ignore_unavailable)
if lowercase_expanded_terms is not default:
params['lowercase_expanded_terms'] = bool(lowercase_expanded_terms)
# from is a reserved word so it cannot be used, use from_ instead
if from_ is not default:
params['from'] = int(from_)
if preference is not default:
params['preference'] = preference
if q is not default:
params['q'] = q
if routing is not default:
params['routing'] = routing
if scroll is not default:
params['scroll'] = scroll
if size is not default:
params['size'] = int(size)
if sort is not default:
params['sort'] = sort
if source is not default:
params['source'] = source
if stats is not default:
params['stats'] = stats
if suggest_field is not default:
params['suggest_field'] = suggest_field
if suggest_size is not default:
params['suggest_size'] = int(suggest_size)
if suggest_text is not default:
params['suggest_text'] = suggest_text
if timeout is not default:
params['timeout'] = timeout
if version is not default:
params['version'] = int(version)
if analyzer is not default:
params['analyzer'] = analyzer
if stored_fields is not default:
params['stored_fields'] = stored_fields
if expand_wildcards is not default:
if not isinstance(expand_wildcards, str):
raise TypeError("'expand_wildcards' parameter is not a string")
elif expand_wildcards.lower() in ('open', 'closed'):
params['expand_wildcards'] = expand_wildcards.lower()
else:
raise ValueError("'expand_wildcards' parameter should be one"
" of 'open', 'closed'")
if suggest_mode is not default:
if not isinstance(suggest_mode, str):
raise TypeError("'suggest_mode' parameter is not a string")
elif suggest_mode.lower() in ('missing', 'popular', 'always'):
params['suggest_mode'] = suggest_mode.lower()
else:
raise ValueError("'suggest_mode' parameter should be one of "
"'missing', 'popular', 'always'")
if search_type is not default:
if not isinstance(search_type, str):
raise TypeError("'search_type' parameter is not a string")
elif search_type.lower() in ('query_then_fetch',
'query_and_fetch',
'dfs_query_then_fetch',
'dfs_query_and_fetch',
'count',
'scan'):
params['search_type'] = search_type.lower()
else:
raise ValueError("'search_type' parameter should be one of "
"'query_then_fetch', 'query_and_fetch', "
"'dfs_query_then_fetch', "
"'dfs_query_and_fetch', 'count', 'scan'")
if default_operator is not default:
if not isinstance(default_operator, str):
raise TypeError("'default_operator' parameter is not a string")
elif default_operator.upper() in ('AND', 'OR'):
params['default_operator'] = default_operator.upper()
else:
raise ValueError("'default_operator' parameter should "
"be one of 'AND', 'OR'")
_, data = yield from self.transport.perform_request(
'GET',
_make_path(index, doc_type, '_search'),
params=params,
body=body)
return data
@asyncio.coroutine
def search_shards(self, index=None, doc_type=None, *,
allow_no_indices=default, expand_wildcards=default,
ignore_unavailable=default, local=default,
preference=default, routing=default):
"""
The search shards api returns the indices and shards that a search
request would be executed against. This can give useful feedback
for working out issues or planning optimizations with routing and
shard preferences.
"""
params = {}
if allow_no_indices is not default:
params['allow_no_indices'] = bool(allow_no_indices)
if expand_wildcards is not default:
if not isinstance(expand_wildcards, str):
raise TypeError("'expand_wildcards' parameter is not "
"a string")
elif expand_wildcards.lower() in ('open', 'closed'):
params['expand_wildcards'] = expand_wildcards.lower()
else:
raise ValueError("'expand_wildcards' parameter should be"
" one of 'open', 'closed'")
if ignore_unavailable is not default:
params['ignore_unavailable'] = bool(ignore_unavailable)
if local is not default:
params['local'] = local
if preference is not default:
params['preference'] = preference
if routing is not default:
params['routing'] = routing
_, data = yield from self.transport.perform_request(
'GET',
_make_path(index, doc_type, '_search_shards'),
params=params)
return data
@asyncio.coroutine
def search_template(self, index=None, doc_type=None, body=None, *,
allow_no_indices=default,
expand_wildcards=default,
ignore_unavailable=default, preference=default,
routing=default, scroll=default,
search_type=default):
"""
A query that accepts a query template and a map of key/value pairs to
fill in template parameters.
"""
params = {}
if allow_no_indices is not default:
params['allow_no_indices'] = bool(allow_no_indices)
if expand_wildcards is not default:
if not isinstance(expand_wildcards, str):
raise TypeError("'expand_wildcards' parameter is not "
"a string")
elif expand_wildcards.lower() in ('open', 'closed'):
params['expand_wildcards'] = expand_wildcards.lower()
else:
raise ValueError("'expand_wildcards' parameter should be"
" one of 'open', 'closed'")
if ignore_unavailable is not default:
params['ignore_unavailable'] = bool(ignore_unavailable)
if preference is not default:
params['preference'] = preference
if routing is not default:
params['routing'] = routing
if scroll is not default:
params['scroll'] = scroll
if search_type is not default:
if not isinstance(search_type, str):
raise TypeError("'search_type' parameter is not a string")
elif search_type.lower() in ('query_then_fetch',
'query_and_fetch',
'dfs_query_then_fetch',
'dfs_query_and_fetch',
'count',
'scan'):
params['search_type'] = search_type.lower()
else:
raise ValueError("'search_type' parameter should be one of "
"'query_then_fetch', 'query_and_fetch', "
"'dfs_query_then_fetch', "
"'dfs_query_and_fetch', 'count', 'scan'")
_, data = yield from self.transport.perform_request(
'GET',
_make_path(index, doc_type, '_search', 'template'),
params=params, body=body)
return data
@asyncio.coroutine
def explain(self, index, doc_type, id, body=None, *,
_source=default, _source_exclude=default,
_source_include=default, analyze_wildcard=default,
analyzer=default, default_operator=default,
df=default, fields=default, lenient=default,
lowercase_expanded_terms=default, parent=default,
preference=default, q=default, routing=default,
source=default, stored_fields=default):
"""
The explain api computes a score explanation for a query and a
specific document. This can give useful feedback whether a document
matches or didn't match a specific query.
"""
params = {}
if _source is not default:
params['_source'] = _source
if _source_exclude is not default:
params['_source_exclude'] = _source_exclude
if _source_include is not default:
params['_source_include'] = _source_include
if analyze_wildcard is not default:
params['analyze_wildcard'] = bool(analyze_wildcard)
if analyzer is not default:
params['analyzer'] = analyzer
if df is not default:
params['df'] = df
if fields is not default:
params['fields'] = fields
if lenient is not default:
params['lenient'] = bool(lenient)
if lowercase_expanded_terms is not default:
params['lowercase_expanded_terms'] = bool(lowercase_expanded_terms)
if parent is not default:
params['parent'] = parent
if preference is not default:
params['preference'] = preference
if q is not default:
params['q'] = q
if routing is not default:
params['routing'] = routing
if source is not default:
params['source'] = source
if stored_fields is not default:
params['stored_fields'] = stored_fields
if default_operator is not default:
if not isinstance(default_operator, str):
raise TypeError("'default_operator' parameter is not a string")
elif default_operator.upper() in ('AND', 'OR'):
params['default_operator'] = default_operator.upper()
else:
raise ValueError("'default_operator' parameter should "
"be one of 'AND', 'OR'")
_, data = yield from self.transport.perform_request(
'GET',
_make_path(index, doc_type, id, '_explain'),
params=params, body=body)
return data
@asyncio.coroutine
def scroll(self, scroll_id, *, scroll=default):
"""
Scroll a search request created by specifying the scroll parameter.
"""
params = {}
if scroll is not default:
params['scroll'] = scroll
_, data = yield from self.transport.perform_request(
'GET',
'/_search/scroll',
params=params, body=scroll_id)
return data
@asyncio.coroutine
def clear_scroll(self, scroll_id=None, body=None):
"""
Clear the scroll request created by specifying the scroll parameter
to search.
"""
_, data = yield from self.transport.perform_request(
'DELETE',
_make_path('_search', 'scroll', scroll_id),
body=body)
return data
@asyncio.coroutine
def delete(self, index, doc_type=None, id=None, *,
consistency=default, parent=default, refresh=default,
replication=default, routing=default, timeout=default,
version=default, version_type=default):
"""
Delete a typed JSON document from a specific index based on its id.
"""
params = {}
if consistency is not default:
if not isinstance(consistency, str):
raise TypeError("'consistency' parameter is not a string")
elif consistency.lower() in ('one', 'quorum', 'all'):
params['consistency'] = consistency.lower()
else:
raise ValueError(
"'consistency' parameter should be one of "
"'one', 'quorum', 'all'")
if replication is not default:
if not isinstance(replication, str):
raise TypeError("'replication' parameter is not a string")
elif replication.lower() in ('async', 'sync'):
params['replication'] = replication.lower()
else:
raise ValueError("'replication' parameter should be one of "
"'async', 'sync'")
if timeout is not default:
params['timeout'] = timeout
if parent is not default:
params['parent'] = parent
if refresh is not default:
if refresh != 'wait_for':
refresh = str(bool(refresh)).lower()
params['refresh'] = refresh
if routing is not default:
params['routing'] = routing
if version is not default:
params['version'] = int(version)
if version_type is not default:
if not isinstance(version_type, str):
raise TypeError("'version_type' parameter is not a string")
elif version_type.lower() in ('internal', 'external',
'external_gt', 'external_gte',
'force'):
params['version_type'] = version_type.lower()
else:
raise ValueError("'version_type' parameter should be one of "
"'internal', 'external', 'external_gt', "
"'external_gte', 'force'")
_, data = yield from self.transport.perform_request(
'DELETE',
_make_path(index, doc_type, id),
params=params)
return data
@asyncio.coroutine
def count(self, index=None, doc_type=None, body=None, *,
allow_no_indices=default, expand_wildcards=default,
ignore_unavailable=default, min_score=default,
preference=default, q=default, routing=default,
source=default):
"""
Execute a query and get the number of matches for that query.
"""
params = {}
if allow_no_indices is not default:
params['allow_no_indices'] = bool(allow_no_indices)
if ignore_unavailable is not default:
params['ignore_unavailable'] = bool(ignore_unavailable)
if min_score is not default:
params['min_score'] = int(min_score)
if preference is not default:
params['preference'] = preference
if q is not default:
params['q'] = q
if routing is not default:
params['routing'] = routing
if source is not default:
params['source'] = source
if expand_wildcards is not default:
if not isinstance(expand_wildcards, str):
raise TypeError("'expand_wildcards' parameter is not "
"a string")
elif expand_wildcards.lower() in ('open', 'closed'):
params['expand_wildcards'] = expand_wildcards.lower()
else:
raise ValueError("'expand_wildcards' parameter should be"
" one of 'open', 'closed'")
_, data = yield from self.transport.perform_request(
'POST',
_make_path(index, doc_type, '_count'),
params=params, body=body)
return data
@asyncio.coroutine
def bulk(self, body, index=None, doc_type=None, *,
consistency=default, refresh=default, routing=default,
replication=default, timeout=default):
"""
Perform many index/delete operations in a single API call.
"""
params = {}
if consistency is not default:
if not isinstance(consistency, str):
raise TypeError("'consistency' parameter is not a string")
elif consistency.lower() in ('one', 'quorum', 'all'):
params['consistency'] = consistency.lower()
else:
raise ValueError("'consistency' parameter should be one of "
"'one', 'quorum', 'all'")
if refresh is not default:
params['refresh'] = str(bool(refresh)).lower()
if routing is not default:
params['routing'] = routing
if replication is not default:
if not isinstance(replication, str):
raise TypeError("'replication' parameter is not a string")
elif replication.lower() in ('async', 'sync'):
params['replication'] = replication.lower()
else:
raise ValueError("'replication' parameter should be one of"
" 'async', 'sync'")
if timeout is not default:
params['timeout'] = timeout
_, data = yield from self.transport.perform_request(
'POST',
_make_path(index, doc_type, '_bulk'),
params=params,
body=self._bulk_body(body))
return data
@asyncio.coroutine
def msearch(self, body, index=None, doc_type=None, *,
search_type=default):
"""
Execute several search requests within the same API.
"""
params = {}
if search_type is not default:
if not isinstance(search_type, str):
raise TypeError("'search_type' parameter is not a string")
elif search_type.lower() in ('query_then_fetch',
'query_and_fetch',
'dfs_query_then_fetch',
'dfs_query_and_fetch',
'count',
'scan'):
params['search_type'] = search_type.lower()
else:
raise ValueError("'search_type' parameter should be one of "
"'query_then_fetch', 'query_and_fetch', "
"'dfs_query_then_fetch', "
"'dfs_query_and_fetch', 'count', 'scan'")
_, data = yield from self.transport.perform_request(
'POST',
_make_path(index, doc_type, '_msearch'),
params=params,
body=self._bulk_body(body))
return data
@asyncio.coroutine
def delete_by_query(self, index=None, doc_type=None, body=None, *,
allow_no_indices=default, analyzer=default,
consistency=default, default_operator=default,
df=default, expand_wildcards=default,
ignore_unavailable=default, q=default,
replication=default, routing=default,
source=default, timeout=default):
"""
Delete documents from one or more indices and one or more types based
on a query.
"""
if index is None:
index = '_all'
params = {}
if allow_no_indices is not default:
params['allow_no_indices'] = bool(allow_no_indices)
if analyzer is not default:
params['analyzer'] = analyzer
if default_operator is not default:
if not isinstance(default_operator, str):
raise TypeError("'default_operator' parameter is not a string")
elif default_operator.upper() in ('AND', 'OR'):
params['default_operator'] = default_operator.upper()
else:
raise ValueError("'default_operator' parameter should "
"be one of 'AND', 'OR'")
if df is not default:
params['df'] = df
if ignore_unavailable is not default:
params['ignore_unavailable'] = bool(ignore_unavailable)
if q is not default:
params['q'] = q
if routing is not default:
params['routing'] = routing
if source is not default:
params['source'] = source
if timeout is not default:
params['timeout'] = timeout
if consistency is not default:
if not isinstance(consistency, str):
raise TypeError("'consistency' parameter is not a string")
elif consistency.lower() in ('one', 'quorum', 'all'):
params['consistency'] = consistency.lower()
else:
raise ValueError("'consistency' parameter should be one of "
"'one', 'quorum', 'all'")
if replication is not default:
if not isinstance(replication, str):
raise TypeError("'replication' parameter is not a string")
elif replication.lower() in ('async', 'sync'):
params['replication'] = replication.lower()
else:
raise ValueError("'replication' parameter should be one of"
" 'async', 'sync'")
if expand_wildcards is not default:
if not isinstance(expand_wildcards, str):
raise TypeError("'expand_wildcards' parameter is not "
"a string")
elif expand_wildcards.lower() in ('open', 'closed'):
params['expand_wildcards'] = expand_wildcards.lower()
else:
raise ValueError("'expand_wildcards' parameter should be"
" one of 'open', 'closed'")
_, data = yield from self.transport.perform_request(
'DELETE',
_make_path(index, doc_type, '_query'),
params=params, body=body)
return data
@asyncio.coroutine
def suggest(self, index, body, *,
allow_no_indices=default, expand_wildcards=default,
ignore_unavailable=default, preference=default,
routing=default, source=default):
"""
The suggest feature suggests similar looking terms based on a
provided text by using a suggester.
"""
params = {}
if allow_no_indices is not default:
params['allow_no_indices'] = bool(allow_no_indices)
if ignore_unavailable is not default:
params['ignore_unavailable'] = bool(ignore_unavailable)
if preference is not default:
params['preference'] = preference
if routing is not default:
params['routing'] = routing
if source is not default:
params['source'] = source
_, data = yield from self.transport.perform_request(
'POST',