Appearance
neon.data.query ​
End-user-safe tenant-scoped structured read of a Neon table
End-user-safe tenant-scoped read of a Neon table.
The calling end-user's uuid is taken from the immutable principal (context.metadata["end_user"]) and forced as scope_column = uuid; a caller can neither remove that predicate nor set its value. Only structured inputs are accepted (no raw SQL); table/columns are validated against the exposure allow-lists. Returns the caller's own rows only.
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 | — | — |
table | string | Yes | — | — |
scope_column | string | Yes | — | — |
table_allowlist | list | Yes | — | — |
column_allowlist | list | Yes | — | — |
columns | list | Yes | — | — |
filters | list | No | — | — |
limit | integer | No | — | — |
actor | string | No | — | — |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
rows | list | No | — | — |
row_count | integer | No | — | — |
table | string | No | — | — |
executed_at | string | No | — | — |
reason | 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 |
|---|---|---|---|---|---|
pending | Yes | No | — | execute | Scoped read |
completed | No | Yes | Yes | — | Read executed |
failed | No | Yes | No | — | Read failed |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
pending | execute | completed | — |
* (any state) | fail | failed | — |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "neon.data.query",
"initial_data": {
"organization_uuid": "value",
"cloud_connection_uuid": "value",
"neon_branch_uuid": "value",
"role_name": "value"
}
}