[COMPASS-5666] Support the creation of Clustered Collections Created: 04/Apr/22  Updated: 25/Apr/22  Resolved: 25/Apr/22

Status: Closed
Project: Compass
Component/s: Compass
Affects Version/s: None
Fix Version/s: 1.31.3

Type: New Feature Priority: Major - P3
Reporter: Le Roux Bodenstein Assignee: Le Roux Bodenstein
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Documented
Gantt Dependency
Related
related to MONGOSH-1172 Support creating collections with clu... Closed
related to VSCODE-330 Include the clusteredIndex option in ... Closed
related to COMPASS-5765 Add "Collection Created" telemetry event Closed
Epic Link: COMPASS-5479
Story Points: 5
Documentation Changes: Needed
Documentation Changes Summary:

We'll need the clustered index documentation so we can link to it from the clustered index type in the list just like for other indexes.

ie. something like one of these:

SINGLE: 'https://docs.mongodb.org/manual/core/index-single/',
COMPOUND: 'https://docs.mongodb.org/manual/core/index-compound/',
UNIQUE: 'https://docs.mongodb.org/manual/core/index-unique/',
BACKGROUND:
'https://docs.mongodb.com/manual/core/index-creation/#index-creation-background',
PARTIAL: 'https://docs.mongodb.org/manual/core/index-partial/',
SPARSE: 'https://docs.mongodb.org/manual/core/index-sparse/',
TTL: 'https://docs.mongodb.org/manual/core/index-ttl/',
'2D': 'https://docs.mongodb.org/manual/core/2d/',
'2DSPHERE': 'https://docs.mongodb.org/manual/core/2dsphere/',
GEOHAYSTACK: 'https://docs.mongodb.org/manual/core/geohaystack/',
GEOSPATIAL:
'https://docs.mongodb.org/manual/applications/geospatial-indexes/#geospatial-indexes',
WILDCARD: 'https://docs.mongodb.com/manual/core/index-wildcard/',
// TODO: add an entry for CLUSTERED once the docs become available
// see https://jira.mongodb.org/browse/COMPASS-5760
TEXT: 'https://docs.mongodb.org/manual/core/index-text/',
HASHED: 'https://docs.mongodb.org/manual/core/index-hashed/',

------

We need clustered indexes to be documented in current so we can remove the 5.3 from the URL:

// TODO: change this link to remove v5.3 once clustered-collections is in current
// see https://jira.mongodb.org/browse/COMPASS-5760
const HELP_URL_CLUSTERED = 'https://www.mongodb.com/docs/v5.3/core/clustered-collections/';

------

Not sure if we have documentation for compass itself somewhere, but from mongodb server 5.3 onwards and for now if the COMPASS_CLUSTERED_COLLECTIONS env var is set to true, the add collection modal has a new option for adding clustered collections.

Sprint: Iteration Yonkers, Iteration Zanzibar

 Description   

When connected to Compass 6.0+,

 

  • the experience of creating collections with clustered indexes will be similar to the creation of Time Series collections, i.e. users will be able to specify the clusteredIndex options;
  • Clustered Collections will be visually identifiable in the sidebar, in the list of collections and in the collection view similarly to what we do with Time Series Collections
  • Clustered Indexes will be visually identifiable under the Index tab
  • add "Collection Created" telemetry event to track when collections are created from Compass and in particular when they have interesting properties like having a clustered index, being a time-series, etc.

 

So basically:

