Validate conditionally-required arguments at startup #82
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
Different databases require different arguments - for example:
pinecone requires that --pinecone_api_key and --pinecone_index_name are specified.
Currently this is not validated as part of parsing the command-line
options, and will only be detected later on when we attempt to
initialise the given database, which isn't necessarily clear to the
user.
Improve this by adding explicit checking that such
conditionally-required arguments are indeed specified, printing out a
relevent error message if any are omitted.
Also improve the general format and layout of options help; listing
--workload and --database (the two most important arguments) in their
own group.
daverigby
force-pushed
the
conditionally_required
branch
from
a649fb2 to
0b1b9f2
Compare
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.
Problem
Different databases require different arguments - for example:
Currently this is not validated as part of parsing the command-line
options, and will only be detected later on when we attempt to
initialise the given database, which isn't necessarily clear to the
user.
Solution
Improve this by adding explicit checking that such
conditionally-required arguments are indeed specified, printing out a
relevent error message if any are omitted.
Fixes #77.
Type of Change
Test Plan
Added test which verifies we check for the optional args correctly.