Skip to main content

SearchIndexSpec

Struct SearchIndexSpec 

Source
pub struct SearchIndexSpec {
    pub kind: SearchKind,
    pub index_name: SmallName,
    pub for_expr: Expr,
    pub analyzer: Option<Expr>,
    pub inner_where: Option<Expr>,
    pub offset_expr: Option<Expr>,
    pub limit_expr: Expr,
}
Expand description

CIP-225 <index specification clause>: { VECTOR | FULLTEXT } INDEX <index name> <index for and control clause>.

Fields§

§kind: SearchKind

CIP-225: which index kind the specification names.

§index_name: SmallName

<index name specification>: the literal name of an existing index.

§for_expr: Expr

<for clause>’s <value expression> – the search query.

§analyzer: Option<Expr>

CIP-225 WITH ANALYZER <expr> (fulltext only).

§inner_where: Option<Expr>

CIP-240 “Vector Search with Single-stage Filtering”: the optional inner WHERE <search condition> between FOR <expr> and LIMIT <expr>. Its <search condition> must decompose into one or more <binding variable reference> <static property reference> <simple comp op> <arithmetic value expression> predicates joined by AND (or a form rewritable into that, e.g. NOT x.prop or flipped operands) – enforced by relate_front::search_filter, not here; the parser accepts any general <expression> here, exactly like MatchClause.where_expr.

§offset_expr: Option<Expr>

CIP-225 <offset clause> (SKIP/OFFSET).

§limit_expr: Expr

<limit clause>’s <value expression> (mandatory for an index source, in and out of a COMBINE).

Trait Implementations§

Source§

impl Clone for SearchIndexSpec

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for SearchIndexSpec

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for SearchIndexSpec

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for SearchIndexSpec

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.