feat(model): add hideIndexes option to syncIndexes() and cleanIndexes() #14987
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fix #14868
Summary
Add an option to make
syncIndexes()mark indexes as hidden (see MongoDB hidden indexes docs) as opposed to dropping them. Hidden indexes are useful because rebuilding an index can be expensive, so if you accidentally drop a index that you shouldn't it can take a while to recover. With hidden indexes, you can test whether removing this index will cause performance issues without actually dropping the index.syncIndexes({ hideIndex: true })will hide all non-schema indexes rather than dropping them.Hidden index support was added in MongoDB 4.4 so we should make a quick note about version compatibility, since Mongoose 8 technically supports all the way back to MongoDB 3.6.
Examples