Skip to content

Commit dd1b5d7

Browse files
authored
DOCSP-30810 Hide Indexes in Compass GUI (#523)
* DOCSP-30810 Hide Indexes in Compass GUI * fix link * JA feedback * wording * copy fixes
1 parent 050c550 commit dd1b5d7

File tree

2 files changed

+32
-1
lines changed

2 files changed

+32
-1
lines changed

source/includes/extracts-readonly-not-permitted.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ inherit:
1717
ref: _readonly-not-permitted-base
1818
file: extracts-readonly-not-permitted-base.yaml
1919
replacement:
20-
phrase: Creating and dropping indexes
20+
phrase: Creating, hiding, and dropping indexes
2121
---
2222
ref: readonly-not-permitted-documents
2323
inherit:

source/indexes.txt

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -116,6 +116,37 @@ input.
116116
|compass-short| shows the type of your new index as
117117
:guilabel:`Wildcard`.
118118

119+
.. _hide-index:
120+
121+
Hide or Unhide an Index
122+
-----------------------
123+
124+
You can :manual:`hide an index </core/index-hidden>` from the query planner to
125+
evaluate the potential impact of dropping an index without actually dropping the
126+
index.
127+
128+
.. procedure::
129+
:style: normal
130+
131+
.. step:: Hover over the index.
132+
133+
From the :guilabel:`Indexes` tab, hover over the index you want to hide.
134+
135+
.. step:: Click the :guilabel:`Hide Index` button.
136+
137+
Click the closed-eye icon on the right that appears when you hover over
138+
your selected index.
139+
140+
.. step:: Click :guilabel:`Confirm`.
141+
142+
In the dialog box, confirm the index you want to hide. After you confirm
143+
your selection, a :guilabel:`Hidden` badge appears under the
144+
:guilabel:`Properties` column.
145+
146+
To unhide your index, repeat steps 1-3. After you unhide your index,
147+
|compass-short| removes the :guilabel:`Hidden` badge from the
148+
:guilabel:`Properties` column.
149+
119150
.. _drop-index:
120151

121152
Drop an Index

0 commit comments

Comments
 (0)