1Search::Elasticsearch::UCsleSireeanCrtoc:nh:t:7r:_iE0bl:ua:tsDetidircePsceetra:lr:cIDhno:dc:iuCcmleeisne(tn3at)t:i:o7n_0::Direct::Indices(3)
2
6 Search::Elasticsearch::Client::7_0::Direct::Indices - A client for
7 running index-level requests
8
10 version 7.30
11
13 This module provides methods to make index-level requests, such as
14 creating and deleting indices, managing type mappings, index settings,
15 index templates and aliases.
16 It does Search::Elasticsearch::Role::Client::Direct.
18
20 "create()"
21 $result = $e->indices->create(
22 index => 'my_index' # required
23 body => { # optional
25 index settings
26 mappings
27 aliases
28 }
29 );
30 The "create()" method is used to create an index. Optionally, index
32 settings, type mappings, and aliases can be added at the same time.
33 Query string parameters:
35 "error_trace",
36 "human",
37 "include_type_name",
38 "master_timeout",
39 "timeout",
40 "update_all_types",
41 "wait_for_active_shards"
42 See the create index docs
44 <http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-
45 create-index.html> for more information.
46 "get()"
48 $response = $e->indices->get(
49 index => 'index' | \@indices # required
50 );
51 Returns the aliases, settings, and mappings for the specified indices.
53 See the get index docs
55 <http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-
56 get-index.html>.
57 Query string parameters:
59 "allow_no_indices",
60 "error_trace",
61 "expand_wildcards",
62 "flat_settings",
63 "human",
64 "ignore_unavailable",
65 "include_defaults",
66 "include_type_name",
67 "local",
68 "master_timeout"
69 "exists()"
71 $bool = $e->indices->exists(
72 index => 'index' | \@indices # required
73 );
74 The "exists()" method returns 1 or the empty string to indicate whether
76 the specified index or indices exist.
77 Query string parameters:
79 "allow_no_indices",
80 "error_trace",
81 "expand_wildcards",
82 "flat_settings",
83 "human",
84 "ignore_unavailable",
85 "include_defaults",
86 "local"
87 See the index exists docs
89 <http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-
90 indices-exists.html> for more information.
91 "delete()"
93 $response = $e->indices->delete(
94 index => 'index' | \@indices # required
95 );
96 The "delete()" method deletes the specified indices.
98 Query string parameters:
100 "allow_no_indices",
101 "error_trace",
102 "expand_wildcards",
103 "human",
104 "ignore_unavailable",
105 "master_timeout",
106 "timeout"
107 See the delete index docs
109 <http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-
110 delete-index.html> for more information.
111 "close()"
113 $response = $e->indices->close(
114 index => 'index' | \@indices # required
115 );
116 The "close()" method closes the specified indices, reducing resource
118 usage but allowing them to be reopened later.
119 Query string parameters:
121 "allow_no_indices",
122 "error_trace",
123 "expand_wildcards",
124 "human",
125 "ignore_unavailable"
126 "master_timeout",
127 "timeout"
128 See the close index docs
130 <http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-
131 open-close.html> for more information.
132 "open()"
134 $response = $e->indices->open(
135 index => 'index' | \@indices # required
136 );
137 The "open()" method opens closed indices.
139 Query string parameters:
141 "allow_no_indices",
142 "error_trace",
143 "expand_wildcards",
144 "human",
145 "ignore_unavailable"
146 "master_timeout",
147 "timeout",
148 "wait_for_active_shards"
149 See the open index docs
151 <http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-
152 open-close.html> for more information.
153 "rollover()"
155 $response = $e->indices->rollover(
156 alias => $alias, # required
157 new_index => $index, # optional
158 body => { rollover conditions } # optional
159 );
160 Rollover an index pointed to by "alias" if it meets rollover conditions
162 (eg max age, max docs) to a new index name.
163 Query string parameters:
165 "dry_run",
166 "error_trace",
167 "human",
168 "include_type_name",
169 "master_timeout",
170 "timeout",
171 "wait_for_active_shards"
172 See the rollover index docs
174 <https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-
175 rollover-index.html> for more information.
176 "shrink()"
178 $response = $e->shrink(
179 index => $index, # required
180 target => $target, # required
181 body => { mappings, settings aliases } # optional
182 );
183 The shrink API shrinks the shards of an index down to a single shard
185 (or to a factor of the original shards).
186 Query string parameters:
188 "copy_settings",
189 "error_trace",
190 "filter_path",
191 "human",
192 "master_timeout",
193 "timeout",
194 "wait_for_active_shards"
195 See the shrink index docs
197 <https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-
198 shrink-index.html> for more information.
199 "split()"
201 $response = $e->split(
202 index => $index, # required
203 target => $target, # required
204 );
205 The split API splits a shard into multiple shards.
207 Query string parameters:
209 "copy_settings",
210 "error_trace",
211 "filter_path",
212 "human",
213 "master_timeout",
214 "timeout",
215 "wait_for_active_shards"
216 See the split index docs
218 <https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-
219 split-index.html> for more information.
220 "freeze()"
222 $response = $e->indices->freeze(
223 $index => $index # required
224 );
225 The "freeze()" API is used to freeze an index, which puts it in a state
227 which has almost no overhead on the cluster.
228 Query string parameters:
230 "allow_no_indices",
231 "error_trace",
232 "expand_wildcards",
233 "filter_path",
234 "human",
235 "ignore_unavailable",
236 "master_timeout",
237 "timeout",
238 "wait_for_active_shards"
239 See the freeze index docs
241 <https://www.elastic.co/guide/en/elasticsearch/reference/current/freeze-
242 index-api.html> for more information.
243 "unfreeze()"
245 $response = $e->indices->unfreeze(
246 $index => $index # required
247 );
248 The "unfreeze()" API is used to return a frozen index to its normal
250 state.
251 Query string parameters:
253 "allow_no_indices",
254 "error_trace",
255 "expand_wildcards",
256 "filter_path",
257 "human",
258 "ignore_unavailable",
259 "master_timeout",
260 "timeout",
261 "wait_for_active_shards"
262 See the unfreeze index docs
264 <https://www.elastic.co/guide/en/elasticsearch/reference/current/freeze-
265 index-api.html> for more information.
266 "clear_cache()"
268 $response = $e->indices->clear_cache(
269 index => 'index' | \@indices # optional
270 );
271 The "clear_cache()" method is used to clear the in-memory filter,
273 fielddata, or id cache for the specified indices.
274 Query string parameters:
276 "allow_no_indices",
277 "error_trace",
278 "expand_wildcards",
279 "fielddata",
280 "fields",
281 "human",
282 "ignore_unavailable",
283 "query",
284 "request"
285 See the clear_cache docs
287 <http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-
288 clearcache.html> for more information.
289 "refresh()"
291 $response = $e->indices->refresh(
292 index => 'index' | \@indices # optional
293 );
294 The "refresh()" method refreshes the specified indices (or all
296 indices), allowing recent changes to become visible to search. This
297 process normally happens automatically once every second by default.
298 Query string parameters:
300 "allow_no_indices",
301 "error_trace",
302 "expand_wildcards",
303 "human",
304 "ignore_unavailable"
305 See the refresh index docs
307 <http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-
308 refresh.html> for more information.
309 "flush()"
311 $response = $e->indices->flush(
312 index => 'index' | \@indices # optional
313 );
314 The "flush()" method causes the specified indices (or all indices) to
316 be written to disk with an "fsync", and clears out the transaction log.
317 This process normally happens automatically.
318 Query string parameters:
320 "allow_no_indices",
321 "error_trace",
322 "expand_wildcards",
323 "force",
324 "human",
325 "ignore_unavailable",
326 "wait_if_ongoing"
327 See the flush index docs
329 <http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-
330 flush.html> for more information.
331 "flush_synced()"
333 $respnse = $e->indices->flush_synced(
334 index => 'index' | \@indices # optional
335 );
336 The "flush_synced()" method does a synchronised flush() on the
338 primaries and replicas of all the specified indices. In other words,
339 after flushing it tries to write a "sync_id" on the primaries and
340 replicas to mark them as containing the same documents. During
341 recovery, if a replica has the same "sync_id" as the primary, then it
342 doesn't need to check whether the segment files on primary and replica
343 are the same, and it can move on directly to just replaying the
344 translog. This can greatly speed up recovery.
345 Synced flushes happens automatically in the background on indices that
347 have not received any writes for a while, but the flush_synced() method
348 can be used to trigger this process manually, eg before shutting down.
349 Any new commits immediately break the sync.
350 See the flush synced docs
352 <http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-
353 synced-flush.html> for more information.
354 Query string parameters:
356 "allow_no_indices",
357 "error_trace",
358 "expand_wildcards",
359 "human",
360 "ignore_unavailable"
361 "forcemerge()"
363 $response = $e->indices->forcemerge(
364 index => 'index' | \@indices # optional
365 );
366 The "forcemerge()" method rewrites all the data in an index into at
368 most "max_num_segments". This is a very heavy operation and should
369 only be run with care, and only on indices that are no longer being
370 updated.
371 Query string parameters:
373 "allow_no_indices",
374 "error_trace",
375 "expand_wildcards",
376 "flush",
377 "human",
378 "ignore_unavailable",
379 "max_num_segments",
380 "only_expunge_deletes"
381 See the forcemerge docs
383 <http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-
384 forcemerge.html> for more information.
385 "get_upgrade()"
387 $response = $e->indices->get_upgrade(
388 index => 'index' | \@indices # optional
389 );
390 The "get_upgrade()" method returns information about which indices need
392 to be upgraded, which can be done with the "upgrade()" method.
393 Query string parameters:
395 "allow_no_indices",
396 "error_trace",
397 "expand_wildcards",
398 "human",
399 "ignore_unavailable"
400 See the upgrade docs
402 <http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-
403 upgrade.html> for more information.
404 "upgrade()"
406 $response = $e->indices->upgrade(
407 index => 'index' | \@indices # optional
408 );
409 The "upgrade()" method upgrades all segments in the specified indices
411 to the latest format.
412 Query string parameters:
414 "allow_no_indices",
415 "error_trace",
416 "expand_wildcards",
417 "human",
418 "ignore_unavailable",
419 "only_ancient_segments",
420 "wait_for_completion"
421 See the upgrade docs
423 <http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-
424 upgrade.html> for more information.
425
427 "put_mapping()"
428 $response = $e->indices->put_mapping(
429 index => 'index' | \@indices # optional,
430 type => 'type', # optional
431 body => { mapping } # required
433 )
434 The "put_mapping()" method is used to create or update a type mapping
436 on an existing index. Mapping updates are allowed to add new fields,
437 but not to overwrite or change existing fields.
438 For instance:
440 $response = $e->indices->put_mapping(
442 index => 'users',
443 type => 'user',
444 body => {
445 user => {
446 properties => {
447 name => { type => 'string' },
448 age => { type => 'integer' }
449 }
450 }
451 }
452 );
453 Query string parameters:
455 "allow_no_indices",
456 "error_trace",
457 "expand_wildcards",
458 "human",
459 "ignore_unavailable",
460 "include_type_name",
461 "master_timeout",
462 "timeout",
463 "update_all_types"
464 See the put_mapping docs
466 <http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-
467 put-mapping.html> for more information.
468 "get_mapping()"
470 $result = $e->indices->get_mapping(
471 index => 'index' | \@indices # optional,
472 type => 'type' | \@types # optional
473 );
474 The "get_mapping()" method returns the type definitions for one, more
476 or all types in one, more or all indices.
477 Query string parameters:
479 "allow_no_indices",
480 "error_trace",
481 "expand_wildcards",
482 "human",
483 "ignore_unavailable",
484 "include_type_name",
485 "local",
486 "master_timeout"
487 See the get_mapping docs
489 <http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-
490 get-mapping.html> for more information.
491 "get_field_mapping()"
493 $result = $e->indices->get_field_mapping(
494 index => 'index' | \@indices # optional,
495 type => 'type' | \@types # optional,
496 fields => 'field' | \@fields # required
497 include_defaults => 0 | 1
499 );
500 The "get_field_mapping()" method returns the field definitions for one,
502 more or all fields in one, more or all types and indices.
503 Query string parameters:
505 "allow_no_indices",
506 "error_trace",
507 "expand_wildcards",
508 "human",
509 "ignore_unavailable",
510 "include_defaults",
511 "include_type_name",
512 "local"
513 See the get_mapping docs
515 <http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-
516 get-field-mapping.html> for more information.
517 "exists_type()"
519 $bool = $e->indices->exists_type(
520 index => 'index' | \@indices # required,
521 type => 'type' | \@types # required
522 );
523 The "exists_type()" method checks for the existence of all specified
525 types in all specified indices, and returns 1 or the empty string.
526 Query string parameters:
528 "allow_no_indices",
529 "error_trace",
530 "expand_wildcards",
531 "human",
532 "ignore_unavailable",
533 "local"
534 See the exists_type docs
536 <http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-
537 types-exists.html> for more information.
538
540 "update_aliases()"
541 $response = $e->indices->update_aliases(
542 body => { actions } # required
543 );
544 The "update_aliases()" method changes (by adding or removing) multiple
546 index aliases atomically. For instance:
547 $response = $e->indices->update_aliases(
549 body => {
550 actions => [
551 { add => { alias => 'current', index => 'logs_2013_09' }},
552 { remove => { alias => 'current', index => 'logs_2013_08' }}
553 ]
554 }
555 );
556 Query string parameters:
558 "error_trace",
559 "human",
560 "master_timeout",
561 "timeout"
562 See the update_aliases docs
564 <http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-
565 aliases.html> for more information.
566 "put_alias()"
568 $response = $e->indices->put_alias(
569 index => 'index' | \@indices, # required
570 name => 'alias', # required
571 body => { alias defn } # optional
573 );
574 The "put_alias()" method creates an index alias. For instance:
576 $response = $e->indices->put_alias(
578 index => 'my_index',
579 name => 'twitter',
580 body => {
581 filter => { term => { user_id => 'twitter' }}
582 }
583 );
584 Query string parameters:
586 "error_trace",
587 "human",
588 "master_timeout",
589 "timeout"
590 See the put_alias docs
592 <http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-
593 aliases.html> for more information.
594 "get_alias()"
596 $result = $e->indices->get_alias(
597 index => 'index' | \@indices, # optional
598 name => 'alias' | \@aliases # optional
599 );
600 The "get_alias()" method returns the alias definitions for the
602 specified aliases in the specified indices.
603 Query string parameters:
605 "allow_no_indices",
606 "error_trace",
607 "expand_wildcards",
608 "human",
609 "ignore_unavailable",
610 "local"
611 See the get_alias docs
613 <http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-
614 aliases.html> for more information.
615 "exists_alias()"
617 $bool = $e->indices->exists_alias(
618 index => 'index' | \@indices, # optional
619 name => 'alias' | \@aliases # required
620 );
621 The "exists_alias()" method returns 1 or the empty string depending on
623 whether the specified aliases exist in the specified indices.
624 Query string parameters:
626 "allow_no_indices",
627 "error_trace",
628 "expand_wildcards",
629 "human",
630 "ignore_unavailable",
631 "local"
632 See the exists_alias docs
634 <http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-
635 aliases.html> for more information.
636 "delete_alias()"
638 $response = $e->indices->delete_alias(
639 index => 'index' | \@indices # required,
640 name => 'alias' | \@aliases # required
641 );
642 The "delete_alias()" method deletes one or more aliases from one or
644 more indices.
645 Query string parameters:
647 "error_trace",
648 "human",
649 "master_timeout",
650 "timeout"
651 See the delete_alias docs
653 <http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-
654 aliases.html> for more information.
655
657 "put_settings()"
658 $response = $e->indices->put_settings(
659 index => 'index' | \@indices # optional
660 body => { settings }
662 );
663 The "put_settings()" method sets the index settings for the specified
665 indices or all indices. For instance:
666 $response = $e->indices->put_settings(
668 body => {
669 "index.refresh_interval" => -1
670 }
671 );
672 Query string parameters:
674 "allow_no_indices",
675 "error_trace",
676 "expand_wildcards",
677 "flat_settings",
678 "human",
679 "ignore_unavailable",
680 "master_timeout",
681 "preserve_existing",
682 "timeout"
683 See the put_settings docs
685 <http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-
686 update-settings.html> for more information.
687 "get_settings()"
689 $result = $e->indices->get_settings(
690 index => 'index' | \@indices # optional
691 name => 'name' | \@names # optional
692 );
693 The "get_settings()" method retrieves the index settings for the
695 specified indices or all indices.
696 Query string parameters:
698 "allow_no_indices",
699 "error_trace",
700 "expand_wildcards",
701 "flat_settings",
702 "human",
703 "ignore_unavailable",
704 "include_defaults",
705 "local",
706 "master_timeout"
707 See the get_settings docs
709 <http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-
710 get-settings.html> for more information.
711
713 "put_template()"
714 $response = $e->indices->put_template(
715 name => 'template' # required
716 body => { template defn } # required
717 );
718 The "put_template()" method is used to create or update index
720 templates.
721 Query string parameters:
723 "create",
724 "error_trace",
725 "flat_settings",
726 "human",
727 "include_type_name",
728 "master_timeout",
729 "order",
730 "timeout"
731 See the put_template docs
733 <http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-
734 templates.html> for more information.
735 "get_template()"
737 $result = $e->indices->get_template(
738 name => 'template' | \@templates # optional
739 );
740 The "get_template()" method is used to retrieve a named template.
742 Query string parameters:
744 "error_trace",
745 "flat_settings",
746 "human",
747 "include_type_name",
748 "local",
749 "master_timeout"
750 See the get_template docs
752 <http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-
753 templates.html> for more information.
754 "exists_template()"
756 $result = $e->indices->exists_template(
757 name => 'template' # optional
758 );
759 The "exists_template()" method is used to check whether the named
761 template exists.
762 Query string parameters:
764 "error_trace",
765 "flat_settings",
766 "human",
767 "local",
768 "master_timeout"
769 See the get_template docs
771 <http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-
772 templates.html> for more information.
773 "delete_template()"
775 $response = $e->indices->delete_template(
776 name => 'template' # required
777 );
778 The "delete_template()" method is used to delete a named template.
780 Query string parameters:
782 "error_trace",
783 "human",
784 "master_timeout",
785 "timeout",
786 "version",
787 "version_type"
788 See the delete_template docs
790 <http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-
791 templates.html> for more information.
792
794 "stats()"
795 $result = $e->indices->stats(
796 index => 'index' | \@indices # optional
797 metric => 'metric' | \@metrics # optional
798 );
799 The "stats()" method returns statistical information about one, more or
801 all indices. By default it returns all metrics, but you can limit which
802 metrics are returned by specifying the "metric".
803 Allowed metrics are:
805 "_all",
806 "completion"
807 "docs",
808 "fielddata",
809 "filter_cache",
810 "flush",
811 "get",
812 "id_cache",
813 "indexing",
814 "merge",
815 "percolate",
816 "query_cache",
817 "refresh",
818 "request_cache",
819 "search",
820 "segments",
821 "store"
822 Query string parameters:
824 "completion_fields",
825 "error_trace",
826 "fielddata_fields",
827 "fields",
828 "groups",
829 "human",
830 "include_segment_file_sizes",
831 "level",
832 "types"
833 See the stats docs
835 <http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-
836 stats.html> for more information.
837 "recovery()"
839 $result = $e->indices->recovery(
840 index => 'index' | \@indices # optional
841 );
842 Provides insight into on-going shard recoveries.
844 Query string parameters:
846 "active_only",
847 "detailed",
848 "error_trace",
849 "human"
850 See the recovery docs
852 <http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-
853 recovery.html> for more information.
854 "segments()"
856 $result = $e->indices->segments(
857 index => 'index' | \@indices # optional
858 );
859 The "segments()" method is used to return information about the
861 segments that an index contains.
862 Query string parameters:
864 "allow_no_indices",
865 "error_trace",
866 "expand_wildcards",
867 "human",
868 "ignore_unavailable",
869 "verbose"
870 See the segments docs
872 <http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-
873 segments.html> for more information.
874 "shard_stores()"
876 $result = $e->indices->shard_stores(
877 index => 'index' | \@indices # optional
878 );
879 The "shard_stores()" method is used to find out which nodes contain
881 copies of which shards, whether the shards are allocated or not.
882 Query string parameters:
884 "allow_no_indices",
885 "error_trace",
886 "expand_wildcards",
887 "human",
888 "ignore_unavailable",
889 "status"
890 See the shard_stores docs
892 <http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-
893 shards-stores.html> for more information.
894
896 "analyze()"
897 $result = $e->indices->analyze(
898 index => 'index' # optional,
899 body => 'text to analyze'
900 );
901 The "analyze()" method passes the text in the "body" through the
903 specified "analyzer", "tokenizer" or token "filter" - which may be
904 global, or associated with a particular index or field - and returns
905 the tokens. Very useful for debugging analyzer configurations.
906 Query string parameters:
908 "error_trace",
909 "human"
910 See the analyze docs
912 <http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-
913 analyze.html> for more information.
914 "validate_query()"
916 $result = $e->indices->validate_query(
917 index => 'index' | \@indices, # optional
918 type => 'type' | \@types, # optional
919 body => { query }
921 );
922 The "validate_query()" method accepts a query in the "body" and checks
924 whether the query is valid or not. Most useful when "explain" is set
925 to "true", in which case it includes an execution plan in the output.
926 Query string parameters:
928 "all_shards",
929 "allow_no_indices",
930 "analyze_wildcard",
931 "analyzer",
932 "default_operator",
933 "df",
934 "error_trace",
935 "explain",
936 "expand_wildcards",
937 "ignore_unavailable",
938 "lenient",
939 "q",
940 "rewrite"
941 See the validate_query docs
943 <http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-
944 validate.html> for more information.
945
947 Enrico Zimuel <enrico.zimuel@elastic.co>
948
950 This software is Copyright (c) 2020 by Elasticsearch BV.
951 This is free software, licensed under:
953 The Apache License, Version 2.0, January 2004
955perl v5.34.0 Search::El2a0s2t1i-c0s7e-a2r2ch::Client::7_0::Direct::Indices(3)