In the create collection modal, add a new checkbox for Clustered. Put the pill in the sidbar and list collections screen. Hilight the indexes (which unlike the ones for timeseries won't be hidden), add telemetry.

See scope https://docs.google.com/document/d/1r_1BBIlfELnKBz5qAzzLDUB-BJfGrQKTS2TNHXu4DRg/edit#heading=h.b1os3ai9s8t3



 Comments   
Comment by Githook User [ 25/Apr/22 ]

Author:

{'name': 'Le Roux Bodenstein', 'email': 'lerouxb@gmail.com', 'username': 'lerouxb'}

Message: feat(collections): Highlight clustered collections index type COMPASS-5666 (#3013)

  • clustered index type
  • add clustered
Comment by Githook User [ 25/Apr/22 ]

Author:

{'name': 'Le Roux Bodenstein', 'email': 'lerouxb@gmail.com', 'username': 'lerouxb'}

Message: feat(collections): Clustered collections COMPASS-5666 (#2966)
Branch: 1.31-releases
https://github.com/mongodb-js/compass/commit/bc5aaf452cc0c25fb7f915946a3bfaf5bc20a473

Comment by Githook User [ 25/Apr/22 ]

Author:

{'name': 'Le Roux Bodenstein', 'email': 'lerouxb@gmail.com', 'username': 'lerouxb'}

Message: feat(collections): Highlight clustered collections index type COMPASS-5666 (#3013)

  • clustered index type
  • add clustered
Comment by Githook User [ 25/Apr/22 ]

Author:

{'name': 'Le Roux Bodenstein', 'email': 'lerouxb@gmail.com', 'username': 'lerouxb'}

Message: feat(collections): Highlight clustered collections index type COMPASS-5666 (#3013)

  • clustered index type
  • add clustered
Comment by Githook User [ 25/Apr/22 ]

Author:

{'name': 'Le Roux Bodenstein', 'email': 'lerouxb@gmail.com', 'username': 'lerouxb'}

Message: feat(collections): Highlight clustered collections index type COMPASS-5666 (#3013)

  • clustered index type
  • add clustered
Comment by Githook User [ 25/Apr/22 ]

Author:

{'name': 'Le Roux Bodenstein', 'email': 'lerouxb@gmail.com', 'username': 'lerouxb'}

Message: feat(collections): Clustered collections COMPASS-5666 (#2966)
Branch: remove-bugsnag
https://github.com/mongodb-js/compass/commit/bc5aaf452cc0c25fb7f915946a3bfaf5bc20a473

Comment by Githook User [ 23/Apr/22 ]

Author:

{'name': 'Le Roux Bodenstein', 'email': 'lerouxb@gmail.com', 'username': 'lerouxb'}

Message: feat(collections): Highlight clustered collections index type COMPASS-5666 (#3013)

  • clustered index type
  • add clustered
Comment by Githook User [ 22/Apr/22 ]

Author:

{'name': 'Le Roux Bodenstein', 'email': 'lerouxb@gmail.com', 'username': 'lerouxb'}

Message: feat(collections): Highlight clustered collections index type COMPASS-5666 (#3013)

  • clustered index type
  • add clustered
Comment by Githook User [ 22/Apr/22 ]

Author:

{'name': 'Le Roux Bodenstein', 'email': 'lerouxb@gmail.com', 'username': 'lerouxb'}

Message: feat(collections): Highlight clustered collections index type COMPASS-5666 (#3013)

  • clustered index type
  • add clustered
Comment by Githook User [ 22/Apr/22 ]

Author:

{'name': 'Le Roux Bodenstein', 'email': 'lerouxb@gmail.com', 'username': 'lerouxb'}

Message: feat(collections): Highlight clustered collections index type COMPASS-5666 (#3013)

  • clustered index type
  • add clustered
Comment by Githook User [ 22/Apr/22 ]

Author:

{'name': 'Le Roux Bodenstein', 'email': 'lerouxb@gmail.com', 'username': 'lerouxb'}

Message: feat(collections): Clustered collections COMPASS-5666 (#2966)
Branch: COMPASS-5757-hide-add-stage-button
https://github.com/mongodb-js/compass/commit/bc5aaf452cc0c25fb7f915946a3bfaf5bc20a473

Comment by Githook User [ 21/Apr/22 ]

Author:

{'name': 'Le Roux Bodenstein', 'email': 'lerouxb@gmail.com', 'username': 'lerouxb'}

Message: feat(collections): Clustered collections COMPASS-5666 (#2966)
Branch: COMPASS-5519-update-collection-header-styles
https://github.com/mongodb-js/compass/commit/bc5aaf452cc0c25fb7f915946a3bfaf5bc20a473

Comment by Githook User [ 21/Apr/22 ]

Author:

{'name': 'Le Roux Bodenstein', 'email': 'lerouxb@gmail.com', 'username': 'lerouxb'}

Message: feat(collections): Clustered collections COMPASS-5666 (#2966)
Branch: data-service-interface
https://github.com/mongodb-js/compass/commit/bc5aaf452cc0c25fb7f915946a3bfaf5bc20a473

Comment by Githook User [ 21/Apr/22 ]

Author:

{'name': 'Le Roux Bodenstein', 'email': 'lerouxb@gmail.com', 'username': 'lerouxb'}

Message: feat(collections): Clustered collections COMPASS-5666 (#2966)
Branch: main
https://github.com/mongodb-js/compass/commit/bc5aaf452cc0c25fb7f915946a3bfaf5bc20a473

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