Skip to content
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
merged 6 commits into from
Aug 16, 2024

Conversation

torkelo
Copy link
Member

@torkelo torkelo commented Sep 14, 2023

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:

  • Not fire queries on activate
  • Not fire queries on time range update
  • Not fire queries on variable updates (including adhoc/group by variables)

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

@andyfleming-shopify
Copy link

This would be a useful feature to have for the scene query runner 👍 .

@gtk-grafana gtk-grafana reopened this Aug 15, 2024
@gtk-grafana gtk-grafana self-assigned this Aug 15, 2024
@gtk-grafana 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
@gtk-grafana gtk-grafana marked this pull request as ready for review August 15, 2024 15:33
@gtk-grafana
Copy link
Contributor

@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
Copy link
Member Author

torkelo commented Aug 16, 2024

Looks good , now just needs a review approval

@torkelo torkelo merged commit c13bd08 into main Aug 16, 2024
3 checks passed
@torkelo torkelo deleted the manual-query-runner branch August 16, 2024 12:58
@grafanabot
Copy link
Contributor

🚀 PR was released in v5.9.0 🚀

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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants