diff --git a/manage-data/data-store/index-basics.md b/manage-data/data-store/index-basics.md index aa7907d3ef..c47084d92d 100644 --- a/manage-data/data-store/index-basics.md +++ b/manage-data/data-store/index-basics.md @@ -70,9 +70,7 @@ Each index has a [mapping](/manage-data/data-store/mapping.md) or schema for how Elastic's **Index Management** features are an easy, convenient way to manage your cluster’s indices, [data streams](/manage-data/lifecycle/data-stream.md), [templates](/manage-data/data-store/templates.md), and [enrich policies](/manage-data/ingest/transform-enrich/data-enrichment.md). Practicing good index management ensures your data is stored correctly and in the most cost-effective way possible. -To use these features: - * On {{serverless-full}}, go to **Project settings** > **Management** > **Index Management**. - * On {{stack}}, go to **Stack Management** > **Index Management**. +To use these features, go to the **Index management** page using the navigation menu or the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md). ### Required permissions [index-mgm-req-permissions] ```{applies_to} @@ -102,14 +100,17 @@ Investigate your indices and perform operations from the **Indices** view. :screenshot: ::: -* Enable **Include hidden indices** to view the full set of indices, including backing indices for [data streams](/manage-data/data-store/data-streams.md). +* To access details and perform operations on indices: -* To show details and perform operations, click the index name. To perform operations on multiple indices, select their checkboxes and then open the **Manage** menu. For more information on managing indices, refer to [Index APIs](https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-indices). + * For a single index, click the index name to drill down into the index overview, [mappings](/manage-data/data-store/mapping.md), and [settings](elasticsearch://reference/elasticsearch/index-settings/index.md). From this view, you can navigate to **Discover** to further explore the documents in the index. -* To filter the list of indices, use the search bar or click a badge. Badges indicate if an index is a [follower index](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-follow), a [rollup index](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-rollup-get-rollup-index-caps), or [frozen](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-unfreeze). + * For multiple indices, select their checkboxes and then open the **Manage indices** menu. + + Refer to [Perform operations on indices](/manage-data/data-store/perform-index-operations.md) for details about the actions that you can run. -* To drill down into the index overivew, [mappings](/manage-data/data-store/mapping.md), and [settings](elasticsearch://reference/elasticsearch/index-settings/index.md), click an index name. From this view, you can navigate to **Discover** to further explore the documents in the index. +* Enable **Include hidden indices** to view the full set of indices, including backing indices for [data streams](/manage-data/data-store/data-streams.md). +* To filter the list of indices, use the search bar or click a badge. Badges indicate if an index is a [follower index](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-follow), a [rollup index](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-rollup-get-rollup-index-caps), or [frozen](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-unfreeze). :::: ::::{tab-item} {{stack}} @@ -120,21 +121,17 @@ Investigate your indices and perform operations from the **Indices** view. :screenshot: ::: -* Enable **Include hidden indices** to view the full set of indices, including backing indices for [data streams](/manage-data/data-store/data-streams.md). - -* To show details and perform operations such as close, forcemerge, and flush, click the index name. To perform operations on multiple indices, select their checkboxes and then open the **Manage** menu. For more information on managing indices, refer to [Index APIs](https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-indices). +* To access details and perform operations on indices: -* To filter the list of indices, use the search bar or click a badge. Badges indicate if an index is a [follower index](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-follow), a [rollup index](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-rollup-get-rollup-index-caps), or [frozen](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-unfreeze). + * For a single index, click the index name to drill down into the index overview, [mappings](/manage-data/data-store/mapping.md), [settings](elasticsearch://reference/elasticsearch/index-settings/index.md), and statistics. From this view, you can navigate to **Discover** to further explore the documents in the index, and you can perform operations using the **Manage index** menu. - You can also use the drop-down menus to filter the list by the [index lifecycle](/manage-data/lifecycle/index-lifecycle-management/index-lifecycle.md) status or phase. + * For multiple indices, select their checkboxes and then open the **Manage indices** menu. -* To drill down into the index [mappings](/manage-data/data-store/mapping.md), [settings](elasticsearch://reference/elasticsearch/index-settings/index.md), statistics, and lifecycle details, click an index name. From this view, you can navigate to **Discover** to further explore the documents in the index. + Refer to [Perform operations on indices](/manage-data/data-store/perform-index-operations.md) for details about the actions that you can run. - :::{image} /manage-data/images/elasticsearch-reference-management_index_details.png - :alt: Index Management UI - :screenshot: - ::: +* Enable **Include hidden indices** to view the full set of indices, including backing indices for [data streams](/manage-data/data-store/data-streams.md). +* To filter the list of indices, use the search bar or click a badge. Badges indicate if an index is a [follower index](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-follow), a [rollup index](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-rollup-get-rollup-index-caps), or [frozen](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-unfreeze). :::: ::::: diff --git a/manage-data/data-store/perform-index-operations.md b/manage-data/data-store/perform-index-operations.md new file mode 100644 index 0000000000..ed69b0eec0 --- /dev/null +++ b/manage-data/data-store/perform-index-operations.md @@ -0,0 +1,62 @@ +--- +applies_to: + stack: ga + serverless: ga +products: + - id: elasticsearch + - id: cloud-serverless +--- + +# Perform operations on indices + +You can perform a number of index operations from the **Index management** page in {{kib}}. + +To perform index actions: + +1. Go to the **Index management** page using the navigation menu or the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md). +1. Enable **Include hidden indices** to view the full set of indices, including backing indices for [data streams](/manage-data/data-store/data-streams.md). +1. Open the **Indices** view. +1. Click the index name, or to perform operations on multiple indices select their checkboxes and open the **Manage index** menu. + +## Available index operations + +Several index operations are available from the **Manage index** menu. Note that some of the operations listed are unavailable in {{serverless-full}} since in that environment many data management tasks are handled automatically. + +**Show index overview** {applies_to}`stack: ga` {applies_to}`serverless: ga` +: View an overview of the index, including its storage size, status, and aliases, as well as a sample API request to add new documents. + +**Show index settings** {applies_to}`stack: ga` {applies_to}`serverless: ga` +: View a list of the currently configured [index settings](elasticsearch://reference/elasticsearch/index-settings/index.md). Enable **Edit mode** to add or change settings. + +**Show index mapping** {applies_to}`stack: ga` {applies_to}`serverless: ga` +: View the [index mappings](/manage-data/data-store/mapping.md). From this page you can set up new mappings for the field types in your index. + +**Show index stats** {applies_to}`stack: ga` +: View statistics for your index. Statistics are compiled by `primaries`, representing values only for primary shards, and by `total`, representing accumulated values for both primary and replica shards. Refer to the [get index statistics](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-stats) API for details. + +**Close index** {applies_to}`stack: ga` +: Close the index so that read or write operations cannot be performed. Refer to the [close index](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-close) API for details. + +**Open index** {applies_to}`stack: ga` +: Reopen an index that is currently closed to read and write operations. This option is available only for indices that are currently closed. Refer to the [open index](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-open) API for details. + +**Force merge index** {applies_to}`stack: ga` +: Perform a force merge operation on the shards of the indices. This reduces the number of segments in each shard by merging some of them together and also frees up the space used by deleted documents. Refer to the [force merge](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-forcemerge) API for details. + +**Refresh index** {applies_to}`stack: ga` +: Refresh the index to make the most recent operations performed on the index available for search. Refer to the [refresh index](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-refresh) API for details. + +**Clear index cache** {applies_to}`stack: ga` +: Clear all of the caches for the index. Refer to the [clear cache](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-clear-cache) API for details. + +**Flush index** {applies_to}`stack: ga` +: Flush the index to ensure that all data currently stored only in the transaction log is stored permanently in the Lucene index. Refer to the [flush index](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-flush) API for details. + +**Delete index** {applies_to}`stack: ga` {applies_to}`serverless: ga` +: Delete an index including all of its documents, shards, and metadata. Refer to the [delete index](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete) API for details. + +**Add lifecycle policy** {applies_to}`stack: ga` +: Add a lifecycle policy to the index to manage how it transitions over time. The policy governs how the index moves through different phases (`hot`, `warm`, `cold`, `frozen`, and `delete`) and what actions, such as shrinking and downsampling, are performed on the index during each of these phases. Refer to [{{ilm-cap}}](/manage-data/lifecycle/index-lifecycle-management.md) to learn more. + +**Convert to lookup index** {applies_to}`stack: preview 9.2` {applies_to}`serverless: preview` +: Convert the index to a lookup mode index that can be used with [`LOOKUP JOIN`](elasticsearch://reference/query-languages/esql/commands/processing-commands.md#esql-lookup-join) commands, so that data from the index can be added to {{esql}} query results. This option is available only for single shard indices that have less than two billion documents. Refer to the {{es}} [`index.mode`](elasticsearch://reference/elasticsearch/index-settings/index-modules.md#index-mode-setting) index setting for details. diff --git a/manage-data/images/elasticsearch-reference-management_index_details.png b/manage-data/images/elasticsearch-reference-management_index_details.png deleted file mode 100644 index 1829510599..0000000000 Binary files a/manage-data/images/elasticsearch-reference-management_index_details.png and /dev/null differ diff --git a/manage-data/toc.yml b/manage-data/toc.yml index b88c4737b2..0038397bbb 100644 --- a/manage-data/toc.yml +++ b/manage-data/toc.yml @@ -4,6 +4,8 @@ toc: - file: data-store.md children: - file: data-store/index-basics.md + children: + - file: data-store/perform-index-operations.md - file: data-store/near-real-time-search.md - file: data-store/data-streams.md children: