Skip to content

Execute SQL statement

POST
/api/v1/catalogs/execute-sql
curl --request POST \
--url https://example.com/api/v1/catalogs/execute-sql \
--header 'Content-Type: application/json' \
--data '{ "sql": "example" }'

Executes a SQL statement in a Databricks SQL warehouse using environment configuration.

X-Environment-Id
Any of:
string
Media typeapplication/json
SqlExecuteRequest

Request to execute a SQL statement.

object
sql
required
Sql

SQL statement to execute

string
Examplegenerated
{
"sql": "example"
}

Successful Response

Media typeapplication/json
SqlExecuteResponse

Response from executing a SQL statement.

object
sql
required
Sql
string
result
required
Result
status
required
Status
string
Examplegenerated
{
"sql": "example",
"result": "example",
"status": "example"
}

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
"detail": [
{
"loc": [
"example"
],
"msg": "example",
"type": "example"
}
]
}