Skip to content

Commit 6db1451

Browse files
authored
Add 'Perform index operations' page including 'convert to lookup' (#3383)
This PR: - Adds a swanky new [Perform operations on indices](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/3383/manage-data/data-store/perform-index-operations) page. - Includes at the bottom of that page the new "convert to lookup" option that @florent-leborgne documented so nicely in #3317. - Tidies up [Manage indices](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/3383/manage-data/data-store/index-basics#manage-indices) a wee bit. Closes: #3284
1 parent b6cc9c4 commit 6db1451

File tree

4 files changed

+78
-17
lines changed

4 files changed

+78
-17
lines changed

manage-data/data-store/index-basics.md

Lines changed: 14 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -70,9 +70,7 @@ Each index has a [mapping](/manage-data/data-store/mapping.md) or schema for how
7070

7171
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.
7272

73-
To use these features:
74-
* On {{serverless-full}}, go to **Project settings** > **Management** > **Index Management**.
75-
* On {{stack}}, go to **Stack Management** > **Index Management**.
73+
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).
7674

7775
### Required permissions [index-mgm-req-permissions]
7876
```{applies_to}
@@ -102,14 +100,17 @@ Investigate your indices and perform operations from the **Indices** view.
102100
:screenshot:
103101
:::
104102

105-
* Enable **Include hidden indices** to view the full set of indices, including backing indices for [data streams](/manage-data/data-store/data-streams.md).
103+
* To access details and perform operations on indices:
106104

107-
* 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).
105+
* 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.
108106

109-
* 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).
107+
* For multiple indices, select their checkboxes and then open the **Manage indices** menu.
108+
109+
Refer to [Perform operations on indices](/manage-data/data-store/perform-index-operations.md) for details about the actions that you can run.
110110

111-
* 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.
111+
* Enable **Include hidden indices** to view the full set of indices, including backing indices for [data streams](/manage-data/data-store/data-streams.md).
112112

113+
* 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).
113114
::::
114115

115116
::::{tab-item} {{stack}}
@@ -120,21 +121,17 @@ Investigate your indices and perform operations from the **Indices** view.
120121
:screenshot:
121122
:::
122123

123-
* Enable **Include hidden indices** to view the full set of indices, including backing indices for [data streams](/manage-data/data-store/data-streams.md).
124-
125-
* 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).
124+
* To access details and perform operations on indices:
126125

127-
* 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).
126+
* 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.
128127

129-
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.
128+
* For multiple indices, select their checkboxes and then open the **Manage indices** menu.
130129

131-
* 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.
130+
Refer to [Perform operations on indices](/manage-data/data-store/perform-index-operations.md) for details about the actions that you can run.
132131

133-
:::{image} /manage-data/images/elasticsearch-reference-management_index_details.png
134-
:alt: Index Management UI
135-
:screenshot:
136-
:::
132+
* Enable **Include hidden indices** to view the full set of indices, including backing indices for [data streams](/manage-data/data-store/data-streams.md).
137133

134+
* 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).
138135
::::
139136
:::::
140137

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
---
2+
applies_to:
3+
stack: ga
4+
serverless: ga
5+
products:
6+
- id: elasticsearch
7+
- id: cloud-serverless
8+
---
9+
10+
# Perform operations on indices
11+
12+
You can perform a number of index operations from the **Index management** page in {{kib}}.
13+
14+
To perform index actions:
15+
16+
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).
17+
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).
18+
1. Open the **Indices** view.
19+
1. Click the index name, or to perform operations on multiple indices select their checkboxes and open the **Manage index** menu.
20+
21+
## Available index operations
22+
23+
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.
24+
25+
**Show index overview** {applies_to}`stack: ga` {applies_to}`serverless: ga`
26+
: View an overview of the index, including its storage size, status, and aliases, as well as a sample API request to add new documents.
27+
28+
**Show index settings** {applies_to}`stack: ga` {applies_to}`serverless: ga`
29+
: View a list of the currently configured [index settings](elasticsearch://reference/elasticsearch/index-settings/index.md). Enable **Edit mode** to add or change settings.
30+
31+
**Show index mapping** {applies_to}`stack: ga` {applies_to}`serverless: ga`
32+
: 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.
33+
34+
**Show index stats** {applies_to}`stack: ga`
35+
: 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.
36+
37+
**Close index** {applies_to}`stack: ga`
38+
: 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.
39+
40+
**Open index** {applies_to}`stack: ga`
41+
: 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.
42+
43+
**Force merge index** {applies_to}`stack: ga`
44+
: 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.
45+
46+
**Refresh index** {applies_to}`stack: ga`
47+
: 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.
48+
49+
**Clear index cache** {applies_to}`stack: ga`
50+
: 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.
51+
52+
**Flush index** {applies_to}`stack: ga`
53+
: 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.
54+
55+
**Delete index** {applies_to}`stack: ga` {applies_to}`serverless: ga`
56+
: 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.
57+
58+
**Add lifecycle policy** {applies_to}`stack: ga`
59+
: 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.
60+
61+
**Convert to lookup index** {applies_to}`stack: preview 9.2` {applies_to}`serverless: preview`
62+
: 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.
Binary file not shown.

manage-data/toc.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ toc:
44
- file: data-store.md
55
children:
66
- file: data-store/index-basics.md
7+
children:
8+
- file: data-store/perform-index-operations.md
79
- file: data-store/near-real-time-search.md
810
- file: data-store/data-streams.md
911
children:

0 commit comments

Comments
 (0)