The indices APIs are used to manage individual indices, index settings, aliases, mappings, index templates and warmers.

author

- Hongxin Liang

See also

- http://www.elastic.co/guide/en/elasticsearch/reference/current/indices.html

license

- Apache License Version 2.0

 analyze(+Ps, +Index, +Body, -Reply) is semidet

 analyze(+Ps, +Index, +Params, +Body, -Reply) is semidet

Perform the analysis process on a text and return the tokens breakdown of the text. See here.

 refresh(+Ps, +Index, -Reply) is semidet

 refresh(+Ps, +Index, +Params, -Reply) is semidet

Explicitly refresh one or more index, making all operations performed since the last refresh available for search. See here.

 flush(+Ps, +Index, -Reply) is semidet

 flush(+Ps, +Index, +Params, -Reply) is semidet

Explicitly flush one or more indices. See here.

 create(+Ps, +Index, +Body, -Reply) is semidet

 create(+Ps, +Index, +Param, +Body, -Reply) is semidet

Create an index in Elasticsearch. See here.

 get(+Ps, +Index, +Feature, -Reply) is semidet

 get(+Ps, +Index, +Feature, +Params, -Reply) is semidet

The get index API allows to retrieve information about one or more indexes. See here.

 open_index(+Ps, +Index, -Reply) is semidet

 open_index(+Ps, +Index, +Params, -Reply) is semidet

Open a closed index to make it available for search. See here.

 close_index(+Ps, +Index, -Reply) is semidet

 close_index(+Ps, +Index, +Params, -Reply) is semidet

Close an index to remove it's overhead from the cluster. Closed index is blocked for read/write operations. See here.

 delete(+Ps, +Index, -Reply) is semidet

 delete(+Ps, +Index, +Params, -Reply) is semidet

Delete an index in Elasticsearch. See here.

 exists(+Ps, +Index) is semidet

 exists(+Ps, +Index, +Params) is semidet

Return a boolean indicating whether given index exists. See here.

 put_mapping(+Ps, +Index, +DocType, +Body, -Reply) is semidet

 put_mapping(+Ps, +Index, +DocType, +Params, +Body, -Reply) is semidet

Register specific mapping definition for a specific type. See here.

 get_mapping(+Ps, +Index, +DocType, -Reply) is semidet

 get_mapping(+Ps, +Index, +DocType, +Params, -Reply) is semidet

Retrieve mapping definition of index or index/type. See here.

 get_field_mapping(+Ps, +Index, +DocType, +Field, -Reply) is semidet

 get_field_mapping(+Ps, +Index, +DocType, +Field, +Params, -Reply) is semidet

Retrieve mapping definition of a specific field. See here.

 delete_mapping(+Ps, +Index, +DocType, -Reply) is semidet

 delete_mapping(+Ps, +Index, +DocType, +Params, -Reply) is semidet

Delete a mapping (type) along with its data. See here.

 put_alias(+Ps, +Index, +Alias, +Body, -Reply) is semidet

 put_alias(+Ps, +Index, +Alias, +Params, +Body, -Reply) is semidet

Create an alias for a specific index/indices. See here.

 exists_alias(+Ps, +Index, +Alias) is semidet

 exists_alias(+Ps, +Index, +Alias, +Params) is semidet

Return a boolean indicating whether given alias exists. See here.

 get_alias(+Ps, +Index, +Alias, -Reply) is semidet

 get_alias(+Ps, +Index, +Alias, +Params, -Reply) is semidet

Retrieve a specified alias. See here.

 get_aliases(+Ps, +Index, +Alias, -Reply) is semidet

 get_aliases(+Ps, +Index, +Alias, +Params, -Reply) is semidet

Retrieve a specified aliases. See here.

 update_aliases(+Ps, +Body, -Reply) is semidet

 update_aliases(+Ps, +Params, +Body, -Reply) is semidet

Update specified aliases. See here.

 delete_alias(+Ps, +Index, +Alias, -Reply) is semidet

 delete_alias(+Ps, +Index, +Alias, +Params, -Reply) is semidet

Delete specific alias. See here.

 put_template(+Ps, +Name, +Body, -Reply) is semidet

 put_template(+Ps, +Name, +Params, +Body, -Reply) is semidet

Create an index template that will automatically be applied to new indices created. See here.

 exists_template(+Ps, +Name) is semidet

 exists_template(+Ps, +Name, +Params) is semidet

Return a boolean indicating whether given template exists. See here.

 get_template(+Ps, +Name, -Reply) is semidet

 get_template(+Ps, +Name, +Params, -Reply) is semidet

Retrieve an index template by its name. See here.

 delete_template(+Ps, +Name, -Reply) is semidet

 delete_template(+Ps, +Name, +Params, -Reply) is semidet

Delete an index template by its name. See here.

 get_settings(+Ps, +Index, +Name, -Reply) is semidet

 get_settings(+Ps, +Index, +Name, +Params, -Reply) is semidet

Retrieve settings for one or more (or all) indices. See here.

 put_settings(+Ps, +Index, +Body, -Reply) is semidet

 put_settings(+Ps, +Index, +Params, +Body, -Reply) is semidet

Change specific index level settings in real time. See here.

 put_warmer(+Ps, +Index, +DocType, +Name, +Body, -Reply) is semidet

 put_warmer(+Ps, +Index, +DocType, +Name, +Params, +Body, -Reply) is semidet

