2013-08-28 19:24:34 -04:00
|
|
|
[[indices]]
|
2019-07-19 14:35:36 -04:00
|
|
|
== Index APIs
|
2013-08-28 19:24:34 -04:00
|
|
|
|
2019-07-17 08:49:22 -04:00
|
|
|
Index APIs are used to manage individual indices,
|
2020-06-11 11:32:09 -04:00
|
|
|
index settings, aliases, mappings, and index templates.
|
2013-08-28 19:24:34 -04:00
|
|
|
|
|
|
|
[float]
|
2013-09-25 12:17:40 -04:00
|
|
|
[[index-management]]
|
2019-07-19 14:35:36 -04:00
|
|
|
=== Index management:
|
2013-08-28 19:24:34 -04:00
|
|
|
|
|
|
|
* <<indices-create-index>>
|
|
|
|
* <<indices-delete-index>>
|
2014-08-12 06:42:12 -04:00
|
|
|
* <<indices-get-index>>
|
2013-08-28 19:24:34 -04:00
|
|
|
* <<indices-exists>>
|
2019-08-27 12:31:53 -04:00
|
|
|
* <<indices-close>>
|
2013-08-28 19:24:34 -04:00
|
|
|
* <<indices-open-close>>
|
2016-05-31 04:41:44 -04:00
|
|
|
* <<indices-shrink-index>>
|
2017-11-06 05:37:55 -05:00
|
|
|
* <<indices-split-index>>
|
2019-07-25 14:17:51 -04:00
|
|
|
* <<indices-clone-index>>
|
2016-06-08 18:32:22 -04:00
|
|
|
* <<indices-rollover-index>>
|
2019-07-17 08:49:22 -04:00
|
|
|
* <<freeze-index-api>>
|
|
|
|
* <<unfreeze-index-api>>
|
|
|
|
|
2013-08-28 19:24:34 -04:00
|
|
|
|
|
|
|
[float]
|
2013-09-25 12:17:40 -04:00
|
|
|
[[mapping-management]]
|
2019-07-19 14:35:36 -04:00
|
|
|
=== Mapping management:
|
2013-08-28 19:24:34 -04:00
|
|
|
|
|
|
|
* <<indices-put-mapping>>
|
2013-10-14 02:53:07 -04:00
|
|
|
* <<indices-get-mapping>>
|
|
|
|
* <<indices-get-field-mapping>>
|
2013-08-28 19:24:34 -04:00
|
|
|
* <<indices-types-exists>>
|
|
|
|
|
|
|
|
[float]
|
2013-09-25 12:17:40 -04:00
|
|
|
[[alias-management]]
|
2019-07-19 14:35:36 -04:00
|
|
|
=== Alias management:
|
2019-08-29 10:38:48 -04:00
|
|
|
* <<indices-add-alias>>
|
2019-09-03 09:10:46 -04:00
|
|
|
* <<indices-delete-alias>>
|
2019-08-29 09:44:58 -04:00
|
|
|
* <<indices-get-alias>>
|
2019-08-28 08:58:09 -04:00
|
|
|
* <<indices-alias-exists>>
|
2013-08-28 19:24:34 -04:00
|
|
|
* <<indices-aliases>>
|
|
|
|
|
|
|
|
[float]
|
2013-09-25 12:17:40 -04:00
|
|
|
[[index-settings]]
|
2019-07-19 14:35:36 -04:00
|
|
|
=== Index settings:
|
2013-08-28 19:24:34 -04:00
|
|
|
* <<indices-update-settings>>
|
|
|
|
* <<indices-get-settings>>
|
|
|
|
* <<indices-analyze>>
|
2019-08-29 13:18:47 -04:00
|
|
|
|
|
|
|
[float]
|
|
|
|
[[index-templates]]
|
|
|
|
=== Index templates:
|
2019-09-04 11:47:32 -04:00
|
|
|
* <<indices-templates>>
|
2020-06-03 21:15:39 -04:00
|
|
|
* <<indices-put-template>>
|
2019-09-04 10:58:24 -04:00
|
|
|
* <<indices-get-template>>
|
2020-06-03 21:15:39 -04:00
|
|
|
* <<indices-delete-template>>
|
|
|
|
* <<indices-component-template>>
|
|
|
|
* <<getting-component-templates>>
|
2019-08-29 13:18:47 -04:00
|
|
|
* <<indices-template-exists>>
|
2013-08-28 19:24:34 -04:00
|
|
|
|
2020-04-28 18:10:50 -04:00
|
|
|
[float]
|
|
|
|
[[component-template-apis]]
|
|
|
|
=== Component templates:
|
|
|
|
* <<indices-component-template>>
|
|
|
|
|
2013-08-28 19:24:34 -04:00
|
|
|
[float]
|
2013-09-25 12:17:40 -04:00
|
|
|
[[monitoring]]
|
2019-07-19 14:35:36 -04:00
|
|
|
=== Monitoring:
|
2013-08-28 19:24:34 -04:00
|
|
|
* <<indices-stats>>
|
|
|
|
* <<indices-segments>>
|
2014-02-18 17:28:49 -05:00
|
|
|
* <<indices-recovery>>
|
2015-07-18 06:03:59 -04:00
|
|
|
* <<indices-shards-stores>>
|
2013-08-28 19:24:34 -04:00
|
|
|
|
|
|
|
[float]
|
2013-09-25 12:17:40 -04:00
|
|
|
[[status-management]]
|
2019-07-19 14:35:36 -04:00
|
|
|
=== Status management:
|
2013-08-28 19:24:34 -04:00
|
|
|
* <<indices-clearcache>>
|
|
|
|
* <<indices-refresh>>
|
|
|
|
* <<indices-flush>>
|
2019-09-19 08:22:37 -04:00
|
|
|
* <<indices-synced-flush-api>>
|
2015-09-17 16:36:25 -04:00
|
|
|
* <<indices-forcemerge>>
|
2013-08-28 19:24:34 -04:00
|
|
|
|
|
|
|
|
2019-10-01 17:07:28 -04:00
|
|
|
include::indices/add-alias.asciidoc[]
|
2014-08-12 06:42:12 -04:00
|
|
|
|
2019-10-01 17:07:28 -04:00
|
|
|
include::indices/analyze.asciidoc[]
|
2013-08-28 19:24:34 -04:00
|
|
|
|
2019-10-01 17:07:28 -04:00
|
|
|
include::indices/clearcache.asciidoc[]
|
2019-08-27 12:31:53 -04:00
|
|
|
|
2019-10-01 17:07:28 -04:00
|
|
|
include::indices/clone-index.asciidoc[]
|
2013-08-28 19:24:34 -04:00
|
|
|
|
2019-10-01 17:07:28 -04:00
|
|
|
include::indices/close.asciidoc[]
|
2016-05-31 05:50:50 -04:00
|
|
|
|
2019-10-01 17:07:28 -04:00
|
|
|
include::indices/create-index.asciidoc[]
|
2017-11-06 06:55:41 -05:00
|
|
|
|
2019-10-01 17:07:28 -04:00
|
|
|
include::indices/delete-index.asciidoc[]
|
2019-07-25 14:17:51 -04:00
|
|
|
|
2019-10-01 17:07:28 -04:00
|
|
|
include::indices/delete-alias.asciidoc[]
|
2016-06-17 12:14:45 -04:00
|
|
|
|
2019-10-01 17:07:28 -04:00
|
|
|
include::indices/delete-index-template.asciidoc[]
|
2019-07-17 08:49:22 -04:00
|
|
|
|
2019-10-01 17:07:28 -04:00
|
|
|
include::indices/flush.asciidoc[]
|
2019-07-17 08:49:22 -04:00
|
|
|
|
2019-10-01 17:07:28 -04:00
|
|
|
include::indices/forcemerge.asciidoc[]
|
2013-08-28 19:24:34 -04:00
|
|
|
|
2019-10-01 17:07:28 -04:00
|
|
|
include::indices/apis/freeze.asciidoc[]
|
2013-08-28 19:24:34 -04:00
|
|
|
|
2013-10-14 02:53:07 -04:00
|
|
|
include::indices/get-field-mapping.asciidoc[]
|
|
|
|
|
2019-10-01 17:07:28 -04:00
|
|
|
include::indices/get-index.asciidoc[]
|
2019-09-03 09:10:46 -04:00
|
|
|
|
2019-08-29 09:44:58 -04:00
|
|
|
include::indices/get-alias.asciidoc[]
|
|
|
|
|
2019-10-01 17:07:28 -04:00
|
|
|
include::indices/get-settings.asciidoc[]
|
2019-08-28 08:58:09 -04:00
|
|
|
|
2019-10-01 17:07:28 -04:00
|
|
|
include::indices/get-index-template.asciidoc[]
|
2013-08-28 19:24:34 -04:00
|
|
|
|
2019-10-01 17:07:28 -04:00
|
|
|
include::indices/get-mapping.asciidoc[]
|
2013-08-28 19:24:34 -04:00
|
|
|
|
2019-10-01 17:07:28 -04:00
|
|
|
include::indices/alias-exists.asciidoc[]
|
2013-08-28 19:24:34 -04:00
|
|
|
|
2019-10-01 17:07:28 -04:00
|
|
|
include::indices/indices-exists.asciidoc[]
|
2013-08-28 19:24:34 -04:00
|
|
|
|
2019-10-01 17:07:28 -04:00
|
|
|
include::indices/recovery.asciidoc[]
|
2019-09-04 11:47:32 -04:00
|
|
|
|
2019-10-01 17:07:28 -04:00
|
|
|
include::indices/segments.asciidoc[]
|
2019-08-29 14:37:47 -04:00
|
|
|
|
2019-10-01 17:07:28 -04:00
|
|
|
include::indices/shard-stores.asciidoc[]
|
|
|
|
|
|
|
|
include::indices/stats.asciidoc[]
|
2019-09-04 10:58:24 -04:00
|
|
|
|
2019-08-29 13:18:47 -04:00
|
|
|
include::indices/template-exists.asciidoc[]
|
|
|
|
|
2019-10-01 17:07:28 -04:00
|
|
|
include::indices/open-close.asciidoc[]
|
2013-08-28 19:24:34 -04:00
|
|
|
|
2020-04-28 18:10:50 -04:00
|
|
|
include::indices/index-templates.asciidoc[]
|
|
|
|
|
|
|
|
include::indices/component-templates.asciidoc[]
|
|
|
|
|
2019-10-01 17:07:28 -04:00
|
|
|
include::indices/templates.asciidoc[]
|
2013-08-28 19:24:34 -04:00
|
|
|
|
2019-10-01 17:07:28 -04:00
|
|
|
include::indices/put-mapping.asciidoc[]
|
2014-02-18 17:28:49 -05:00
|
|
|
|
2019-10-01 17:07:28 -04:00
|
|
|
include::indices/refresh.asciidoc[]
|
2015-07-18 06:03:59 -04:00
|
|
|
|
2019-10-01 17:07:28 -04:00
|
|
|
include::indices/rollover-index.asciidoc[]
|
2013-08-28 19:24:34 -04:00
|
|
|
|
2019-10-01 17:07:28 -04:00
|
|
|
include::indices/shrink-index.asciidoc[]
|
|
|
|
|
|
|
|
include::indices/split-index.asciidoc[]
|
2013-08-28 19:24:34 -04:00
|
|
|
|
2019-09-19 08:22:37 -04:00
|
|
|
include::indices/synced-flush.asciidoc[]
|
|
|
|
|
2019-10-01 17:07:28 -04:00
|
|
|
include::indices/types-exists.asciidoc[]
|
2013-08-28 19:24:34 -04:00
|
|
|
|
2019-10-01 17:07:28 -04:00
|
|
|
include::indices/apis/unfreeze.asciidoc[]
|
|
|
|
|
|
|
|
include::indices/aliases.asciidoc[]
|
2013-08-28 19:24:34 -04:00
|
|
|
|
2020-05-15 10:37:45 -04:00
|
|
|
include::indices/update-settings.asciidoc[]
|