Struct Search 

pub struct Search<T: SurrealRecord> { /* private fields */ }

A full-text SELECT over a SEARCH-indexed field, reached from Table::search. Renders SELECT … FROM <table> WHERE field @@ 'query', and — once a match reference is set — can project search::score(n) and order by relevance.

Post::table()
    .search("body", "rust database")
    .score_as("score")     // SELECT *, search::score(0) AS score
    .order_by_score()      // ORDER BY search::score(0) DESC
    .limit(10)
    .to_surrealql();
// SELECT *, search::score(0) AS score FROM post
//   WHERE body @0@ 'rust database' ORDER BY score DESC LIMIT 10

Implementations

impl<T: SurrealRecord> Search<T>

pub fn reference(self, n: u8) -> Self

Set the match reference n explicitly (renders field @n@ 'query').

pub fn filter(self, expr: impl DynExpr + 'static) -> Self

AND an additional predicate onto the WHERE clause.

pub fn score_as(self, alias: impl Into<String>) -> Self

Project the relevance score as search::score(n) AS <alias>. Enables the match reference (@n@) so the score is computable.

pub fn order_by_score(self) -> Self

ORDER BY <score> DESC — most relevant first. Projects the score (default alias score) and enables the match reference, since ORDER BY sorts on the projected alias rather than the search::score(n) call directly.

pub fn limit(self, n: u32) -> Self

LIMIT n.

pub fn to_surrealql(&self) -> String

Render to a SurrealQL string with literals inlined.

pub fn to_surrealql_with_params(&self) -> (String, BTreeMap<String, Value>)

Render with $param placeholders (the search query becomes a bound param).

Trait Implementations

impl<T: SurrealRecord> Display for Search<T>

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

Formats the value using the given formatter.