Skip to content
🚀 This documentation is for unreal-orm 1.0.0 alpha which requires SurrealDB 2.0 alpha SDK. For the stable version, see npm.

TableAST

Defined in: schema/ast/types.ts:26

AST node representing a table definition.

drop: boolean

Defined in: schema/ast/types.ts:32

Whether DROP is enabled


events: EventAST[]

Defined in: schema/ast/types.ts:44

Event definitions


fields: FieldAST[]

Defined in: schema/ast/types.ts:40

Field definitions


indexes: IndexAST[]

Defined in: schema/ast/types.ts:42

Index definitions


name: string

Defined in: schema/ast/types.ts:28

Table name


permissions: PermissionsAST

Defined in: schema/ast/types.ts:38

Table-level permissions


optional schemafull: boolean

Defined in: schema/ast/types.ts:34

Whether the table is SCHEMAFULL (true), SCHEMALESS (false), or unspecified (undefined)


type: TableType

Defined in: schema/ast/types.ts:30

Table type: NORMAL, RELATION, or VIEW


optional viewQuery: string

Defined in: schema/ast/types.ts:36

View query (for VIEW tables only)