[COMPASS-6458] Support "Hide" indexes in the GUI Created: 25/Jan/23  Updated: 20/Jun/23  Resolved: 20/Jun/23

Status: Closed
Project: Compass
Component/s: UI / UX
Affects Version/s: None
Fix Version/s: 1.38.0

Type: Task Priority: Major - P3
Reporter: Claudia De Angelis Assignee: Himanshu Singh
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Depends
Documented
Epic Link: COMPASS-6441
Story Points: 3
Documentation Changes: Needed
Documentation Changes Summary:

In this PR we added a small feature in our Indexes tab to hide and unhide indexes. This feature earlier was accessed through in-built shell / mongosh using command `db.collection.hideIndex()` and `db.collection.unhideIndex()`. The feature requires a minimum server version 4.4.0. It can be accessed by connecting to a supported mongodb deployment, navigating to Indexes tab and hovering over an index that needs to hidden/unhidden. On hover, there will be an icon button with a closed eye icon (if index is not hidden) or an open eye icon (if the index is hidden). Users can use this icon button to hide/unhide their indexes. Additionally if an index is hidden we also add a hidden badge to index properties column in the indexes table.

In the Compass's Manage Indexes (https://www.mongodb.com/docs/compass/current/indexes/) page, we will need to add a section about this feature.

Sprint: Iteration Dreadnoughtus

 Description   

At the moment users can Hide indexes from the embedded shell: db.collection.hideIndex(<index>)

But there is no representation in the GUI.

We can do: 

  1. add a badge (HIDDEN) in the properties column to state that the index is hidden.
  2. provide a way to hide indexes directly from the UI e.g and option close to the delete 


 Comments   
Comment by Githook User [ 19/Jun/23 ]

Author:

{'name': 'Himanshu Singh', 'email': 'himanshu.singhs@outlook.in', 'username': 'himanshusinghs'}

Message: Merge branch 'main' into COMPASS-6458-support-for-hidden-indexes
Branch: COMPASS-6458-support-for-hidden-indexes
https://github.com/mongodb-js/compass/commit/0830904047ba8cc4a2f407e9a51a3d74d33e0811

Comment by Githook User [ 16/Jun/23 ]

Author:

{'name': 'Himanshu Singh', 'email': 'himanshu.singhs@outlook.in', 'username': 'himanshusinghs'}

Message: Merge branch 'COMPASS-6458-support-for-hidden-indexes' of github.com:mongodb-js/compass into COMPASS-6458-support-for-hidden-indexes
Branch: COMPASS-6458-support-for-hidden-indexes
https://github.com/mongodb-js/compass/commit/caf0aff33b3c9a45a957f7f44488cbe9e89fbeac

Generated at Wed Feb 07 22:43:10 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.