Struct DefineIndex 

pub struct DefineIndex { /* private fields */ }

Builds a DEFINE INDEX statement — plain, composite, UNIQUE, full-text (SEARCH), or vector (HNSW/MTREE) indexes.

// DEFINE INDEX IF NOT EXISTS email_idx ON TABLE user FIELDS email UNIQUE
DefineIndex::new("email_idx", "user").field("email").unique().to_surrealql();

// composite, vector
DefineIndex::new("name_idx", "user").fields(["first", "last"]).to_surrealql();
DefineIndex::new("emb_idx", "doc").field("embedding").hnsw(128, "COSINE").to_surrealql();

Implementations

impl DefineIndex

pub fn new(name: impl Into<String>, table: impl Into<String>) -> Self

Begin DEFINE INDEX IF NOT EXISTS <name> ON TABLE <table>.

pub fn field(self, name: impl Into<String>) -> Self

Add one indexed field/column.

pub fn fields<I, S>(self, names: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Add several indexed fields/columns (a composite index).

pub fn unique(self) -> Self

Mark the index UNIQUE.

pub fn search(self, analyzer: impl Into<String>) -> Self

A full-text FULLTEXT ANALYZER <analyzer> index (SurrealDB 3.x; the pre-3.x SEARCH keyword is no longer accepted). Append further options (BM25, HIGHLIGHTS, …) with raw — BM25 is required for search::score() to be available.

pub fn hnsw(self, dimension: u32, dist: impl Into<String>) -> Self

An HNSW vector index of the given dimension and distance function (e.g. "COSINE", "EUCLIDEAN").

pub fn mtree(self, dimension: u32, dist: impl Into<String>) -> Self

An MTREE vector index of the given dimension and distance function.

pub fn raw(self, tail: impl Into<String>) -> Self

Set a verbatim trailing clause (the escape hatch for index options somnia doesn’t model), e.g. "SEARCH ANALYZER ascii BM25 HIGHLIGHTS".

pub fn overwrite(self) -> Self

Drop the IF NOT EXISTS guard.

pub fn comment(self, text: impl Into<String>) -> Self

Attach a COMMENT '<text>'.

pub fn concurrently(self) -> Self

Build the index CONCURRENTLY (non-blocking).

pub fn to_surrealql(&self) -> String

pub fn remove(name: &str, table: &str) -> String

REMOVE INDEX IF EXISTS <name> ON TABLE <table> — the inverse statement.

Trait Implementations

impl Display for DefineIndex

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.