mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-02-06 04:58:50 +00:00
284c61ad19
* [DOCS] Refactored index-templates topic. * [DOCS] Add separate files. * [DOCS] Add delete component template. * Apply suggestions from code review Co-authored-by: James Rodewig <james.rodewig@elastic.co> * [DOCS] Incorporated review comments
192 lines
4.2 KiB
Plaintext
192 lines
4.2 KiB
Plaintext
[[indices]]
|
|
== Index APIs
|
|
|
|
Index APIs are used to manage individual indices,
|
|
index settings, aliases, mappings, and index templates.
|
|
|
|
[discrete]
|
|
[[index-management]]
|
|
=== Index management:
|
|
|
|
* <<indices-create-index>>
|
|
* <<indices-delete-index>>
|
|
* <<indices-get-index>>
|
|
* <<indices-exists>>
|
|
* <<indices-close>>
|
|
* <<indices-open-close>>
|
|
* <<indices-shrink-index>>
|
|
* <<indices-split-index>>
|
|
* <<indices-clone-index>>
|
|
* <<indices-rollover-index>>
|
|
* <<freeze-index-api>>
|
|
* <<unfreeze-index-api>>
|
|
* <<indices-resolve-index-api>>
|
|
|
|
|
|
[discrete]
|
|
[[mapping-management]]
|
|
=== Mapping management:
|
|
|
|
* <<indices-put-mapping>>
|
|
* <<indices-get-mapping>>
|
|
* <<indices-get-field-mapping>>
|
|
* <<indices-types-exists>>
|
|
|
|
[discrete]
|
|
[[alias-management]]
|
|
=== Alias management:
|
|
* <<indices-add-alias>>
|
|
* <<indices-delete-alias>>
|
|
* <<indices-get-alias>>
|
|
* <<indices-alias-exists>>
|
|
* <<indices-aliases>>
|
|
|
|
[discrete]
|
|
[[index-settings]]
|
|
=== Index settings:
|
|
* <<indices-update-settings>>
|
|
* <<indices-get-settings>>
|
|
* <<indices-analyze>>
|
|
|
|
[discrete]
|
|
[[index-templates-apis]]
|
|
=== Index templates:
|
|
|
|
Index templates automatically apply settings, mappings, and aliases to new indices.
|
|
They are most often used to configure rolling indices for time series data to
|
|
ensure that each new index has the same configuration as the previous one.
|
|
The index template associated with a data stream configures its backing indices.
|
|
For more information, see <<indices-templates, Index Templates>>.
|
|
|
|
* <<indices-put-template>>
|
|
* <<indices-get-template>>
|
|
* <<indices-delete-template>>
|
|
* <<indices-component-template>>
|
|
* <<getting-component-templates>>
|
|
* <<indices-delete-component-template>>
|
|
* <<indices-template-exists>>
|
|
* <<indices-simulate-index>>
|
|
* <<indices-simulate-template>>
|
|
|
|
[discrete]
|
|
[[monitoring]]
|
|
=== Monitoring:
|
|
* <<indices-stats>>
|
|
* <<indices-segments>>
|
|
* <<indices-recovery>>
|
|
* <<indices-shards-stores>>
|
|
|
|
[discrete]
|
|
[[status-management]]
|
|
=== Status management:
|
|
* <<indices-clearcache>>
|
|
* <<indices-refresh>>
|
|
* <<indices-flush>>
|
|
* <<indices-synced-flush-api>>
|
|
* <<indices-forcemerge>>
|
|
|
|
[discrete]
|
|
[[dangling-indices-api]]
|
|
=== Dangling indices:
|
|
* <<dangling-indices-list>>
|
|
* <<dangling-index-import>>
|
|
* <<dangling-index-delete>>
|
|
|
|
|
|
|
|
include::indices/add-alias.asciidoc[]
|
|
|
|
include::indices/analyze.asciidoc[]
|
|
|
|
include::indices/clearcache.asciidoc[]
|
|
|
|
include::indices/clone-index.asciidoc[]
|
|
|
|
include::indices/close.asciidoc[]
|
|
|
|
include::indices/create-index.asciidoc[]
|
|
|
|
include::indices/delete-index.asciidoc[]
|
|
|
|
include::indices/delete-alias.asciidoc[]
|
|
|
|
include::indices/delete-component-template.asciidoc[]
|
|
|
|
include::indices/delete-index-template.asciidoc[]
|
|
|
|
include::indices/flush.asciidoc[]
|
|
|
|
include::indices/forcemerge.asciidoc[]
|
|
|
|
include::indices/apis/freeze.asciidoc[]
|
|
|
|
include::indices/get-component-template.asciidoc[]
|
|
|
|
include::indices/get-field-mapping.asciidoc[]
|
|
|
|
include::indices/get-index.asciidoc[]
|
|
|
|
include::indices/get-alias.asciidoc[]
|
|
|
|
include::indices/get-settings.asciidoc[]
|
|
|
|
include::indices/get-index-template.asciidoc[]
|
|
|
|
include::indices/get-index-template-v1.asciidoc[]
|
|
|
|
include::indices/get-mapping.asciidoc[]
|
|
|
|
include::indices/alias-exists.asciidoc[]
|
|
|
|
include::indices/indices-exists.asciidoc[]
|
|
|
|
include::indices/recovery.asciidoc[]
|
|
|
|
include::indices/segments.asciidoc[]
|
|
|
|
include::indices/shard-stores.asciidoc[]
|
|
|
|
include::indices/stats.asciidoc[]
|
|
|
|
include::indices/template-exists.asciidoc[]
|
|
|
|
include::indices/open-close.asciidoc[]
|
|
|
|
include::indices/put-index-template.asciidoc[]
|
|
|
|
include::indices/put-index-template-v1.asciidoc[]
|
|
|
|
include::indices/put-component-template.asciidoc[]
|
|
|
|
include::indices/put-mapping.asciidoc[]
|
|
|
|
include::indices/refresh.asciidoc[]
|
|
|
|
include::indices/rollover-index.asciidoc[]
|
|
|
|
include::indices/shrink-index.asciidoc[]
|
|
|
|
include::indices/simulate-index.asciidoc[]
|
|
|
|
include::indices/simulate-template.asciidoc[]
|
|
|
|
include::indices/split-index.asciidoc[]
|
|
|
|
include::indices/synced-flush.asciidoc[]
|
|
|
|
include::indices/types-exists.asciidoc[]
|
|
|
|
include::indices/apis/unfreeze.asciidoc[]
|
|
|
|
include::indices/aliases.asciidoc[]
|
|
|
|
include::indices/update-settings.asciidoc[]
|
|
|
|
include::indices/resolve.asciidoc[]
|
|
|
|
include::indices/dangling-indices-list.asciidoc[]
|
|
|
|
include::indices/dangling-index-import.asciidoc[]
|
|
|
|
include::indices/dangling-index-delete.asciidoc[]
|