Create an index warmer to run registered search requests to warm up the index before it is available for search. See here.

 get_warmer(+Ps, +Index, +DocType, +Name, -Reply) is semidet

 get_warmer(+Ps, +Index, +DocType, +Name, +Params, -Reply) is semidet

Retrieve an index warmer. See here.

 delete_warmer(+Ps, +Index, +Name, -Reply) is semidet

 delete_warmer(+Ps, +Index, +Name, +Params, -Reply) is semidet

Delete an index warmer. See here.

 status(+Ps, +Index, -Reply) is semidet

 status(+Ps, +Index, +Params, -Reply) is semidet

Get a comprehensive status information of one or more indices. See here.

 stats(+Ps, +Index, +Metric, -Reply) is semidet

 stats(+Ps, +Index, +Metric, +Params, -Reply) is semidet

Retrieve statistics on different operations happening on an index. See here.

 segments(+Ps, +Index, -Reply) is semidet

 segments(+Ps, +Index, +Params, -Reply) is semidet

Provide low level segments information that a Lucene index (shard level) is built with. See here.

 optimize(+Ps, +Index, -Reply) is semidet

 optimize(+Ps, +Index, +Params, -Reply) is semidet

Explicitly optimize one or more indices through an API. See here.

 validate_query(+Ps, +Index, +DocType, +Body, -Reply) is semidet

 validate_query(+Ps, +Index, +DocType, +Params, +Body, -Reply) is semidet

Validate a potentially expensive query without executing it. See here.

 clear_cache(+Ps, +Index, -Reply) is semidet

 clear_cache(+Ps, +Index, +Params, -Reply) is semidet

Clear either all caches or specific cached associated with one ore more indices. See here.

 recovery(+Ps, +Index, -Reply) is semidet

 recovery(+Ps, +Index, +Params, -Reply) is semidet

The indices recovery API provides insight into on-going shard recoveries. Recovery status may be reported for specific indices, or cluster-wide. See here.

 snapshot_index(+Ps, +Index, -Reply) is semidet

 snapshot_index(+Ps, +Index, +Params, -Reply) is semidet

Explicitly perform a snapshot through the gateway of one or more indices (backup them). See here.

 upgrade(+Ps, +Index, -Reply) is semidet

 upgrade(+Ps, +Index, +Params, -Reply) is semidet

Upgrade one or more indices to the latest format through an API. See here.

 get_upgrade(+Ps, +Index, -Reply) is semidet

 get_upgrade(+Ps, +Index, +Params, -Reply) is semidet

Monitor how much of one or more index is upgraded. See here.

Undocumented predicates

The following predicates are exported, but not or incorrectly documented.

 analyze(Arg1, Arg2, Arg3, Arg4, Arg5)

 refresh(Arg1, Arg2, Arg3, Arg4)

 flush(Arg1, Arg2, Arg3, Arg4)

 create(Arg1, Arg2, Arg3, Arg4, Arg5)

 get(Arg1, Arg2, Arg3, Arg4, Arg5)

 open_index(Arg1, Arg2, Arg3, Arg4)

 close_index(Arg1, Arg2, Arg3, Arg4)

 delete(Arg1, Arg2, Arg3, Arg4)

 exists(Arg1, Arg2, Arg3)

 put_mapping(Arg1, Arg2, Arg3, Arg4, Arg5, Arg6)

 get_mapping(Arg1, Arg2, Arg3, Arg4, Arg5)

 get_field_mapping(Arg1, Arg2, Arg3, Arg4, Arg5, Arg6)

 delete_mapping(Arg1, Arg2, Arg3, Arg4, Arg5)

 put_alias(Arg1, Arg2, Arg3, Arg4, Arg5, Arg6)

 exists_alias(Arg1, Arg2, Arg3, Arg4)

 get_alias(Arg1, Arg2, Arg3, Arg4, Arg5)

 get_aliases(Arg1, Arg2, Arg3, Arg4, Arg5)

 update_aliases(Arg1, Arg2, Arg3, Arg4)

 delete_alias(Arg1, Arg2, Arg3, Arg4, Arg5)

 put_template(Arg1, Arg2, Arg3, Arg4, Arg5)

 exists_template(Arg1, Arg2, Arg3)

 get_template(Arg1, Arg2, Arg3, Arg4)

 delete_template(Arg1, Arg2, Arg3, Arg4)

 get_settings(Arg1, Arg2, Arg3, Arg4, Arg5)

 put_settings(Arg1, Arg2, Arg3, Arg4, Arg5)

 put_warmer(Arg1, Arg2, Arg3, Arg4, Arg5, Arg6, Arg7)

 get_warmer(Arg1, Arg2, Arg3, Arg4, Arg5, Arg6)

 delete_warmer(Arg1, Arg2, Arg3, Arg4, Arg5)

 status(Arg1, Arg2, Arg3, Arg4)

 stats(Arg1, Arg2, Arg3, Arg4, Arg5)

 segments(Arg1, Arg2, Arg3, Arg4)

 optimize(Arg1, Arg2, Arg3, Arg4)

 validate_query(Arg1, Arg2, Arg3, Arg4, Arg5, Arg6)

 clear_cache(Arg1, Arg2, Arg3, Arg4)

 recovery(Arg1, Arg2, Arg3, Arg4)

 snapshot_index(Arg1, Arg2, Arg3, Arg4)

 upgrade(Arg1, Arg2, Arg3, Arg4)

 get_upgrade(Arg1, Arg2, Arg3, Arg4)