/
IndicesNamespace.php
1272 lines (1065 loc) · 53.3 KB
/
IndicesNamespace.php
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
<?php
namespace Elasticsearch\Namespaces;
/**
* Class IndicesNamespace
*
* @category Elasticsearch
* @package Elasticsearch\Namespaces\IndicesNamespace
* @author Zachary Tong <zachary.tong@elasticsearch.com>
* @license http://www.apache.org/licenses/LICENSE-2.0 Apache2
* @link http://elasticsearch.org
*/
class IndicesNamespace extends AbstractNamespace
{
/**
* $params['index'] = (list) A comma-separated list of indices to check (Required)
*
* @param $params array Associative array of parameters
*
* @return bool
*/
public function exists($params)
{
$index = $this->extractArgument($params, 'index');
//manually make this verbose so we can check status code
$params['client']['verbose'] = true;
/** @var callback $endpointBuilder */
$endpointBuilder = $this->endpoints;
/** @var \Elasticsearch\Endpoints\Indices\Exists $endpoint */
$endpoint = $endpointBuilder('Indices\Exists');
$endpoint->setIndex($index);
$endpoint->setParams($params);
return BooleanRequestWrapper::performRequest($endpoint);
}
/**
* $params['index'] = (list) A comma-separated list of indices to check (Required)
* ['feature'] = (list) A comma-separated list of features to return
* ['ignore_unavailable'] = (bool) Whether specified concrete indices should be ignored when unavailable (missing or closed)
* ['allow_no_indices'] = (bool) Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
* ['expand_wildcards'] = (enum) Whether to expand wildcard expression to concrete indices that are open, closed or both.
* ['local'] = (bool) Return local information, do not retrieve the state from master node (default: false)
*
* @param $params array Associative array of parameters
*
* @return bool
*/
public function get($params)
{
$index = $this->extractArgument($params, 'index');
$feature = $this->extractArgument($params, 'feature');
/** @var callback $endpointBuilder */
$endpointBuilder = $this->endpoints;
/** @var \Elasticsearch\Endpoints\Indices\Get $endpoint */
$endpoint = $endpointBuilder('Indices\Get');
$endpoint->setIndex($index)
->setFeature($feature)
->setParams($params);
$response = $endpoint->performRequest();
return $endpoint->resultOrFuture($response);
}
/**
* $params['index'] = (list) A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
* ['operation_threading'] = () TODO: ?
* ['ignore_unavailable'] = (bool) Whether specified concrete indices should be ignored when unavailable (missing or closed)
* ['allow_no_indices'] = (bool) Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
* ['expand_wildcards'] = (enum) Whether to expand wildcard expression to concrete indices that are open, closed or both.
*
* @param $params array Associative array of parameters
*
* @return array
*/
public function segments($params = array())
{
$index = $this->extractArgument($params, 'index');
/** @var callback $endpointBuilder */
$endpointBuilder = $this->endpoints;
/** @var \Elasticsearch\Endpoints\Indices\Segments $endpoint */
$endpoint = $endpointBuilder('Indices\Segments');
$endpoint->setIndex($index);
$endpoint->setParams($params);
$response = $endpoint->performRequest();
return $endpoint->resultOrFuture($response);
}
/**
* $params['name'] = (string) The name of the template (Required)
* ['timeout'] = (time) Explicit operation timeout
*
* @param $params array Associative array of parameters
*
* @return array
*/
public function deleteTemplate($params)
{
$name = $this->extractArgument($params, 'name');
/** @var callback $endpointBuilder */
$endpointBuilder = $this->endpoints;
/** @var \Elasticsearch\Endpoints\Indices\Template\Delete $endpoint */
$endpoint = $endpointBuilder('Indices\Template\Delete');
$endpoint->setName($name);
$endpoint->setParams($params);
$response = $endpoint->performRequest();
return $endpoint->resultOrFuture($response);
}
/**
* $params['index'] = (list) A comma-separated list of index names to register warmer for; use `_all` or empty string to perform the operation on all indices (Required)
* ['name'] = (string) The name of the warmer (supports wildcards); leave empty to delete all warmers
* ['type'] = (list) A comma-separated list of document types to register warmer for; use `_all` or empty string to perform the operation on all types
*
* @param $params array Associative array of parameters
*
* @return array
*/
public function deleteWarmer($params)
{
$index = $this->extractArgument($params, 'index');
$name = $this->extractArgument($params, 'name');
$type = $this->extractArgument($params, 'type');
/** @var callback $endpointBuilder */
$endpointBuilder = $this->endpoints;
/** @var \Elasticsearch\Endpoints\Indices\Warmer\Delete $endpoint */
$endpoint = $endpointBuilder('Indices\Warmer\Delete');
$endpoint->setIndex($index)
->setName($name)
->setType($type);
$endpoint->setParams($params);
$response = $endpoint->performRequest();
return $endpoint->resultOrFuture($response);
}
/**
* $params['index'] = (list) A comma-separated list of indices to delete; use `_all` or empty string to delete all indices
* ['timeout'] = (time) Explicit operation timeout
*
* @param $params array Associative array of parameters
*
* @return array
*/
public function delete($params = array())
{
$index = $this->extractArgument($params, 'index');
/** @var callback $endpointBuilder */
$endpointBuilder = $this->endpoints;
/** @var \Elasticsearch\Endpoints\Indices\Delete $endpoint */
$endpoint = $endpointBuilder('Indices\Delete');
$endpoint->setIndex($index);
$endpoint->setParams($params);
$response = $endpoint->performRequest();
return $endpoint->resultOrFuture($response);
}
/**
* $params['fields'] = (boolean) A comma-separated list of fields for `fielddata` metric (supports wildcards)
* ['index'] = (list) A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
* ['indexing_types'] = (list) A comma-separated list of document types to include in the `indexing` statistics
* ['metric_family'] = (enum) Limit the information returned to a specific metric
* ['search_groups'] = (list) A comma-separated list of search groups to include in the `search` statistics
* ['all'] = (boolean) Return all available information
* ['clear'] = (boolean) Reset the default level of detail
* ['docs'] = (boolean) Return information about indexed and deleted documents
* ['fielddata'] = (boolean) Return information about field data
* ['filter_cache'] = (boolean) Return information about filter cache
* ['flush'] = (boolean) Return information about flush operations
* ['get'] = (boolean) Return information about get operations
* ['groups'] = (boolean) A comma-separated list of search groups for `search` statistics
* ['id_cache'] = (boolean) Return information about ID cache
* ['ignore_indices'] = (enum) When performed on multiple indices, allows to ignore `missing` ones
* ['indexing'] = (boolean) Return information about indexing operations
* ['merge'] = (boolean) Return information about merge operations
* ['refresh'] = (boolean) Return information about refresh operations
* ['search'] = (boolean) Return information about search operations; use the `groups` parameter to include information for specific search groups
* ['store'] = (boolean) Return information about the size of the index
* ['warmer'] = (boolean) Return information about warmers
*
* @param $params array Associative array of parameters
*
* @return array
*/
public function stats($params = array())
{
$metric = $this->extractArgument($params, 'metric');
$index = $this->extractArgument($params, 'index');
/** @var callback $endpointBuilder */
$endpointBuilder = $this->endpoints;
/** @var \Elasticsearch\Endpoints\Indices\Stats $endpoint */
$endpoint = $endpointBuilder('Indices\Stats');
$endpoint->setIndex($index)
->setMetric($metric);
$endpoint->setParams($params);
$response = $endpoint->performRequest();
return $endpoint->resultOrFuture($response);
}
/**
* $params['index'] = (list) A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
* ['body'] = (list) A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
*
* @param $params array Associative array of parameters
*
* @return array
*/
public function putSettings($params = array())
{
$index = $this->extractArgument($params, 'index');
$body = $this->extractArgument($params, 'body');
/** @var callback $endpointBuilder */
$endpointBuilder = $this->endpoints;
/** @var \Elasticsearch\Endpoints\Indices\Settings\Put $endpoint */
$endpoint = $endpointBuilder('Indices\Settings\Put');
$endpoint->setIndex($index)
->setBody($body);
$endpoint->setParams($params);
$response = $endpoint->performRequest();
return $endpoint->resultOrFuture($response);
}
/**
* $params['index'] = (list) A comma-separated list of index names; use `_all` or empty string for all indices
* ['ignore_unavailable'] = (bool) Whether specified concrete indices should be ignored when unavailable (missing or closed)
* ['allow_no_indices'] = (bool) Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
* ['expand_wildcards'] = (enum) Whether to expand wildcard expression to concrete indices that are open, closed or both.
*
* @param $params array Associative array of parameters
*
* @return array
*/
public function snapshotIndex($params = array())
{
$index = $this->extractArgument($params, 'index');
/** @var callback $endpointBuilder */
$endpointBuilder = $this->endpoints;
/** @var \Elasticsearch\Endpoints\Indices\Gateway\Snapshot $endpoint */
$endpoint = $endpointBuilder('Indices\Gateway\Snapshot');
$endpoint->setIndex($index);
$endpoint->setParams($params);
$response = $endpoint->performRequest();
return $endpoint->resultOrFuture($response);
}
/**
* $params['index'] = (list) A comma-separated list of index names; use `_all` or empty string for all indices
* ['type'] = (list) A comma-separated list of document types
*
* @param $params array Associative array of parameters
*
* @return array
*/
public function getMapping($params = array())
{
$index = $this->extractArgument($params, 'index');
$type = $this->extractArgument($params, 'type');
/** @var callback $endpointBuilder */
$endpointBuilder = $this->endpoints;
/** @var \Elasticsearch\Endpoints\Indices\Mapping\Get $endpoint */
$endpoint = $endpointBuilder('Indices\Mapping\Get');
$endpoint->setIndex($index)
->setType($type);
$endpoint->setParams($params);
$response = $endpoint->performRequest();
return $endpoint->resultOrFuture($response);
}
/**
* $params['index'] = (list) A comma-separated list of index names; use `_all` or empty string for all indices
* ['type'] = (list) A comma-separated list of document types
* ['field'] = (list) A comma-separated list of document fields
* ['include_defaults'] = (bool) specifies default mapping values should be returned
*
* @param $params array Associative array of parameters
*
* @return array
*/
public function getFieldMapping($params = array())
{
$index = $this->extractArgument($params, 'index');
$type = $this->extractArgument($params, 'type');
$fields = $this->extractArgument($params, 'fields');
if (!isset($fields)) {
$fields = $this->extractArgument($params, 'field');
}
/** @var callback $endpointBuilder */
$endpointBuilder = $this->endpoints;
/** @var \Elasticsearch\Endpoints\Indices\Mapping\GetField $endpoint */
$endpoint = $endpointBuilder('Indices\Mapping\GetField');
$endpoint->setIndex($index)
->setType($type)
->setFields($fields);
$endpoint->setParams($params);
$response = $endpoint->performRequest();
return $endpoint->resultOrFuture($response);
}
/**
* $params['index'] = (list) A comma-separated list of index names; use `_all` or empty string for all indices
* ['force'] = (boolean) TODO: ?
* ['full'] = (boolean) TODO: ?
* ['refresh'] = (boolean) Refresh the index after performing the operation
* ['ignore_unavailable'] = (bool) Whether specified concrete indices should be ignored when unavailable (missing or closed)
* ['allow_no_indices'] = (bool) Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
* ['expand_wildcards'] = (enum) Whether to expand wildcard expression to concrete indices that are open, closed or both.
*
* @param $params array Associative array of parameters
*
* @return array
*/
public function flush($params = array())
{
$index = $this->extractArgument($params, 'index');
/** @var callback $endpointBuilder */
$endpointBuilder = $this->endpoints;
/** @var \Elasticsearch\Endpoints\Indices\Flush $endpoint */
$endpoint = $endpointBuilder('Indices\Flush');
$endpoint->setIndex($index);
$endpoint->setParams($params);
$response = $endpoint->performRequest();
return $endpoint->resultOrFuture($response);
}
/**
* $params['index'] = (list) A comma-separated list of index names; use `_all` or empty string for all indices
* ['force'] = (boolean) TODO: ?
* ['full'] = (boolean) TODO: ?
* ['refresh'] = (boolean) Refresh the index after performing the operation
* ['ignore_unavailable'] = (bool) Whether specified concrete indices should be ignored when unavailable (missing or closed)
* ['allow_no_indices'] = (bool) Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
* ['expand_wildcards'] = (enum) Whether to expand wildcard expression to concrete indices that are open, closed or both.
*
* @param $params array Associative array of parameters
*
* @return array
*/
public function flushSynced($params = array())
{
$index = $this->extractArgument($params, 'index');
/** @var callback $endpointBuilder */
$endpointBuilder = $this->endpoints;
/** @var \Elasticsearch\Endpoints\Indices\Flush $endpoint */
$endpoint = $endpointBuilder('Indices\Flush');
$endpoint->setIndex($index);
$endpoint->setParams($params);
$endpoint->setSynced(true);
$response = $endpoint->performRequest();
return $endpoint->resultOrFuture($response);
}
/**
* $params['index'] = (list) A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
* ['operation_threading'] = () TODO: ?
* ['ignore_unavailable'] = (bool) Whether specified concrete indices should be ignored when unavailable (missing or closed)
* ['allow_no_indices'] = (bool) Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
* ['expand_wildcards'] = (enum) Whether to expand wildcard expression to concrete indices that are open, closed or both.
*
* @param $params array Associative array of parameters
*
* @return array
*/
public function refresh($params = array())
{
$index = $this->extractArgument($params, 'index');
/** @var callback $endpointBuilder */
$endpointBuilder = $this->endpoints;
/** @var \Elasticsearch\Endpoints\Indices\Refresh $endpoint */
$endpoint = $endpointBuilder('Indices\Refresh');
$endpoint->setIndex($index);
$endpoint->setParams($params);
$response = $endpoint->performRequest();
return $endpoint->resultOrFuture($response);
}
/**
* $params['index'] = (list) A comma-separated list of index names; use `_all` or empty string for all indices
* ['detailed'] = (bool) Whether to display detailed information about shard recovery
* ['active_only'] = (bool) Display only those recoveries that are currently on-going
* ['human'] = (bool) Whether to return time and byte values in human-readable format.
*
* @param $params array Associative array of parameters
*
* @return array
*/
public function recovery($params = array())
{
$index = $this->extractArgument($params, 'index');
/** @var callback $endpointBuilder */
$endpointBuilder = $this->endpoints;
/** @var \Elasticsearch\Endpoints\Indices\Flush $endpoint */
$endpoint = $endpointBuilder('Indices\Recovery');
$endpoint->setIndex($index);
$endpoint->setParams($params);
$response = $endpoint->performRequest();
return $endpoint->resultOrFuture($response);
}
/**
* $params['index'] = (list) A comma-separated list of index names; use `_all` to check the types across all indices (Required)
* ['type'] = (list) A comma-separated list of document types to check (Required)
* ['ignore_unavailable'] = (bool) Whether specified concrete indices should be ignored when unavailable (missing or closed)
* ['allow_no_indices'] = (bool) Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
* ['expand_wildcards'] = (enum) Whether to expand wildcard expression to concrete indices that are open, closed or both.
*
* @param $params array Associative array of parameters
*
* @return array
*/
public function existsType($params)
{
$index = $this->extractArgument($params, 'index');
$type = $this->extractArgument($params, 'type');
//manually make this verbose so we can check status code
$params['client']['verbose'] = true;
/** @var callback $endpointBuilder */
$endpointBuilder = $this->endpoints;
/** @var \Elasticsearch\Endpoints\Indices\Type\Exists $endpoint */
$endpoint = $endpointBuilder('Indices\Type\Exists');
$endpoint->setIndex($index)
->setType($type);
$endpoint->setParams($params);
return BooleanRequestWrapper::performRequest($endpoint);
}
/**
* $params['index'] = (string) The name of the index with an alias
* ['name'] = (string) The name of the alias to be created or updated
* ['timeout'] = (time) Explicit timestamp for the document
* ['body'] = (time) Explicit timestamp for the document
*
* @param $params array Associative array of parameters
*
* @return array
*/
public function putAlias($params = array())
{
$index = $this->extractArgument($params, 'index');
$name = $this->extractArgument($params, 'name');
$body = $this->extractArgument($params, 'body');
/** @var callback $endpointBuilder */
$endpointBuilder = $this->endpoints;
/** @var \Elasticsearch\Endpoints\Indices\Alias\Put $endpoint */
$endpoint = $endpointBuilder('Indices\Alias\Put');
$endpoint->setIndex($index)
->setName($name)
->setBody($body);
$endpoint->setParams($params);
$response = $endpoint->performRequest();
return $endpoint->resultOrFuture($response);
}
/**
* $params['index'] = (list) A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices (Required)
* ['name'] = (string) The name of the warmer (supports wildcards); leave empty to get all warmers
* ['type'] = (list) A comma-separated list of document types to restrict the operation; leave empty to perform the operation on all types
*
* @param $params array Associative array of parameters
*
* @return array
*/
public function getWarmer($params)
{
$index = $this->extractArgument($params, 'index');
$name = $this->extractArgument($params, 'name');
$type = $this->extractArgument($params, 'type');
/** @var callback $endpointBuilder */
$endpointBuilder = $this->endpoints;
/** @var \Elasticsearch\Endpoints\Indices\Warmer\Get $endpoint */
$endpoint = $endpointBuilder('Indices\Warmer\Get');
$endpoint->setIndex($index)
->setName($name)
->setType($type);
$endpoint->setParams($params);
$response = $endpoint->performRequest();
return $endpoint->resultOrFuture($response);
}
/**
* $params['index'] = (list) A comma-separated list of index names to register the warmer for; use `_all` or empty string to perform the operation on all indices (Required)
* ['name'] = (string) The name of the warmer (Required)
* ['type'] = (list) A comma-separated list of document types to register the warmer for; leave empty to perform the operation on all types
* ['body'] = (list) A comma-separated list of document types to register the warmer for; leave empty to perform the operation on all types
*
* @param $params array Associative array of parameters
*
* @return array
*/
public function putWarmer($params)
{
$index = $this->extractArgument($params, 'index');
$name = $this->extractArgument($params, 'name');
$type = $this->extractArgument($params, 'type');
$body = $this->extractArgument($params, 'body');
/** @var callback $endpointBuilder */
$endpointBuilder = $this->endpoints;
/** @var \Elasticsearch\Endpoints\Indices\Warmer\Put $endpoint */
$endpoint = $endpointBuilder('Indices\Warmer\Put');
$endpoint->setIndex($index)
->setName($name)
->setType($type)
->setBody($body);
$endpoint->setParams($params);
$response = $endpoint->performRequest();
return $endpoint->resultOrFuture($response);
}
/**
* $params['name'] = (string) The name of the template (Required)
* ['order'] = (number) The order for this template when merging multiple matching ones (higher numbers are merged later, overriding the lower numbers)
* ['timeout'] = (time) Explicit operation timeout
* ['body'] = (time) Explicit operation timeout
* ['create'] = (bool) Whether the index template should only be added if new or can also replace an existing one
*
* @param $params array Associative array of parameters
*
* @return array
*/
public function putTemplate($params)
{
$name = $this->extractArgument($params, 'name');
$body = $this->extractArgument($params, 'body');
/** @var callback $endpointBuilder */
$endpointBuilder = $this->endpoints;
/** @var \Elasticsearch\Endpoints\Indices\Template\Put $endpoint */
$endpoint = $endpointBuilder('Indices\Template\Put');
$endpoint->setName($name)
->setBody($body);
$endpoint->setParams($params);
$response = $endpoint->performRequest();
return $endpoint->resultOrFuture($response);
}
/**
* $params['index'] = (list) A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices
* ['type'] = (list) A comma-separated list of document types to restrict the operation; leave empty to perform the operation on all types
* ['explain'] = (boolean) Return detailed information about the error
* ['ignore_indices'] = (enum) When performed on multiple indices, allows to ignore `missing` ones
* ['operation_threading'] = () TODO: ?
* ['source'] = (string) The URL-encoded query definition (instead of using the request body)
* ['body'] = (string) The URL-encoded query definition (instead of using the request body)
*
* @param $params array Associative array of parameters
*
* @return array
*/
public function validateQuery($params = array())
{
$index = $this->extractArgument($params, 'index');
$type = $this->extractArgument($params, 'type');
$body = $this->extractArgument($params, 'body');
/** @var callback $endpointBuilder */
$endpointBuilder = $this->endpoints;
/** @var \Elasticsearch\Endpoints\Indices\Validate\Query $endpoint */
$endpoint = $endpointBuilder('Indices\Validate\Query');
$endpoint->setIndex($index)
->setType($type)
->setBody($body);
$endpoint->setParams($params);
$response = $endpoint->performRequest();
return $endpoint->resultOrFuture($response);
}
/**
* $params['name'] = (list) A comma-separated list of alias names to return (Required)
* ['index'] = (list) A comma-separated list of index names to filter aliases
* ['ignore_indices'] = (enum) When performed on multiple indices, allows to ignore `missing` ones
* ['name'] = (list) A comma-separated list of alias names to return
*
* @param $params array Associative array of parameters
*
* @return array
*/
public function getAlias($params)
{
$index = $this->extractArgument($params, 'index');
$name = $this->extractArgument($params, 'name');
/** @var callback $endpointBuilder */
$endpointBuilder = $this->endpoints;
/** @var \Elasticsearch\Endpoints\Indices\Alias\Get $endpoint */
$endpoint = $endpointBuilder('Indices\Alias\Get');
$endpoint->setIndex($index)
->setName($name);
$endpoint->setParams($params);
$response = $endpoint->performRequest();
return $endpoint->resultOrFuture($response);
}
/**
* $params['index'] = (list) A comma-separated list of index names; use `_all` to perform the operation on all indices (Required)
* ['type'] = (string) The name of the document type
* ['ignore_conflicts'] = (boolean) Specify whether to ignore conflicts while updating the mapping (default: false)
* ['timeout'] = (time) Explicit operation timeout
* ['body'] = (time) Explicit operation timeout
*
* @param $params array Associative array of parameters
*
* @return array
*/
public function putMapping($params)
{
$index = $this->extractArgument($params, 'index');
$type = $this->extractArgument($params, 'type');
$body = $this->extractArgument($params, 'body');
/** @var callback $endpointBuilder */
$endpointBuilder = $this->endpoints;
/** @var \Elasticsearch\Endpoints\Indices\Mapping\Put $endpoint */
$endpoint = $endpointBuilder('Indices\Mapping\Put');
$endpoint->setIndex($index)
->setType($type)
->setBody($body);
$endpoint->setParams($params);
$response = $endpoint->performRequest();
return $endpoint->resultOrFuture($response);
}
/**
* $params['index'] = (list) A comma-separated list of index names; use `_all` for all indices (Required)
* ['type'] = (string) The name of the document type to delete (Required)
*
* @param $params array Associative array of parameters
*
* @return array
*/
public function deleteMapping($params)
{
$index = $this->extractArgument($params, 'index');
$type = $this->extractArgument($params, 'type');
/** @var callback $endpointBuilder */
$endpointBuilder = $this->endpoints;
/** @var \Elasticsearch\Endpoints\Indices\Mapping\Delete $endpoint */
$endpoint = $endpointBuilder('Indices\Mapping\Delete');
$endpoint->setIndex($index)
->setType($type);
$endpoint->setParams($params);
$response = $endpoint->performRequest();
return $endpoint->resultOrFuture($response);
}
/**
* $params['name'] = (string) The name of the template (Required)
*
* @param $params array Associative array of parameters
*
* @return array
*/
public function getTemplate($params)
{
$name = $this->extractArgument($params, 'name');
/** @var callback $endpointBuilder */
$endpointBuilder = $this->endpoints;
/** @var \Elasticsearch\Endpoints\Indices\Template\Get $endpoint */
$endpoint = $endpointBuilder('Indices\Template\Get');
$endpoint->setName($name);
$endpoint->setParams($params);
$response = $endpoint->performRequest();
return $endpoint->resultOrFuture($response);
}
/**
* $params['name'] = (string) The name of the template (Required)
*
* @param $params array Associative array of parameters
*
* @return array
*/
public function existsTemplate($params)
{
$name = $this->extractArgument($params, 'name');
//manually make this verbose so we can check status code
$params['client']['verbose'] = true;
/** @var callback $endpointBuilder */
$endpointBuilder = $this->endpoints;
/** @var \Elasticsearch\Endpoints\Indices\Template\Exists $endpoint */
$endpoint = $endpointBuilder('Indices\Template\Exists');
$endpoint->setName($name);
$endpoint->setParams($params);
return BooleanRequestWrapper::performRequest($endpoint);
}
/**
* $params['index'] = (string) The name of the index (Required)
* ['timeout'] = (time) Explicit operation timeout
* ['body'] = (time) Explicit operation timeout
*
* @param $params array Associative array of parameters
*
* @return array
*/
public function create($params)
{
$index = $this->extractArgument($params, 'index');
$body = $this->extractArgument($params, 'body');
/** @var callback $endpointBuilder */
$endpointBuilder = $this->endpoints;
/** @var \Elasticsearch\Endpoints\Indices\Create $endpoint */
$endpoint = $endpointBuilder('Indices\Create');
$endpoint->setIndex($index)
->setBody($body);
$endpoint->setParams($params);
$response = $endpoint->performRequest();
return $endpoint->resultOrFuture($response);
}
/**
* $params['index'] = (list) A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
* ['flush'] = (boolean) Specify whether the index should be flushed after performing the operation (default: true)
* ['max_num_segments'] = (number) The number of segments the index should be merged into (default: dynamic)
* ['only_expunge_deletes'] = (boolean) Specify whether the operation should only expunge deleted documents
* ['operation_threading'] = () TODO: ?
* ['refresh'] = (boolean) Specify whether the index should be refreshed after performing the operation (default: true)
* ['wait_for_merge'] = (boolean) Specify whether the request should block until the merge process is finished (default: true)
* ['ignore_unavailable'] = (bool) Whether specified concrete indices should be ignored when unavailable (missing or closed)
* ['allow_no_indices'] = (bool) Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
* ['expand_wildcards'] = (enum) Whether to expand wildcard expression to concrete indices that are open, closed or both.
*
* @param $params array Associative array of parameters
*
* @return array
*/
public function optimize($params = array())
{
$index = $this->extractArgument($params, 'index');
/** @var callback $endpointBuilder */
$endpointBuilder = $this->endpoints;
/** @var \Elasticsearch\Endpoints\Indices\Optimize $endpoint */
$endpoint = $endpointBuilder('Indices\Optimize');
$endpoint->setIndex($index);
$endpoint->setParams($params);
$response = $endpoint->performRequest();
return $endpoint->resultOrFuture($response);
}
/**
* $params['index'] = (list) A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
* ['flush'] = (boolean) Specify whether the index should be flushed after performing the operation (default: true)
* ['max_num_segments'] = (number) The number of segments the index should be merged into (default: dynamic)
* ['only_expunge_deletes'] = (boolean) Specify whether the operation should only expunge deleted documents
* ['operation_threading'] = () TODO: ?
* ['refresh'] = (boolean) Specify whether the index should be refreshed after performing the operation (default: true)
* ['wait_for_merge'] = (boolean) Specify whether the request should block until the merge process is finished (default: true)
* ['ignore_unavailable'] = (bool) Whether specified concrete indices should be ignored when unavailable (missing or closed)
* ['allow_no_indices'] = (bool) Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
* ['expand_wildcards'] = (enum) Whether to expand wildcard expression to concrete indices that are open, closed or both.
*
* @param $params array Associative array of parameters
*
* @return array
*/
public function forceMerge($params = array())
{
$index = $this->extractArgument($params, 'index');
/** @var callback $endpointBuilder */
$endpointBuilder = $this->endpoints;
/** @var \Elasticsearch\Endpoints\Indices\ForceMerge $endpoint */
$endpoint = $endpointBuilder('Indices\ForceMerge');
$endpoint->setIndex($index);
$endpoint->setParams($params);
$response = $endpoint->performRequest();
return $endpoint->resultOrFuture($response);
}
/**
* $params['index'] = (string) The name of the index with an alias (Required)
* ['name'] = (string) The name of the alias to be deleted (Required)
* ['timeout'] = (time) Explicit timestamp for the document
*
* @param $params array Associative array of parameters
*
* @return array
*/
public function deleteAlias($params)
{
$index = $this->extractArgument($params, 'index');
$name = $this->extractArgument($params, 'name');
/** @var callback $endpointBuilder */
$endpointBuilder = $this->endpoints;
/** @var \Elasticsearch\Endpoints\Indices\Alias\Delete $endpoint */
$endpoint = $endpointBuilder('Indices\Alias\Delete');
$endpoint->setIndex($index)
->setName($name);
$endpoint->setParams($params);
$response = $endpoint->performRequest();
return $endpoint->resultOrFuture($response);
}
/**
* $params['index'] = (string) The name of the index (Required)
* ['timeout'] = (time) Explicit operation timeout
*
* @param $params array Associative array of parameters
*
* @return array
*/
public function open($params)
{
$index = $this->extractArgument($params, 'index');
/** @var callback $endpointBuilder */
$endpointBuilder = $this->endpoints;
/** @var \Elasticsearch\Endpoints\Indices\Open $endpoint */
$endpoint = $endpointBuilder('Indices\Open');
$endpoint->setIndex($index);
$endpoint->setParams($params);
$response = $endpoint->performRequest();
return $endpoint->resultOrFuture($response);
}
/**
* $params['index'] = (string) The name of the index to scope the operation
* ['analyzer'] = (string) The name of the analyzer to use
* ['field'] = (string) Use the analyzer configured for this field (instead of passing the analyzer name)
* ['filter'] = (list) A comma-separated list of filters to use for the analysis
* ['prefer_local'] = (boolean) With `true`, specify that a local shard should be used if available, with `false`, use a random shard (default: true)
* ['text'] = (string) The text on which the analysis should be performed (when request body is not used)
* ['tokenizer'] = (string) The name of the tokenizer to use for the analysis
* ['format'] = (enum) Format of the output
* ['body'] = (enum) Format of the output
* ['char_filter'] = (list) A comma-separated list of character filters to use for the analysis
* ['explain'] = (bool) With `true`, outputs more advanced details. (default: false)
* ['attributes'] = (list) A comma-separated list of token attributes to output, this parameter works only with `explain=true`
* ['format'] = (enum) Format of the output (["detailed", "text"])
*
* @param $params array Associative array of parameters
*
* @return array
*/
public function analyze($params = array())
{
$index = $this->extractArgument($params, 'index');
$body = $this->extractArgument($params, 'body');
/** @var callback $endpointBuilder */
$endpointBuilder = $this->endpoints;
/** @var \Elasticsearch\Endpoints\Indices\Analyze $endpoint */
$endpoint = $endpointBuilder('Indices\Analyze');
$endpoint->setIndex($index)
->setBody($body);
$endpoint->setParams($params);
$response = $endpoint->performRequest();
return $endpoint->resultOrFuture($response);
}
/**
* $params['index'] = (list) A comma-separated list of index name to limit the operation
* ['field_data'] = (boolean) Clear field data
* ['fielddata'] = (boolean) Clear field data
* ['fields'] = (list) A comma-separated list of fields to clear when using the `field_data` parameter (default: all)
* ['filter'] = (boolean) Clear filter caches
* ['filter_cache'] = (boolean) Clear filter caches
* ['filter_keys'] = (boolean) A comma-separated list of keys to clear when using the `filter_cache` parameter (default: all)
* ['id'] = (boolean) Clear ID caches for parent/child
* ['id_cache'] = (boolean) Clear ID caches for parent/child
* ['recycler'] = (boolean) Clear the recycler cache
* ['ignore_unavailable'] = (bool) Whether specified concrete indices should be ignored when unavailable (missing or closed)
* ['allow_no_indices'] = (bool) Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
* ['expand_wildcards'] = (enum) Whether to expand wildcard expression to concrete indices that are open, closed or both.
*
* @param $params array Associative array of parameters
*
* @return array
*/
public function clearCache($params = array())
{
$index = $this->extractArgument($params, 'index');
/** @var callback $endpointBuilder */
$endpointBuilder = $this->endpoints;
/** @var \Elasticsearch\Endpoints\Indices\Cache\Clear $endpoint */
$endpoint = $endpointBuilder('Indices\Cache\Clear');
$endpoint->setIndex($index);
$endpoint->setParams($params);
$response = $endpoint->performRequest();
return $endpoint->resultOrFuture($response);
}