How to schedule a query

πŸ€“ Who can do this? Before scheduling a query, you will need your Atlan administrator to enable scheduled queries.

You might want to schedule a query to run repeatedly. For example:

  • If you want to fetch data for the same query at different times.
  • If you want to share data with business teams on a consistent basis, for example, weekly.
  • If a data analyst is out of office but wants the data to be shared with users periodically.
🚨 Careful! You must save your query before you can schedule it. Your SMTP configuration must also be in a working state to send results to recipients.

Schedule a query

 

To schedule a query:

  1. Open Insights.
  2. In the upper left, click the papers-in-a-box icon to open your query collections.
  3. Choose the query collection where the query you want to schedule is saved.
  4. Hover over the saved query you want to schedule, click the three dots to its right, and then click Schedule.
  5. In the New Schedule Query dialog, enter the scheduling details: 
    1. For Name, enter a meaningful name for the scheduled query.
    2. For Runs every, choose how often the query should run:
      • For Hour and Day, you can go down to the minute for hourly and daily runs.
      • For Week, you can select multiple days for a weekly run.
      • For Month, you can select multiple dates for a monthly run.
      • For Custom cron, write your own custom cron.
    3. For Timezone, select a relevant option or keep the default one.
    4. For Share Results, select the user(s) to whom you want to send the results from each run.
    5. (Optional) If there are any existing schedules for your query, from the top right, click the existing schedule link to view more details in a sidebar.
    6. At the bottom right of the dialog, click Done.
  6. (Optional) Under Query successfully scheduled, click the Run Now link if you want to test the scheduled query.
  7. At the bottom right of the dialog, click Finish.

Your query will now run on the defined schedule and the results will be sent out automatically! πŸŽ‰

Note that the download link for the results is only valid for 6 hours. 

πŸ’ͺ Did you know? If a scheduled query fails, you'll receive an email notification with the name of the query, so you can troubleshoot and get it running in no time.

Change a scheduled query

 

To change the schedule for a query:

  1. Open Insights.
  2. In the upper left, click the repeating-arrow icon to open your scheduled queries.
  3. Hover over the scheduled query you want to change, click the three dots to its right, and then:
    1. (Optional) Click Run now to run the scheduled query immediately.
    2. (Optional) Click Pause to pause the scheduled query.
    3. Click Edit to update the scheduled query.
  4. In the Update Schedule Query dialog box, make any desired changes to the schedule or recipients.
  5. At the bottom right of the dialog box, click Update to save the changes.
  6. (Optional) Under Query successfully updated, click the Run Now link if you want to test the scheduled query.
  7. At the bottom right of the dialog, click Finish.

Your query will now run on the changed schedule and the results will be sent out automatically! πŸŽ‰

Remove a scheduled query

 

To remove a scheduled query:

  1. Open Insights.
  2. In the upper left, click the repeating-arrow icon to open your scheduled queries.
  3. Hover over the scheduled query you want to stop, click the three dots to its right, and then click Delete.
  4. In the Delete Schedule dialog box, click Delete.

Your query will no longer run automatically.

Related articles

Was this article helpful?
1 out of 1 found this helpful