Data sources

Execute a SQL query against a data source

Executes a SQL query against the specified data source and returns the results.

This endpoint allows you to run ad-hoc SQL queries for data exploration, validation, or analysis. The query is executed using the data source’s native query runner with the appropriate credentials.

Streaming mode: Use query parameter ?stream=true or set X-Stream-Response: true header. Streaming is only supported for certain data sources (e.g., Databricks). When streaming, results are sent incrementally as valid JSON for memory efficiency.

Returns:

Query results as rows with column metadata (name, type, description)
Limited to a reasonable number of rows for performance

POST

api

data_sources

{data_source_id}

query

Execute a SQL query against a data source

curl --request POST \
  --url https://app.datafold.com/api/v1/data_sources/{data_source_id}/query \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "<string>",
  "params": [
    "<string>"
  ]
}
'

{
  "rows": [
    {}
  ],
  "columns": [
    {
      "name": "<string>",
      "db_type": "<string>",
      "description": "<string>",
      "is_nullable": true,
      "number": 123,
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Use the 'Authorization' header with the format 'Key '

Headers

X-Stream-Response

string | null

Path Parameters

data_source_id

integer

required

Query Parameters

stream

boolean

default:false

Stream results as JSON

Body

application/json

query

string

required

SQL query to execute

params

string[] | null

Positional parameters for parameterized queries

Response

Successful Response

rows

Rows · object[]

required

columns

ApiQueryColumn · object[] | null

Show child attributes

Get a data source summaryGet a summary of a specific data source by ID via the Datafold API.

⌘I

Execute a SQL query against a data source

curl --request POST \
  --url https://app.datafold.com/api/v1/data_sources/{data_source_id}/query \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "<string>",
  "params": [
    "<string>"
  ]
}
'

{
  "rows": [
    {}
  ],
  "columns": [
    {
      "name": "<string>",
      "db_type": "<string>",
      "description": "<string>",
      "is_nullable": true,
      "number": 123,
      "type": "<string>"
    }
  ]
}