app:field
Retrieves the definition of a single field within a table
Retrieves the definition of a single field within a table
Options
| Name | Type | Description |
|---|---|---|
org_id | string | The organisation ID that scopes the operation |
schema_id | string | The name of the schema (database) that contains the table |
table | string | The name of the table that contains the field |
field | string | The name of the field to retrieve |
Outputs
| Name | Type | Description |
|---|---|---|
field | Field | The retrieved field definition |
↳ name | string | Is the column name. Must be unique within the table and must not collide with reserved record fields (id, created_at, updated_at, deleted_at). |
↳ type | FieldType | Is the field's data type. See the FieldType constants for the supported values. |
↳ required | bool | Marks the field as non-nullable. Inserts and updates that omit a required field (and provide no Default) are rejected. |
↳ default | any | Is the value applied when a record is inserted without an explicit value for this field. A nil or zero value means no default is applied. |
↳ related_table | string | Is the name of the target table for relation fields. Required when Type is has_one, has_many, or belongs_to; ignored otherwise. |
↳ related_field | string | Is the name of the foreign-key field on the related table. Used only by has_many to identify which column on RelatedTable points back to this record. |
↳ description | string | Is a human-readable explanation of the field's purpose. Surfaced in generated documentation and GUI tooling; has no effect on storage or validation. |
How is this guide?