-
Notifications
You must be signed in to change notification settings - Fork 20
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
SceneQueryRunner: Manual control over query execution #334
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
This would be a useful feature to have for the scene query runner 👍 . |
…ription in runQueries for non-auto query runners
gtk-grafana
added
minor
Increment the minor version when merged
release
Create a release when this pr is merged
usecase/app-plugins
Needed for scene app plugins
labels
Aug 15, 2024
@torkelo I can't assign the review to you as you created the original PR, but if you can take a look I'd appreciate it! |
torkelo
commented
Aug 15, 2024
Looks good , now just needs a review approval |
matyax
approved these changes
Aug 16, 2024
🚀 PR was released in |
This was referenced Aug 19, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
minor
Increment the minor version when merged
release
Create a release when this pr is merged
released
usecase/app-plugins
Needed for scene app plugins
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.
This PR adds a new prop
runQueriesMode
to QueryRunnerState.The default value is "auto": which should not change query runner behavior.
Setting runQueriesMode to "manual", will:
TL;DR: When setting runQueriesMode is set to manual, queries must be executed via
runQueries
.The only exception is when
maxDataPointsFromWidth
is also set, then the query will be run when the container width changes.If folks want more control we could follow up this PR with more options to the
runQueriesMode
, e.g. only automatically firing queries when variables are updated, or on activate, etc, but for now the new mode provides an option for users that need more control over when queries are run.📦 Published PR as canary version:
5.9.0--canary.334.10407764115.0
✨ Test out this PR locally via:
npm install @grafana/scenes-react@5.9.0--canary.334.10407764115.0 npm install @grafana/scenes@5.9.0--canary.334.10407764115.0 # or yarn add @grafana/scenes-react@5.9.0--canary.334.10407764115.0 yarn add @grafana/scenes@5.9.0--canary.334.10407764115.0