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

parseFieldDefinition

parseFieldDefinition(ql): FieldAST

Defined in: schema/ast/parser.ts:146

Parses a DEFINE FIELD statement into a FieldAST.

Parameters

Section titled “Parameters”

ql

Section titled “ql”

string

The raw SurrealQL DEFINE FIELD statement

Returns

Section titled “Returns”

FieldAST

Complete FieldAST

Example

Section titled “Example”
const field = parseFieldDefinition("DEFINE FIELD email ON TABLE user TYPE string");
// { name: "email", type: "string", flex: false, ... }