Struct Select 

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

A SELECT statement builder: projections, WHERE, ORDER BY, LIMIT, START, FETCH, GROUP BY/GROUP ALL, count(), and the modifiers VALUE/OMIT/SPLIT/WITH/TIMEOUT/EXPLAIN.

Implementations

impl<T: SurrealRecord> Select<T>

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

pub fn with_path(self, path: Path, alias: &'static str) -> Self

Add a <path> AS <alias> graph-traversal projection to the select list. Appends to any existing projections, so select(T::all()).with_path(p, "x") renders SELECT *, <path> AS x (a * is emitted only when the list is otherwise empty).

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

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

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

pub fn group_by<C: DynExpr>(self, col: C) -> Self

pub fn group_all(self) -> Self

GROUP ALL (whole-table aggregate, e.g. with count()).

pub fn count_as(self, alias: &'static str) -> Self

Alias for the count() projection: SELECT count() AS <alias>.

pub fn value(self) -> Self

SELECT VALUE … — return bare values instead of field-wrapping objects. Pair with a single projection (e.g. project(vec![col("name")]).value()).

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

OMIT <field> — exclude a field from a SELECT *.

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

SPLIT <field> — fan one row out into multiple rows by an array field.

pub fn with_index<I, S>(self, indexes: I) -> Self

where I: IntoIterator<Item = S>, S: AsRef<str>,

WITH INDEX <a, b> — force the planner to use the named index(es).

pub fn with_no_index(self) -> Self

WITH NOINDEX — force a table scan (ignore indexes).

pub fn timeout(self, duration: impl Into<String>) -> Self

TIMEOUT <duration> — abort the query after the given duration (e.g. "5s").

pub fn from_subquery(self, sub: Select<T>) -> Self

SELECT … FROM (<subquery>) — read from a subquery instead of the base table. The subquery (a Select<T> of the same record type) renders parenthesized in place of the table name.

pub fn explain(self) -> Self

EXPLAIN — return the query plan instead of results.

pub fn explain_full(self) -> Self

EXPLAIN FULL — return the query plan with execution detail.

pub fn order_by<C: DynExpr>(self, col: C, dir: Order) -> Self

pub fn order_asc<C: DynExpr>(self, col: C) -> Self

pub fn order_desc<C: DynExpr>(self, col: C) -> Self

pub fn to_surrealql(&self) -> String

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

Render the statement with $param placeholders instead of inlined literals, returning the SQL string and a map of parameter name to value. Literal values become numbered $p0, $p1, …; explicit Param wrappers use their declared name.

Trait Implementations

impl<T: SurrealRecord> Debug for Select<T>

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

Formats the value using the given formatter.

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

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

Formats the value using the given formatter.

impl<T: SurrealRecord> DynExpr for Select<T>

A Select is usable as an expression — rendered parenthesized — so it can be embedded as a subquery: a scalar/IN operand in a WHERE, a projection, or a SET/FROM value. Params from the subquery merge into the parent’s map.

fn render_dyn(&self, buf: &mut String)

Append this expression’s SurrealQL to buf with all values inlined.

fn render_dyn_params( &self, buf: &mut String, params: &mut BTreeMap<String, Value>, )

Render with $param placeholders, collecting values into params. Default falls back to inline rendering; Literal nodes override this to emit $pN placeholders and collect their value.