Home Big Data Saying the Normal Availability of the Databricks SQL Assertion Execution API

Saying the Normal Availability of the Databricks SQL Assertion Execution API

Saying the Normal Availability of the Databricks SQL Assertion Execution API


At present, we’re excited to announce the final availability of the Databricks SQL Assertion Execution API on AWS and Azure, with help for GCP anticipated to be in Public Preview early subsequent 12 months. You should utilize the API to connect with your Databricks SQL warehouse over a REST API to entry and manipulate knowledge managed by the Databricks Lakehouse Platform.

On this weblog, we stroll by way of the API fundamentals, talk about the important thing options newly out there within the GA launch, and present you find out how to construct a knowledge software utilizing the Assertion Execution API with the Databricks Python SDK. You’ll be able to even observe alongside by working the code in opposition to your Databricks workspace. For an extra instance, our earlier weblog confirmed find out how to leverage your knowledge in a spreadsheet utilizing the Assertion Execution API and JavaScript.

Assertion Execution API, in short

BI purposes are one of many main shoppers of a knowledge warehouse and Databricks SQL offers a wealthy connectivity ecosystem of drivers, connectors, and native integrations with established BI instruments. Nonetheless, knowledge managed by the Databricks Lakehouse Platform is related for purposes and use circumstances past BI, comparable to e-commerce platforms, CRM programs, SaaS purposes, or customized knowledge purposes developed by clients in-house. Usually, these instruments can not simply join over customary database interfaces and drivers; nevertheless, nearly any software and system can talk with a REST API.

The Databricks SQL Assertion Execution API means that you can use customary SQL over HTTP to construct integrations with a variety of purposes, applied sciences, and computing gadgets. The API offers a set of endpoints that help you submit SQL statements to a SQL Warehouse for execution and retrieve outcomes. The picture under offers a high-level overview of a typical knowledge move.

Announcing the General Availability of the Databricks SQL Statement Execution API

You should utilize the API to construct customized knowledge apps with instruments and languages of your alternative. For instance, you may construct internet purposes the place a enterprise person offers a set of querying standards by way of a person interface and is supplied again the outcomes for visualization, obtain, or additional evaluation. You may also use the API to implement special-purpose APIs tailored to your specific use circumstances and microservices, or construct customized connectors in your programming language of alternative. One important benefit when utilizing the API for these situations is that you don’t want to put in a driver or handle database connections; you merely connect with the server over HTTP and handle asynchronous knowledge exchanges.

New options out there within the GA launch

Together with the final availability of the API on AWS and Azure, we’re enabling some new options and enhancements.

  • Parameterized statements – Safely apply dynamic literal values to your SQL queries with type-safe parameters. Literal values are dealt with individually out of your SQL code, which permits Databricks SQL to interpret the logic of the code independently from user-supplied variables, stopping frequent SQL injection assaults.
  • Consequence retention – Refetch the outcomes for a press release a number of occasions for as much as one hour. Beforehand, outcomes had been now not out there after the final chunk was learn, requiring particular remedy of the final chunk when fetching chunks in parallel.
  • A number of end result codecs – JSON_ARRAY and CSV codecs are actually out there with the EXTERNAL_LINKS disposition. Whilst you can nonetheless use Arrow for optimum efficiency, JSON and CSV are extra ubiquitously supported by instruments and frameworks, enhancing interoperability.
  • Byte and row limits – Apply limits to your outcomes to stop sudden massive outputs. The API will return a truncation flag each time the desired restrict is exceeded.

Within the subsequent part, we’ll go into extra element as we use these new options to construct a customized API on high of the Assertion Execution API.

Construct your special-purpose API

On the Knowledge+AI Summit this 12 months, we walked by way of constructing a customized API on high of the Databricks Lakehouse Platform utilizing this new Assertion Execution API. In case you missed it, we’ll relive that journey now, creating a easy web site and repair backend for a fictional firm known as Acme, Inc. You’ll be able to observe together with the code right here, working the `setup.sh` script as a primary step.

