feat: implement query profiling #542
Merged
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
product-auto-label
bot
added
size: l
daniel-sanche
added
cla: yes
google-cla
bot
added
cla: no
daniel-sanche
commented
Aug 2, 2024
| raise QueryExplainError("explain_options not set on query.") | ||
| elif self._aggregation_query._explain_options.analyze is False: | ||
| # we need to run the query to get the explain_metrics | ||
| self._next_page() |
There was a problem hiding this comment.
Is this safe? (Are the results being returned later, or thrown out)
There was a problem hiding this comment.
We don't have any results when analyze=True, so this is safe. Added comment
21 tasks
daniel-sanche
added
cla: yes
google-cla
bot
added
cla: no
daniel-sanche
added
cla: yes
google-cla
bot
added
cla: no
daniel-sanche
added
cla: yes
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.
Added Query Profiling, support, for retrieving information about a query
Query Profiling is configured through the new ExplainOptions dataclass, which can be attached to a Query or AggregationQuery object at init time.
ExplainOptions has one argument:
analyze. When analyze is True, it runs the entire query, and returns a set of stats about the execution, and a set of "planning" data detailing the indexes used by the request. Ifanaluzeis False, only the planning data is returned, and the query is not executedFor usage details, see the new samples added as part of this PR