FieldAST

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

AST node representing a field definition.

Properties

assert?

optional assert: string

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

ASSERT expression

---

comment?

optional comment: string

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

Field comment

---

default?

optional default: string

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

DEFAULT value expression

---

flex

flex: boolean

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

Whether field is FLEXIBLE

---

name

name: string

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

Field name (supports dot notation for nested fields, e.g., “address.city”)

---

onDelete?

optional onDelete: "IGNORE" | "UNSET" | "CASCADE" | "REJECT"

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

ON DELETE behavior for references: IGNORE, UNSET, CASCADE, REJECT

---

permissions

permissions: PermissionsAST

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

Field-level permissions

---

readonly?

optional readonly: boolean

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

Whether field is READONLY

---

reference?

optional reference: boolean

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

Whether field is a REFERENCE

---

type

type: string

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

Raw SurrealQL type string (e.g., “string”, “record”, “option”)

---

value?

optional value: string

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

VALUE expression (computed field)