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.

IndexAST

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

AST node representing an index definition.

optional analyzer: string

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

Search analyzer name


columns: string[]

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

Columns/fields included in the index


optional comment: string

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

Index comment


name: string

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

Index name


optional search: boolean

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

Whether this is a full-text search index


unique: boolean

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

Whether the index enforces uniqueness


optional vector: boolean

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

Whether this is a vector index