parseIndexDefinition

parseIndexDefinition(ql): IndexAST

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

Parses a DEFINE INDEX statement into an IndexAST.

Parameters

ql

string

The raw SurrealQL DEFINE INDEX statement

Returns

IndexAST

Complete IndexAST

Example

const index = parseIndexDefinition("DEFINE INDEX email_idx ON TABLE user FIELDS email UNIQUE");
// { name: "email_idx", columns: ["email"], unique: true }