Query schedules
You can automate query runs by creating query schedules. Scheduled queries run on a custom cadence to manage your data based on frequency, date, and time. You can also choose an output dataset for your results if required. Queries that have been saved as a template can be scheduled from the Query Editor.
Any scheduled queries are added to the list in the Scheduled queries tab. From that workspace you can monitor the status of all scheduled query jobs through the UI. On the Scheduled queries tab you can find important information about your query runs and subscribe to alerts. The available information includes the status, schedule details, and error messages/codes should a run fail. See the Monitor scheduled queries document for more information.
This workflow covers the scheduling process in the Query Service UI. To learn how to add schedules using the API, please read the scheduled queries endpoint guide.
Create a query schedule create-schedule
To schedule a query, select a query template from either the Templates tab or the Template column of the Scheduled Queries tab. Selecting the template name navigates you to the Query Editor.
If you access a saved query from the Query Editor, you can create a schedule for the query or view the query’s schedule from the details panel.
Select Add schedule to navigate to the schedule details page.
Alternatively, select the Schedules tab below the query’s name.
The schedules workspace appears. Select Add Schedule to create a schedule.
Edit the schedule details schedule-details
The schedule details page appears. On this page, you can choose the frequency of the scheduled query, the start and end date, the day of the week the scheduled query will run, as well as what dataset to export the query to.
You can choose the following options for Frequency:
- Hourly: The scheduled query will run every hour for the date period you selected.
- Daily: The scheduled query will run every X days at the time and the date period you selected. Please note that the time selected is in UTC, and not your local time zone.
- Weekly: The selected query will run on the days of the week, time, and the date period you selected. Please note that the time selected is in UTC, and not your local time zone.
- Monthly: The selected query will run every month at the day, time, and the date period you selected. Please note that the time selected is in UTC, and not your local time zone.
- Yearly: The selected query will run every year at the day, month, time, and the date period you selected. Please note that the time selected is in UTC, and not your local time zone.
For the output dataset, you have the option to use either append into an existing dataset or create and append into a new dataset. The second option means that if you execute a query for the first time and create a data set, any subsequent executions will keep inserting data into that data set.
INSERT INTO or CREATE TABLE AS SELECT as part of the query, since the datasets are already set. Including either INSERT INTO or CREATE TABLE AS SELECT as part of your scheduled queries will result in an error.If you do not have access to parameterized queries, continue on to the delete or disable a schedule section.
Set parameters for a scheduled parameterized query set-parameters
If you are creating a scheduled query for a parameterized query, you must now set the parameter values for these query runs.
After confirming all these details, select Save to create a schedule. You are returned to the schedules workspace that displays details of the newly created schedule, including the schedule ID, the schedule itself, and the schedule’s output dataset. You can use the schedule ID to look up more information about the runs of the scheduled query itself. To learn more, please read the scheduled query run endpoints guide.
View scheduled query runs scheduled-query-runs
To view a list of a query template’s scheduled runs, navigate to the Scheduled queries tab and select a template name from the list available.
The list of query runs for that scheduled query appears.
See the monitor scheduled queried guide for complete information on how to monitor the status of all query jobs through the UI.
Delete or disable a schedule delete-schedule
You can delete or disable a schedule from the schedules workspace of a particular query or from the Scheduled Queries workspace that lists all the scheduled queries.
To access the Schedules tab of your chosen query, you must select the name of a query template from either the Templates tab or the Scheduled Queries tab. This navigates to the Query Editor for that query. Form the Query Editor, select Schedules to access the schedules workspace.
Select a schedule from the rows of available schedules. You can use the toggle to disable or enable the scheduled query.
Select Delete a schedule to delete the disabled schedule.
Alternatively, the Scheduled Queries tab offers a collection of inline actions for each scheduled query. The available inline actions include Disable schedule or Enable schedule, Delete schedule, and Subscribe to alerts for the scheduled query. For complete instructions on how to delete or disable a scheduled query through the scheduled Queries tab, please see the monitor scheduled queried guide.