neon.query.run

Resolve a Neon connection URI and execute a SQL statement against a branch

Overview

Property	Value
Workflow type	Atomic
Library	App-neon
Version	1.0

Input Schema

Field	Type	Required	Default	Description
organization_uuid	uuid	Yes	—	—
cloud_connection_uuid	uuid	Yes	—	—
neon_branch_uuid	uuid	Yes	—	—
role_name	string	Yes	—	—
db_name	string	Yes	—	—
sql	string	Yes	—	SQL statement. Use PostgreSQL %s placeholders for bind params, e.g. SELECT * FROM users WHERE id = %s.
params	list	No	—	Values for SQL %s placeholders, in order. Required when sql contains %s placeholders.
fetch_results	boolean	No	—	—
timeout_seconds	integer	No	—	—
actor	string	No	—	—

Output Schema

Field	Type	Required	Default	Description
organization_uuid	uuid	No	—	—
neon_branch_uuid	uuid	No	—	—
rows	list	No	—	—
row_count	integer	No	—	—
status_message	string	No	—	—
executed_at	string	No	—	—
failure_reason	string	No	—	Engine-stamped human-readable failure reason
failed_at_state	string	No	—	Engine-stamped state when the workflow failed
failed_step	string	No	—	Engine-stamped step name (DAG path)
failed_layer	integer	No	—	Engine-stamped layer index (DAG path)
error	string	No	—	Engine-stamped exception message
error_type	string	No	—	Engine-stamped exception class name
failure_type	string	No	—	Engine-stamped failure category (atomic path)
failed_action	string	No	—	Engine-stamped action method that raised (atomic path)

States

State	Initial	Terminal	Success	Auto-advance	Description
initiated	Yes	No	—	execute	Inputs accepted
completed	No	Yes	Yes	—	Query executed
failed	No	Yes	No	—	Query failed

State Diagram

Transitions

From	Action	To	Description
initiated	execute	completed	—
* (any state)	fail	failed	—

API Usage

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

{
  "workflow_type": "neon.query.run",
  "initial_data": {
    "organization_uuid": "value",
    "cloud_connection_uuid": "value",
    "neon_branch_uuid": "value",
    "role_name": "value"
  }
}