Skip to content
Proud to collaborate with Microsoft for Startups

sql.query.run ​

Execute parameterized SQL against an external SQL connection (Postgres v1; mutations allowed)

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-sql
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidYes——
cloud_connection_uuiduuidYes——
sqlstringYes—SQL statement (use %s placeholders for params)
paramslistNo—Positional parameters matching %s placeholders
timeout_secondsintegerNo—Connect/statement budget (default 30, max 120)
max_rowsintegerNo—Max rows returned (default 1000, max 10000)
actorstringNo——

Output Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidNo——
cloud_connection_uuiduuidNo——
sqlstringNo——
paramslistNo——
timeout_secondsintegerNo——
max_rowsintegerNo——
actorstringNo——
rowslistNo——
row_countintegerNo——
status_messagestringNo——
truncatedbooleanNo——
executed_atstringNo——
failure_reasonstringNo—Engine-stamped human-readable failure reason
failed_at_statestringNo—Engine-stamped state when the workflow failed
failed_stepstringNo—Engine-stamped step name (DAG path)
failed_layerintegerNo—Engine-stamped layer index (DAG path)
errorstringNo—Engine-stamped exception message
error_typestringNo—Engine-stamped exception class name
failure_typestringNo—Engine-stamped failure category (atomic path)
failed_actionstringNo—Engine-stamped action method that raised (atomic path)
failed_atstringNo—ISO timestamp when the fail action ran

States ​

StateInitialTerminalSuccessAuto-advanceDescription
initiatedYesNo—executeInputs accepted
completedNoYesYes—SQL executed
failedNoYesNo—SQL execution failed

State Diagram ​

Transitions ​

FromActionToDescription
initiatedexecutecompleted—
* (any state)failfailed—

API Usage ​

bash
POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "sql.query.run",
  "initial_data": {
    "organization_uuid": "value",
    "cloud_connection_uuid": "value",
    "sql": "value"
  }
}