Skip to content

Type Alias: AttributeRelationship ​

AttributeRelationship = object

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

AttributeRelationship

Properties ​

$createdAt ​

$createdAt: string

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

Attribute 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:1066

Attribute 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:1058

Is attribute an array?


error ​

error: string

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

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


key ​

key: string

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

Attribute Key.


onDelete ​

onDelete: string

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

How deleting the parent document will propagate to child documents.


relatedCollection ​

relatedCollection: string

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

The ID of the related collection.


relationType ​

relationType: string

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

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:1054

Is attribute required?


side ​

side: string

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

Whether this is the parent or child side of the relationship


status ​

status: AttributeStatus

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

Attribute 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:1078

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:1082

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:1042

Attribute type.