feat(shell-api): search index management helpers MONGOSH-1455 MONGOSH-1456 #1477
Conversation
This file contains hidden or 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
lerouxb
changed the title
addaleax
reviewed
Jun 2, 2023
lerouxb
force-pushed
the
search-index-helpers
branch
from
ad2d2e5 to
588f9a8
Compare
lerouxb
force-pushed
the
search-index-helpers
branch
from
588f9a8 to
de6038f
Compare
addaleax
reviewed
Jun 2, 2023
| @serverVersions(['6.0.0', ServerVersions.latest]) | ||
| @returnsPromise | ||
| @apiVersions([]) | ||
| async createSearchIndexes(descriptions: any[]): Promise<string[]> { |
There was a problem hiding this comment.
Suggested change
| async createSearchIndexes(descriptions: any[]): Promise<string[]> { | |
| async createSearchIndexes(descriptions: Document[]): Promise<string[]> { |
There was a problem hiding this comment.
I had it as Document, but then deliberately changed it to any because it felt like that's more likely to stand out as something we have to type properly once we can.
There was a problem hiding this comment.
We’re using Document quite extensively here in the shell-api package, and that’s probably a good thing, because these methods are user-facing and it’s not like we could tell the user to really always give us input that exactly matches the driver types
addaleax
approved these changes
Jun 2, 2023
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.
I added getSearchIndexes() which, like getIndexes() returns an array. I made the service provider method listSearchIndexes which returns the cursor. So we could add easily add listSearchIndexes() later that returns the cursor if we want to. ie. by convention get could return an array and list could return a cursor. We'd probably want to do the same for normal indexes if we go that route, though.