Skip to main content

Execute SQL against the Lakehouse

Execute SQL against the Lakehouse.

Category: Execute Query on Database | Tags: Execute

How it works

Execute SQL against the Lakehouse

To use this activity within the API, use an ActivityCode of DELTA-SQL.

Example JSON​

An example of what the Task Config would look like for a task using this activity. Some of these variables would be set at the group level to avoid duplication between tasks.

{
  "SqlToExecute": "",
  "DeltaSchemaName": "example_schema",
  "DeltaTableName": "my_table"
}

Variable Reference​

The following variables are supported:

  • DatabricksClusterId (Optional) - The Databricks Cluster to use for this task.

  • DeltaSchemaName (Optional) - The name of the Schema this transformation lives in.

  • DeltaTableName (Optional) - The name of the Table representing this transformation.

  • IsFederated (Optional) - Makes task available to other Insight Factories within this organisation.

  • Links (Optional) - NULL

  • MaximumNumberOfAttemptsAllowed (Optional) - The total number of times the running of this Task can be attempted.

  • MinutesToWaitBeforeNextAttempt (Optional) - If a Task run fails, the number of minutes to wait before re-attempting the Task.

  • SaveExportToHistory (Optional) - Save the exported data to history in the Lakehouse?

  • SqlToExecute (Required) - SQL script to execute against the Lakehouse.