Added ThrowOnQueryWarning option #205
Open
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.
CouchDB has the handy ability to return warnings on mango queries. Most often it is a notification that the query could not find a suitable index, which of course is terrible for performance. However it is easy to miss this valuable information.
This patch adds a "Warning" property to FindResult and also the option to throw an exception if there a warning present on the FindResult.
This needs to be explicitly enabled by using ThrowOnQueryWarning() on the OptionsBuilder so it does not impact any existing code.
My personal intention for this feature it to enable it only in development so that if any of my tests cause a query that generates a warning then the test will fail and I can correct the problem (mostly likely by adding an appropriate index) before the issue makes it to production.
Could also be used in production if you are careful to catch the exception and do something with it, presumably log it somewhere that someone will actually see it.