topic Re: Deploying existing queries and alerts to other workspaces in Data Engineering

Deploying existing queries and alerts to other workspaces

erigaud — Fri, 21 Jul 2023 06:45:10 GMT

I have several queries and associated alerts in a workspace, and I would like to be able to deploy them to an other workspace, for example an higher environment.

Since both queries and objects are not supported in repos, what is the way to go to easily recreate queries/alerts somewhere else ?

I saw a very similar post on the community that recommended using the API, so my question is : is there a way to export an existing query/alert to json to easily recreate it through the API (in a similar fashion as to a job) ?

Also, could Unity Catalog be of any help for this task ?

Thank you !

Re: Deploying existing queries and alerts to other workspaces

btafur — Fri, 21 Jul 2023 19:26:39 GMT

It is possible to do this via API. With the API you can:

List the queries from a workspace: https://docs.databricks.com/api/azure/workspace/queries/list
Get a specific query from a workspace: https://docs.databricks.com/api/azure/workspace/queries/get
Create a new query definition in the target workspace: https://docs.databricks.com/api/azure/workspace/queries/create

With alerts you can do something similar:

Re: Deploying existing queries and alerts to other workspaces

Anonymous — Sun, 23 Jul 2023 04:22:03 GMT

Hi @erigaud

We haven't heard from you since the last response from @btafur , and I was checking back to see if her suggestions helped you.

Or else, If you have any solution, please share it with the community, as it can be helpful to others.

Also, Please don't forget to click on the "Select As Best" button whenever the information provided helps resolve your question.

Re: Deploying existing queries and alerts to other workspaces

erigaud — Mon, 24 Jul 2023 06:16:49 GMT

The API allows me to create queries, but apparently not to recreate existing queries it seems ? For example the API does not allow me to recreate the schedule of a query right ?

Re: Deploying existing queries and alerts to other workspaces

btafur — Mon, 24 Jul 2023 10:06:45 GMT

It is not explicitly stated in the Docs but there is a "schedule" option in the payload for a query definition with the following structure:

schedule {

cron : 2 55 9 ? * 2

time : null

until : null

version : 2

interval : null

day_of_week : null

}

The best way of knowing the full structure of the query definition is to use the API to GET the query definition of an existing query that has the "schedule" enabled. https://docs.databricks.com/api/azure/workspace/queries/get

You should be able to recreate all the options via the API.