Skip to content

Type Alias: ColumnRelationship ​

ColumnRelationship = object

Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:1885

ColumnRelationship

Properties ​

$createdAt ​

$createdAt: string

Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:1913

Column creation date in ISO 8601 format.


$updatedAt ​

$updatedAt: string

Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:1917

Column update date in ISO 8601 format.


array? ​

optional array?: boolean

Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:1909

Is column an array?


error ​

error: string

Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:1901

Error message. Displays error generated on failure of creating or deleting an column.


key ​

key: string

Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:1889

Column Key.


onDelete ​

onDelete: string

Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:1937

How deleting the parent document will propagate to child documents.


relatedTable ​

relatedTable: string

Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:1921

The ID of the related table.


relationType ​

relationType: string

Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:1925

The type of the relationship.


required ​

required: boolean

Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:1905

Is column required?


side ​

side: string

Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:1941

Whether this is the parent or child side of the relationship


status ​

status: ColumnStatus

Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:1897

Column status. Possible values: available, processing, deleting, stuck, or failed


twoWay ​

twoWay: boolean

Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:1929

Is the relationship two-way?


twoWayKey ​

twoWayKey: string

Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:1933

The key of the two-way relationship.


type ​

type: string

Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:1893

Column type.