Skip to content
Proud to collaborate with Microsoft for Startups

neon.database.query ​

List NeonDatabase rows for a branch or project

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-neon
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidYes——
neon_branch_uuiduuidNo——
neon_project_uuiduuidNo——
include_deletedbooleanNo——
limitintegerNo——
offsetintegerNo——

Output Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidYes——
databaseslistYes——
countintegerYes——
limitintegerYes——
offsetintegerYes——
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)

States ​

StateInitialTerminalSuccessAuto-advanceDescription
pendingYesNo—completeQuery databases
completedNoYesYes—Queried
failedNoYesNo—Query failed

State Diagram ​

Transitions ​

FromActionToDescription
pendingcompletecompleted—
pendingfailfailed—

API Usage ​

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

{
  "workflow_type": "neon.database.query",
  "initial_data": {
    "organization_uuid": "value"
  }
}