honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
OpenSearch/docs/reference/indices.asciidoc

149 lines
2.9 KiB
Plaintext
Raw Normal View History

Migrated documentation into the main repo
2013-08-28 19:24:34 -04:00
[[indices]]
[DOCS] Remove heading offsets for REST APIs (#44568) Several files in the REST APIs nav section are included using :leveloffset: tags. This increments headings (h2 -> h3, h3 -> h4, etc.) in those files and removes the :leveloffset: tags. Other supporting changes: * Alphabetizes top-level REST API nav items. * Change 'indices APIs' heading to 'index APIs.' * Changes 'Snapshot lifecycle management' heading to sentence case.
2019-07-19 14:35:36 -04:00
== Index APIs
Migrated documentation into the main repo
2013-08-28 19:24:34 -04:00
[DOCS] Move Elasticsearch APIs to REST APIs section. (#44238) (#44372) Moves the following API sections under the REST APIs navigations: - API Conventions - Document APIs - Search APIs - Index APIs (previously named Indices APIs) - cat APIs - Cluster APIs Other supporting changes: - Removes the previous index APIs page under REST APIs. Adds a redirect for the removed page. - Removes several [partintro] macros so the docs build correctly. - Changes anchors for pages that become sections of a parent page. - Adds several redirects for existing pages that become sections of a parent page. This commit re-applies changes from #44238. Changes from that PR were reverted due to broken links in several repos. This commit adds redirects for those broken links.
2019-07-17 08:49:22 -04:00
Index APIs are used to manage individual indices,
Remove warmers and the warmer API. Warmers are now barely useful and will be removed in 3.0. Note that this only removes the warmer API and query-based warmers. We still have warmers internally for eg. global ordinals. Close #15607
2015-12-22 11:08:35 -05:00
index settings, aliases, mappings, and index templates.
Migrated documentation into the main repo
2013-08-28 19:24:34 -04:00
[float]
Add more anchor links to documentation Related to #3679
2013-09-25 12:17:40 -04:00
[[index-management]]
[DOCS] Remove heading offsets for REST APIs (#44568) Several files in the REST APIs nav section are included using :leveloffset: tags. This increments headings (h2 -> h3, h3 -> h4, etc.) in those files and removes the :leveloffset: tags. Other supporting changes: * Alphabetizes top-level REST API nav items. * Change 'indices APIs' heading to 'index APIs.' * Changes 'Snapshot lifecycle management' heading to sentence case.
2019-07-19 14:35:36 -04:00
=== Index management:
Migrated documentation into the main repo
2013-08-28 19:24:34 -04:00
* <<indices-create-index>>
* <<indices-delete-index>>
Indices API: Added GET Index API Returns information about settings, aliases, warmers, and mappings. Basically returns the IndexMetadata. This new endpoint replaces the /{index}/_alias|_aliases|_mapping|_mappings|_settings|_warmer|_warmers and /_alias|_aliases|_mapping|_mappings|_settings|_warmer|_warmers endpoints whilst maintaining the same response formats. The only exception to this is on the /_alias|_aliases|_warmer|_warmers endpoint which will now return a section for 'aliases' or 'warmers' even if no aliases or warmers exist. This backwards compatibility change is documented in the reference docs. Closes #4069
2014-08-12 06:42:12 -04:00
* <<indices-get-index>>
Migrated documentation into the main repo
2013-08-28 19:24:34 -04:00
* <<indices-exists>>
[DOCS] Separate and reformat close index API docs (#45922)
2019-08-27 12:31:53 -04:00
* <<indices-close>>
Migrated documentation into the main repo
2013-08-28 19:24:34 -04:00
* <<indices-open-close>>
Add primitive to shrink an index into a single shard (#18270) This adds a low level primitive operations to shrink an existing index into a new index with a single shard. This primitive expects all shards of the source index to allocated on a single node. Once the target index is initializing on the shrink node it takes a snapshot of the source index shards and copies all files into the target indices data folder. An [optimization](https://issues.apache.org/jira/browse/LUCENE-7300) coming in Lucene 6.1 will also allow for optional constant time copy if hard-links are supported by the filesystem. All mappings are merged into the new indexes metadata once the snapshots have been taken on the merge node. To shrink an existing index all shards must be moved to a single node (one instance of each shard) and the index must be read-only: ```BASH $ curl -XPUT 'http://localhost:9200/logs/_settings' -d '{ "settings" : { "index.routing.allocation.require._name" : "shrink_node_name", "index.blocks.write" : true } } ``` once all shards are started on the shrink node. the new index can be created via: ```BASH $ curl -XPUT 'http://localhost:9200/logs/_shrink/logs_single_shard' -d '{ "settings" : { "index.codec" : "best_compression", "index.number_of_replicas" : 1 } }' ``` This API will perform all needed check before the new index is created and selects the shrink node based on the allocation of the source index. This call returns immediately, to monitor shrink progress the recovery API should be used since all copy operations are reflected in the recovery API with byte copy progress etc. The shrink operation does not modify the source index, if a shrink operation should be canceled or if the shrink failed, the target index can simply be deleted and all resources are released.
2016-05-31 04:41:44 -04:00
* <<indices-shrink-index>>
Add ability to split shards (#26931) This change adds a new `_split` API that allows to split indices into a new index with a power of two more shards that the source index. This API works alongside the `_shrink` API but doesn't require any shard relocation before indices can be split. The split operation is conceptually an inverse `_shrink` operation since we initialize the index with a _syntetic_ number of routing shards that are used for the consistent hashing at index time. Compared to indices created with earlier versions this might produce slightly different shard distributions but has no impact on the per-index backwards compatibility. For now, the user is required to prepare an index to be splittable by setting the `index.number_of_routing_shards` at index creation time. The setting allows the user to prepare the index to be splittable in factors of `index.number_of_routing_shards` ie. if the index is created with `index.number_of_routing_shards: 16` and `index.number_of_shards: 2` it can be split into `4, 8, 16` shards. This is an intermediate step until we can make this the default. This also allows us to safely backport this change to 6.x. The `_split` operation is implemented internally as a DeleteByQuery on the lucene level that is executed while the primary shards execute their initial recovery. Subsequent merges that are triggered due to this operation will not be executed immediately. All merges will be deferred unti the shards are started and will then be throttled accordingly. This change is intended for the 6.1 feature release but will not support pre-6.1 indices to be split unless these indices have been shrunk before. In that case these indices can be split backwards into their original number of shards.
2017-11-06 05:37:55 -05:00
* <<indices-split-index>>
Add Clone Index API (#44267) Adds an API to clone an index. This is similar to the index split and shrink APIs, just with the difference that the number of primary shards is kept the same. In case where the filesystem provides hard-linking capabilities, this is a very cheap operation. Indexing cloning can be done by running `POST my_source_index/_clone/my_target_index` and it supports the same options as the split and shrink APIs. Closes #44128
2019-07-25 14:17:51 -04:00
* <<indices-clone-index>>
add documentation
2016-06-08 18:32:22 -04:00
* <<indices-rollover-index>>
[DOCS] Move Elasticsearch APIs to REST APIs section. (#44238) (#44372) Moves the following API sections under the REST APIs navigations: - API Conventions - Document APIs - Search APIs - Index APIs (previously named Indices APIs) - cat APIs - Cluster APIs Other supporting changes: - Removes the previous index APIs page under REST APIs. Adds a redirect for the removed page. - Removes several [partintro] macros so the docs build correctly. - Changes anchors for pages that become sections of a parent page. - Adds several redirects for existing pages that become sections of a parent page. This commit re-applies changes from #44238. Changes from that PR were reverted due to broken links in several repos. This commit adds redirects for those broken links.
2019-07-17 08:49:22 -04:00
* <<freeze-index-api>>
* <<unfreeze-index-api>>
Migrated documentation into the main repo
2013-08-28 19:24:34 -04:00
[float]
Add more anchor links to documentation Related to #3679
2013-09-25 12:17:40 -04:00
[[mapping-management]]
[DOCS] Remove heading offsets for REST APIs (#44568) Several files in the REST APIs nav section are included using :leveloffset: tags. This increments headings (h2 -> h3, h3 -> h4, etc.) in those files and removes the :leveloffset: tags. Other supporting changes: * Alphabetizes top-level REST API nav items. * Change 'indices APIs' heading to 'index APIs.' * Changes 'Snapshot lifecycle management' heading to sentence case.
2019-07-19 14:35:36 -04:00
=== Mapping management:
Migrated documentation into the main repo
2013-08-28 19:24:34 -04:00
* <<indices-put-mapping>>
Add a GetFieldMapping API This new API allows to get the mapping for a specific set of fields rather than get the whole index mapping and traverse it. The fields to be retrieved can be specified by their full path, index name and field name and will be resolved in this order. In case multiple field match, the first one will be returned. Since we are now generating the output (rather then fall back to the stored mapping), you can specify `include_defaults`=true on the request to have default values returned. Closes #3941
2013-10-14 02:53:07 -04:00
* <<indices-get-mapping>>
* <<indices-get-field-mapping>>
Migrated documentation into the main repo
2013-08-28 19:24:34 -04:00
* <<indices-types-exists>>
[float]
Add more anchor links to documentation Related to #3679
2013-09-25 12:17:40 -04:00
[[alias-management]]
[DOCS] Remove heading offsets for REST APIs (#44568) Several files in the REST APIs nav section are included using :leveloffset: tags. This increments headings (h2 -> h3, h3 -> h4, etc.) in those files and removes the :leveloffset: tags. Other supporting changes: * Alphabetizes top-level REST API nav items. * Change 'indices APIs' heading to 'index APIs.' * Changes 'Snapshot lifecycle management' heading to sentence case.
2019-07-19 14:35:36 -04:00
=== Alias management:
[DOCS] Separate add index alias API docs (#46086)
2019-08-29 10:38:48 -04:00
* <<indices-add-alias>>
[DOCS] Add delete index alias API docs (#46080)
2019-09-03 09:10:46 -04:00
* <<indices-delete-alias>>
[DOCS] Add get index alias API docs (#46046)
2019-08-29 09:44:58 -04:00
* <<indices-get-alias>>
[DOCS] Add index alias exists API docs (#46042)
2019-08-28 08:58:09 -04:00
* <<indices-alias-exists>>
Migrated documentation into the main repo
2013-08-28 19:24:34 -04:00
* <<indices-aliases>>
[float]
Add more anchor links to documentation Related to #3679
2013-09-25 12:17:40 -04:00
[[index-settings]]
[DOCS] Remove heading offsets for REST APIs (#44568) Several files in the REST APIs nav section are included using :leveloffset: tags. This increments headings (h2 -> h3, h3 -> h4, etc.) in those files and removes the :leveloffset: tags. Other supporting changes: * Alphabetizes top-level REST API nav items. * Change 'indices APIs' heading to 'index APIs.' * Changes 'Snapshot lifecycle management' heading to sentence case.
2019-07-19 14:35:36 -04:00
=== Index settings:
Migrated documentation into the main repo
2013-08-28 19:24:34 -04:00
* <<indices-update-settings>>
* <<indices-get-settings>>
* <<indices-analyze>>
[DOCS] Add "index template exists" API docs (#46095)
2019-08-29 13:18:47 -04:00
[float]
[[index-templates]]
=== Index templates:
[DOCS] Reformat "put index template" API docs (#46297)
2019-09-04 11:47:32 -04:00
* <<indices-templates>>
[DOCS] Add "delete index template" API docs (#46101)
2019-08-29 14:37:47 -04:00
* <<indices-delete-template>>
[DOCS] Add "get index template" API docs (#46296)
2019-09-04 10:58:24 -04:00
* <<indices-get-template>>
[DOCS] Add "index template exists" API docs (#46095)
2019-08-29 13:18:47 -04:00
* <<indices-template-exists>>
Migrated documentation into the main repo
2013-08-28 19:24:34 -04:00
[float]
Add more anchor links to documentation Related to #3679
2013-09-25 12:17:40 -04:00
[[monitoring]]
[DOCS] Remove heading offsets for REST APIs (#44568) Several files in the REST APIs nav section are included using :leveloffset: tags. This increments headings (h2 -> h3, h3 -> h4, etc.) in those files and removes the :leveloffset: tags. Other supporting changes: * Alphabetizes top-level REST API nav items. * Change 'indices APIs' heading to 'index APIs.' * Changes 'Snapshot lifecycle management' heading to sentence case.
2019-07-19 14:35:36 -04:00
=== Monitoring:
Migrated documentation into the main repo
2013-08-28 19:24:34 -04:00
* <<indices-stats>>
* <<indices-segments>>
Recovery API Adds a new API endpoint at /_recovery as well as to the Java API. The recovery API allows one to see the recovery status of all shards in the cluster. It will report on percent complete, recovery type, and which files are copied. Closes #4637
2014-02-18 17:28:49 -05:00
* <<indices-recovery>>
Docs: Indices shards stores page wasn't included in the indices APIs
2015-07-18 06:03:59 -04:00
* <<indices-shards-stores>>
Migrated documentation into the main repo
2013-08-28 19:24:34 -04:00
[float]
Add more anchor links to documentation Related to #3679
2013-09-25 12:17:40 -04:00
[[status-management]]
[DOCS] Remove heading offsets for REST APIs (#44568) Several files in the REST APIs nav section are included using :leveloffset: tags. This increments headings (h2 -> h3, h3 -> h4, etc.) in those files and removes the :leveloffset: tags. Other supporting changes: * Alphabetizes top-level REST API nav items. * Change 'indices APIs' heading to 'index APIs.' * Changes 'Snapshot lifecycle management' heading to sentence case.
2019-07-19 14:35:36 -04:00
=== Status management:
Migrated documentation into the main repo
2013-08-28 19:24:34 -04:00
* <<indices-clearcache>>
* <<indices-refresh>>
* <<indices-flush>>
[DOCS] Separate and reformat synced flush API docs (#46634) (#46839)
2019-09-19 08:22:37 -04:00
* <<indices-synced-flush-api>>
Add Force Merge API, deprecate Optimize API This adds an API for force merging lucene segments. The `/_optimize` API is now deprecated and replaced by the `/_forcemerge` API, which has all the same flags and action, just a different name.
2015-09-17 16:36:25 -04:00
* <<indices-forcemerge>>
Migrated documentation into the main repo
2013-08-28 19:24:34 -04:00
include::indices/create-index.asciidoc[]
include::indices/delete-index.asciidoc[]
Indices API: Added GET Index API Returns information about settings, aliases, warmers, and mappings. Basically returns the IndexMetadata. This new endpoint replaces the /{index}/_alias|_aliases|_mapping|_mappings|_settings|_warmer|_warmers and /_alias|_aliases|_mapping|_mappings|_settings|_warmer|_warmers endpoints whilst maintaining the same response formats. The only exception to this is on the /_alias|_aliases|_warmer|_warmers endpoint which will now return a section for 'aliases' or 'warmers' even if no aliases or warmers exist. This backwards compatibility change is documented in the reference docs. Closes #4069
2014-08-12 06:42:12 -04:00
include::indices/get-index.asciidoc[]
Migrated documentation into the main repo
2013-08-28 19:24:34 -04:00
include::indices/indices-exists.asciidoc[]
[DOCS] Separate and reformat close index API docs (#45922)
2019-08-27 12:31:53 -04:00
include::indices/close.asciidoc[]
Migrated documentation into the main repo
2013-08-28 19:24:34 -04:00
include::indices/open-close.asciidoc[]
Include shrink-index.asciidoc
2016-05-31 05:50:50 -04:00
include::indices/shrink-index.asciidoc[]
add split index reference in indices.asciidoc Relates to #26931
2017-11-06 06:55:41 -05:00
include::indices/split-index.asciidoc[]
Add Clone Index API (#44267) Adds an API to clone an index. This is similar to the index split and shrink APIs, just with the difference that the number of primary shards is kept the same. In case where the filesystem provides hard-linking capabilities, this is a very cheap operation. Indexing cloning can be done by running `POST my_source_index/_clone/my_target_index` and it supports the same options as the split and shrink APIs. Closes #44128
2019-07-25 14:17:51 -04:00
include::indices/clone-index.asciidoc[]
[DOCS] fix missing rollover-index link
2016-06-17 12:14:45 -04:00
include::indices/rollover-index.asciidoc[]
[DOCS] Move Elasticsearch APIs to REST APIs section. (#44238) (#44372) Moves the following API sections under the REST APIs navigations: - API Conventions - Document APIs - Search APIs - Index APIs (previously named Indices APIs) - cat APIs - Cluster APIs Other supporting changes: - Removes the previous index APIs page under REST APIs. Adds a redirect for the removed page. - Removes several [partintro] macros so the docs build correctly. - Changes anchors for pages that become sections of a parent page. - Adds several redirects for existing pages that become sections of a parent page. This commit re-applies changes from #44238. Changes from that PR were reverted due to broken links in several repos. This commit adds redirects for those broken links.
2019-07-17 08:49:22 -04:00
include::indices/apis/freeze.asciidoc[]
include::indices/apis/unfreeze.asciidoc[]
Migrated documentation into the main repo
2013-08-28 19:24:34 -04:00
include::indices/put-mapping.asciidoc[]
include::indices/get-mapping.asciidoc[]
Add a GetFieldMapping API This new API allows to get the mapping for a specific set of fields rather than get the whole index mapping and traverse it. The fields to be retrieved can be specified by their full path, index name and field name and will be resolved in this order. In case multiple field match, the first one will be returned. Since we are now generating the output (rather then fall back to the stored mapping), you can specify `include_defaults`=true on the request to have default values returned. Closes #3941
2013-10-14 02:53:07 -04:00
include::indices/get-field-mapping.asciidoc[]
Migrated documentation into the main repo
2013-08-28 19:24:34 -04:00
include::indices/types-exists.asciidoc[]
[DOCS] Separate add index alias API docs (#46086)
2019-08-29 10:38:48 -04:00
include::indices/add-alias.asciidoc[]
[DOCS] Add delete index alias API docs (#46080)
2019-09-03 09:10:46 -04:00
include::indices/delete-alias.asciidoc[]
[DOCS] Add get index alias API docs (#46046)
2019-08-29 09:44:58 -04:00
include::indices/get-alias.asciidoc[]
[DOCS] Add index alias exists API docs (#46042)
2019-08-28 08:58:09 -04:00
include::indices/alias-exists.asciidoc[]
Migrated documentation into the main repo
2013-08-28 19:24:34 -04:00
include::indices/aliases.asciidoc[]
include::indices/update-settings.asciidoc[]
include::indices/get-settings.asciidoc[]
include::indices/analyze.asciidoc[]
[DOCS] Reformat "put index template" API docs (#46297)
2019-09-04 11:47:32 -04:00
include::indices/templates.asciidoc[]
[DOCS] Add "delete index template" API docs (#46101)
2019-08-29 14:37:47 -04:00
include::indices/delete-index-template.asciidoc[]
[DOCS] Add "get index template" API docs (#46296)
2019-09-04 10:58:24 -04:00
include::indices/get-index-template.asciidoc[]
[DOCS] Add "index template exists" API docs (#46095)
2019-08-29 13:18:47 -04:00
include::indices/template-exists.asciidoc[]
Migrated documentation into the main repo
2013-08-28 19:24:34 -04:00
include::indices/stats.asciidoc[]
include::indices/segments.asciidoc[]
Recovery API Adds a new API endpoint at /_recovery as well as to the Java API. The recovery API allows one to see the recovery status of all shards in the cluster. It will report on percent complete, recovery type, and which files are copied. Closes #4637
2014-02-18 17:28:49 -05:00
include::indices/recovery.asciidoc[]
Docs: Incorrect file name for shard stores
2015-07-18 06:08:46 -04:00
include::indices/shard-stores.asciidoc[]
Docs: Indices shards stores page wasn't included in the indices APIs
2015-07-18 06:03:59 -04:00
Migrated documentation into the main repo
2013-08-28 19:24:34 -04:00
include::indices/clearcache.asciidoc[]
include::indices/flush.asciidoc[]
[DOCS] Separate and reformat synced flush API docs (#46634) (#46839)
2019-09-19 08:22:37 -04:00
include::indices/synced-flush.asciidoc[]
Migrated documentation into the main repo
2013-08-28 19:24:34 -04:00
include::indices/refresh.asciidoc[]
Add Force Merge API, deprecate Optimize API This adds an API for force merging lucene segments. The `/_optimize` API is now deprecated and replaced by the `/_forcemerge` API, which has all the same flags and action, just a different name.
2015-09-17 16:36:25 -04:00
include::indices/forcemerge.asciidoc[]
Migrated documentation into the main repo
2013-08-28 19:24:34 -04:00