Atlas

Appearance

Type Alias: ColumnText ​

ColumnText = object

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

ColumnText

Properties ​

$createdAt ​

$createdAt: string

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

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

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

Is column an array?

default? ​

optional default?: string

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

Default value for column when not provided. Cannot be set when column is required.

encrypt? ​

optional encrypt?: boolean

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

Defines whether this column is encrypted or not.

error ​

error: string

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

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

Column Key.

required ​

required: boolean

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

Is column required?

status ​

status: ColumnStatus

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

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

type ​

type: string

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

Column type.