Appearance
appdata.schema.introspect ​
Read an app's live serving schema: relations, columns, indexes, constraints, policies, functions and sizes
Read the app's live tables, views, columns, indexes, policies and functions.
Overview ​
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | App-appdata |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | uuid | Yes | — | — |
identity_app_uuid | uuid | Yes | — | The app whose live schema to read |
include_base_tables | boolean | No | — | Include the t base tables (default true) |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | uuid | Yes | — | — |
identity_app_uuid | uuid | Yes | — | — |
backend_kind | string | Yes | — | — |
schema | string | Yes | — | — |
server_version | string | No | — | — |
total_bytes | integer | No | — | — |
relation_count | integer | No | — | — |
relations | list | No | — | — |
functions | list | No | — | — |
generated_at | string | No | — | — |
error | string | No | — | Error message when the read failed |
error_type | string | No | — | Error class name when the read failed |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
done | Yes | Yes | Yes | — | — |
Outcomes ​
| Outcome | Type | Description | State Data Keys |
|---|---|---|---|
introspected | SUCCESS | Read an app's live serving schema: relations, columns, indexes, constraints, policies, functions and sizes | schema, relation_count |
failed | FAILURE | Appdata workflow failed | failure_reason |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "appdata.schema.introspect",
"initial_data": {
"organization_uuid": "value",
"identity_app_uuid": "value"
}
}