Type Alias: Collection ​
Collection =
object
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:551
Collection
Properties ​
$createdAt ​
$createdAt:
string
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:559
Collection creation date in ISO 8601 format.
$id ​
$id:
string
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:555
Collection ID.
$permissions ​
$permissions:
string[]
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:567
Collection permissions. Learn more about permissions.
$updatedAt ​
$updatedAt:
string
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:563
Collection update date in ISO 8601 format.
attributes ​
attributes: (
AttributeBoolean|AttributeInteger|AttributeFloat|AttributeEmail|AttributeEnum|AttributeUrl|AttributeIp|AttributeDatetime|AttributeRelationship|AttributePoint|AttributeLine|AttributePolygon|AttributeVarchar|AttributeText|AttributeMediumtext|AttributeLongtext|AttributeString)[]
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:587
Collection attributes.
bytesMax ​
bytesMax:
number
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:595
Maximum document size in bytes. Returns 0 when no limit applies.
bytesUsed ​
bytesUsed:
number
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:599
Currently used document size in bytes based on defined attributes.
databaseId ​
databaseId:
string
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:571
Database ID.
documentSecurity ​
documentSecurity:
boolean
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:583
Whether document-level permissions are enabled. Learn more about permissions.
enabled ​
enabled:
boolean
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:579
Collection enabled. Can be 'enabled' or 'disabled'. When disabled, the collection is inaccessible to users, but remains accessible to Server SDKs using API keys.
indexes ​
indexes:
Index[]
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:591
Collection indexes.
name ​
name:
string
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:575
Collection name.