Skip to content

Table

Properties

NAME TYPE DESCRIPTION
$id
string

Table ID.

$createdAt
string

Table creation date in ISO 8601 format.

$updatedAt
string

Table update date in ISO 8601 format.

$permissions
array

Table permissions. Learn more about permissions.

databaseId
string

Database ID.

name
string

Table name.

enabled
boolean

Table enabled. Can be 'enabled' or 'disabled'. When disabled, the table is inaccessible to users, but remains accessible to Server SDKs using API keys.

rowSecurity
boolean

Whether row-level permissions are enabled. Learn more about permissions.

columns
array

Table columns.

Can be one of:

ColumnBoolean model, ColumnInteger model, ColumnFloat model, ColumnEmail model, ColumnEnum model, ColumnURL model, ColumnIP model, ColumnDatetime model, ColumnRelationship model, ColumnPoint model, ColumnLine model, ColumnPolygon model, ColumnVarchar model, ColumnText model, ColumnMediumtext model, ColumnLongtext model, ColumnString model

indexes
array

Table indexes.

Can be one of:

Index model

bytesMax
integer

Maximum row size in bytes. Returns 0 when no limit applies.

bytesUsed
integer

Currently used row size in bytes based on defined columns.

Example

Was this page helpful?