Acme, Inc. is a medium sized enterprise with 100 shops that promote numerous kinds of machine components. They leverage the Databricks Lakehouse to trace details about every retailer and to course of their gross sales knowledge with a medallion structure. They need to create an online software that permits retailer managers to simply browse their gold gross sales knowledge and retailer info. As well as, they need to allow retailer managers to insert gross sales that did not undergo a standard level of sale. To construct this method we’ll create a Python Flask software that exposes a customized knowledge API and an HTML/JQuery frontend that invokes that API to learn and write knowledge.

Let’s take a look at the customized API endpoint to listing all shops and the way it maps to the Assertion Execution API within the backend. It’s a easy GET request that takes no arguments. The backend calls into the SQL Warehouse with a static SELECT assertion to learn the `shops` desk.

Acme Inc’s API Request   Assertion Execution API Request
GET /shops POST /sql/statements
    assertion: “SELECT * FROM shops”
    wait_timeout: “50s”
    on_wait_timeout: “CANCEL”
Acme Inc’s API Response   Assertion Execution API Response
state: “SUCCEEDED”
shops: [
  [“123”, “Acme, Inc”, …], 
  [“456”, “Databricks”, …]
statement_id: “ID123”
standing: { state: “SUCCEEDED” }
manifest: { … } 
end result: { 
  data_array: [
    [“123”, “Acme, Inc”, …], 
    [“456”, “Databricks”, …]


As Acme solely has 100 shops, we count on a quick question and a small knowledge set within the response. Due to this fact, we have determined to make a synchronous request to Databricks and get rows of retailer knowledge returned inline. To make it synchronous, we set the `wait_timeout` to point we’ll wait as much as 50 seconds for a response and set the `on_wait_timeout` parameter to cancel the question if it takes longer. By wanting on the response from Databricks, you may see that the default end result `disposition` and `format` return the info inline in a JSON array. Acme’s backend service can then repackage that payload to return to the customized API’s caller.

The total backend code for this practice endpoint will be discovered right here. Within the frontend, we name the customized `/api/1.0/shops` endpoint to get the listing of shops and show them by iterating over the JSON array right here. With these two items, Acme has a brand new homepage backed by Databricks SQL!

Announcing the General Availability of the Databricks SQL Statement Execution API

For every retailer, we additionally need to have a web page that shows the latest gross sales and we wish a retailer supervisor to have the ability to obtain the total set of retailer knowledge. It is price noting that the variety of gross sales transactions per retailer will be fairly massive – many orders of magnitude larger than the variety of shops. The necessities for this practice API endpoint are:

  1. Restricted output – The caller should have the ability to restrict the variety of gross sales returned so they do not should get all the info on a regular basis.
  2. Multi-format – The outcomes must be retrievable in a number of codecs in order that they are often simply displayed in an online web page or downloaded for offline processing in a software like Excel.
  3. Async – It must be async as it’d take a very long time to get the gross sales info for a retailer.
  4. Environment friendly extracts – For efficiency and stability causes, the massive gross sales knowledge shouldn’t be pulled by way of the backend internet server.

Under, you may see how we use the Databricks SDK for Python to invoke the Assertion Execution API to cowl these necessities. The total code is right here.

def execute_list_sales_request(store_id, format, row_limit):
  # Use parameters to stop SQL injection by way of the shop ID string.
  parameters = [
    StatementParameterListItem(name='store_id', value=store_id, type="INT")
  statement_response = w.statement_execution.execute_statement(
    assertion = "SELECT * FROM gross sales WHERE store_id = :store_id",
    format = Format[format],
    disposition = Disposition.EXTERNAL_LINKS,
    wait_timeout = "0s",
    warehouse_id = warehouse_id,
    parameters = parameters,
    row_limit = row_limit
  response = {
    'request_id': statement_response.statement_id,
    'state': str(statement_response.standing.state.title)
  return response

To satisfy the primary two necessities, we expose `row_limit` and `format` parameters from the customized API and cross them to the Assertion Execution API. This can enable callers to restrict the whole variety of rows produced by the question and to select the end result format (CSV, JSON or Arrow).

To make the customized API asynchronous, we’ll set the Assertion Execution API’s `wait_timeout` parameter to 0 seconds, which implies Databricks will reply instantly with a press release ID and question state. We’ll package deal that assertion ID as a `request_id` together with the state in a response to the caller. As soon as the consumer will get the request ID and state, they’ll ballot the identical customized API endpoint to verify the standing of the execution. The endpoint forwards the request to Databricks SQL Warehouse by way of the `get_statement` methodology. If the question is profitable, the API will finally return a `SUCCEEDED` state together with a `chunk_count`. The chunk rely signifies what number of partitions the end result was divided into.

To realize environment friendly extracts (4th requirement), we used the EXTERNAL_LINKS disposition. This permits us to get a pre-signed URL for every chunk, which the customized API will return when given a `request_id` and `chunk_index`.

We will use this to construct Acme a touchdown web page for every retailer that reveals the latest gross sales by supplying a row restrict of 20 and the JavaScript pleasant JSON_ARRAY end result format. However we will additionally add a “Obtain” button on the high of the web page to permit retailer managers to drag historic knowledge for all gross sales. In that case, we do not provide a restrict and leverage the CSV format for simple ingestion into the evaluation software of their alternative. As soon as the browser sees the question is profitable and will get the whole chunk rely, it invokes the customized API in parallel to get pre-signed URLs and obtain the CSV knowledge instantly from cloud storage. Underneath the hood, the EXTERNAL_LINKS disposition leverages the Cloud Fetch expertise that has proven a 12x enchancment in extraction throughput over sequential inline reads. Within the instance under, we downloaded 500MBs in parallel at ~160Mbps.

Announcing the General Availability of the Databricks SQL Statement Execution API

Now that gross sales for a retailer will be considered, the Acme crew additionally wants to have the ability to insert new gross sales info into the Lakehouse. For that, we will create a easy internet type backed by a POST request to the /api/1.0/shops/storeId/gross sales endpoint. To get the shape knowledge into the Lakehouse, we’ll use a parameterised SQL assertion:

  gross sales (


And provide the enter from the online type to the Assertion Execution API utilizing the `parameters` listing argument with a reputation, worth, and sort for every parameter:

  "parameters": [
    { "name": "sold_date", "type": "DATE", "value": "2023-09-06" },
    { "name": "sale_id", "type": "BIGINT", "value": "10293847" },
    { "name": "store_id", "type": "INT", "value": "12345" },
    { "name": "item_id", "type": "INT", "value": "67890" },
    { "name": "sales_price", "type": "DECIMAL(7,2)", "value": "1.99" }
    { "name": "quantity", "type": "INT", "value": "100" },    

The SQL Warehouse engine will safely substitute the supplied parameters into the question plan as literals after parsing the SQL code. This prevents maliciously injected SQL syntax from being interpreted as SQL. The “sort” subject for every parameter offers an extra layer of security by checking the type-correctness of the supplied “worth“. If a malicious person offers a price like “100); drop desk gross sales” as enter for the amount subject, the INSERT INTO assertion will end result within the following error and won’t be executed:

[INVALID_PARAMETER_MARKER_VALUE.INVALID_VALUE_FOR_DATA_TYPE] An invalid parameter mapping was supplied: the worth ‘100); drop desk gross sales’ for parameter ‘amount’ can’t be forged to INT as a result of it’s malformed.


You’ll be able to see how we put parameters to make use of as a part of the `POST /api/1.0/shops/store_id/gross sales` endpoint right here. If the enter to the online type is legitimate with the proper sorts, then the gross sales desk might be efficiently up to date after the person clicks “Submit”.

Now you can iterate on high of this practice API or use it as a stepping stone to constructing your personal customized knowledge software on high of the Databricks Lakehouse Platform. Along with utilizing the pattern code we have been utilizing all through this text and the `setup.sh` script that creates pattern tables in your personal Databricks setting, it’s possible you’ll need to watch the reside rationalization on the Knowledge+AI Summit – the video under.

Getting began with the Databricks SQL Assertion Execution API

The Databricks SQL Assertion Execution API is out there with the Databricks Premium and Enterprise tiers. If you have already got a Databricks account, observe our tutorial (AWS | Azure), the documentation (AWS | Azure), or verify our repository of code samples. In case you are not an present Databricks buyer, join a free trial.

Strive Databricks Now



Please enter your comment!
Please enter your name here