Skip to main content

IrFtsSearch

Struct IrFtsSearch 

Source
pub struct IrFtsSearch {
Show 15 fields pub source: IrSource, pub backend: SearchBackend, pub search_col: String, pub tsquery_fn: &'static str, pub query_expr: IrExpr, pub object_shape: Vec<IrShapePointer>, pub filter: Option<IrExpr>, pub order_by_rank: Option<IrSortDir>, pub offset: Option<IrExpr>, pub limit: Option<IrExpr>, pub deferred_index_name: Option<String>, pub deferred_query_param_name: Option<String>, pub deferred_query_literal: Option<String>, pub deferred_ids_param: Option<usize>, pub deferred_scores_param: Option<usize>,
}
Expand description

select fts::search(Type, $query) { object { … }, score }

Emits a SELECT with a WHERE tsvector @@ tsquery filter and a ts_rank score returned alongside the matched object.

Fields§

§source: IrSource

The searched type as an IrSource (table + alias).

§backend: SearchBackend

Backend that owns this search index.

§search_col: String

tsvector column name, e.g. __search__ (Postgres backend only).

§tsquery_fn: &'static str

PostgreSQL tsquery constructor (Postgres backend only).

§query_expr: IrExpr

The query text expression (e.g. $1).

§object_shape: Vec<IrShapePointer>

Pointers to include in the object sub-tuple.

§filter: Option<IrExpr>§order_by_rank: Option<IrSortDir>§offset: Option<IrExpr>§limit: Option<IrExpr>§deferred_index_name: Option<String>

Remote index name (derived from type + index_name, set for deferred backends).

§deferred_query_param_name: Option<String>

Name of the user’s query-text param (e.g. “query”), for the deferred search plan.

§deferred_query_literal: Option<String>

Inline literal query text (when not a param), for the deferred search plan.

§deferred_ids_param: Option<usize>

Param index for the uuid[] IDs injected by the Python layer (deferred backend).

§deferred_scores_param: Option<usize>

Param index for the float8[] scores injected by the Python layer (deferred backend).

Trait Implementations§

Source§

impl Clone for IrFtsSearch

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 IrFtsSearch

Source§

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

Formats the value using the given formatter. Read more

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> ArchivePointee for T

Source§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
Source§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> LayoutRaw for T

Source§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Returns the layout of the type.
Source§

impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
where T: SharedNiching<N1, N2>, N1: Niching<T>, N2: Niching<T>,

Source§

unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool

Returns whether the given value has been niched. Read more
Source§

fn resolve_niched(out: Place<NichedOption<T, N1>>)

Writes data to out indicating that a T is niched.
Source§

impl<T> Pointee for T

Source§

type Metadata = ()

The metadata type for pointers and references to this type.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more