Skip to main content

SearchCommand

reddb_server::storage::query::ast

Enum SearchCommand 

Source 
pub enum SearchCommand {
    Similar {
        vector: Vec<f32>,
        text: Option<String>,
        provider: Option<String>,
        collection: String,
        limit: usize,
        min_score: f32,
        vector_param: Option<usize>,
        limit_param: Option<usize>,
        min_score_param: Option<usize>,
        text_param: Option<usize>,
    },
    Text {
        query: String,
        collection: Option<String>,
        limit: usize,
        fuzzy: bool,
        limit_param: Option<usize>,
    },
    Hybrid {
        vector: Option<Vec<f32>>,
        query: Option<String>,
        collection: String,
        limit: usize,
        limit_param: Option<usize>,
    },
    Multimodal {
        query: String,
        collection: Option<String>,
        limit: usize,
        limit_param: Option<usize>,
    },
    Index {
        index: String,
        value: String,
        collection: Option<String>,
        limit: usize,
        exact: bool,
        limit_param: Option<usize>,
    },
    Context {
        query: String,
        field: Option<String>,
        collection: Option<String>,
        limit: usize,
        depth: usize,
        limit_param: Option<usize>,
    },
    SpatialRadius {
        center_lat: f64,
        center_lon: f64,
        radius_km: f64,
        collection: String,
        column: String,
        limit: usize,
        limit_param: Option<usize>,
    },
    SpatialBbox {
        min_lat: f64,
        min_lon: f64,
        max_lat: f64,
        max_lon: f64,
        collection: String,
        column: String,
        limit: usize,
        limit_param: Option<usize>,
    },
    SpatialNearest {
        lat: f64,
        lon: f64,
        k: usize,
        collection: String,
        column: String,
        k_param: Option<usize>,
    },
}
Expand description

Search command issued via SQL-like syntax

Variants§

§

Similar

SEARCH SIMILAR [v1, v2, …] | $N | TEXT ‘query’ [COLLECTION col] [LIMIT n] [MIN_SCORE f] [USING provider]

Fields

§vector: Vec<f32>
§text: Option<String>
§provider: Option<String>
§collection: String
§limit: usize
§min_score: f32
§vector_param: Option<usize>

$N placeholder for the vector slot. Some(idx) when the SQL used SEARCH SIMILAR $N ...; the binder substitutes the user-supplied Value::Vector and clears this back to None. Runtime executors assert this is None post-bind.

§limit_param: Option<usize>

$N placeholder for the LIMIT slot (issue #361). The binder substitutes the user-supplied positive integer into limit and clears this back to None.

§min_score_param: Option<usize>

$N placeholder for the MIN_SCORE slot (issue #361). The binder substitutes the user-supplied float into min_score and clears this back to None.

§text_param: Option<usize>

$N placeholder for SEARCH SIMILAR TEXT $N (issue #361). Binder substitutes the user-supplied text into text and clears this back to None.

§

Text

SEARCH TEXT ‘query’ [COLLECTION col] [LIMIT n] [FUZZY]

Fields

§query: String
§collection: Option<String>
§limit: usize
§fuzzy: bool
§limit_param: Option<usize>

$N placeholder for the LIMIT slot (issue #361). Same shape as SearchCommand::Hybrid::limit_param; the binder substitutes the user-supplied positive integer into limit and clears this back to None.

§

Hybrid

SEARCH HYBRID [vector] [TEXT ‘query’] COLLECTION col [LIMIT n]

Fields

§vector: Option<Vec<f32>>
§query: Option<String>
§collection: String
§limit: usize
§limit_param: Option<usize>

$N placeholder for the LIMIT / K slot (issue #361). Same shape as SearchCommand::Similar::limit_param; the binder substitutes the user-supplied positive integer and clears this back to None.

§

Multimodal

SEARCH MULTIMODAL ‘key_or_query’ [COLLECTION col] [LIMIT n]

Fields

§query: String
§collection: Option<String>
§limit: usize
§limit_param: Option<usize>

$N placeholder for the LIMIT slot (issue #361). Same shape as SearchCommand::Hybrid::limit_param; the binder substitutes the user-supplied positive integer into limit and clears this back to None.

§

Index

SEARCH INDEX index VALUE ‘value’ [COLLECTION col] [LIMIT n] [EXACT]

Fields

§index: String
§value: String
§collection: Option<String>
§limit: usize
§exact: bool
§limit_param: Option<usize>

$N placeholder for the LIMIT slot (issue #361). Same shape as SearchCommand::Hybrid::limit_param; the binder substitutes the user-supplied positive integer into limit and clears this back to None.

§

Context

SEARCH CONTEXT ‘query’ [FIELD field] [COLLECTION col] [LIMIT n] [DEPTH n]

Fields

§query: String
§field: Option<String>
§collection: Option<String>
§limit: usize
§depth: usize
§limit_param: Option<usize>

$N placeholder for the LIMIT slot (issue #361). Same shape as SearchCommand::Hybrid::limit_param; the binder substitutes the user-supplied positive integer into limit and clears this back to None.

§

SpatialRadius

SEARCH SPATIAL RADIUS lat lon radius_km COLLECTION col COLUMN col [LIMIT n]

Fields

§center_lat: f64
§center_lon: f64
§radius_km: f64
§collection: String
§column: String
§limit: usize
§limit_param: Option<usize>

$N placeholder for the LIMIT slot (issue #361). Same shape as SearchCommand::Hybrid::limit_param; the binder substitutes the user-supplied positive integer into limit and clears this back to None.

§

SpatialBbox

SEARCH SPATIAL BBOX min_lat min_lon max_lat max_lon COLLECTION col COLUMN col [LIMIT n]

Fields

§min_lat: f64
§min_lon: f64
§max_lat: f64
§max_lon: f64
§collection: String
§column: String
§limit: usize
§limit_param: Option<usize>

$N placeholder for the LIMIT slot (issue #361). Same shape as SearchCommand::Hybrid::limit_param; the binder substitutes the user-supplied positive integer into limit and clears this back to None.

§

SpatialNearest

SEARCH SPATIAL NEAREST lat lon K n COLLECTION col COLUMN col

Fields

§lat: f64
§lon: f64
§k: usize
§collection: String
§column: String
§k_param: Option<usize>

$N placeholder for the K slot (issue #361). Same shape as SearchCommand::Hybrid::limit_param; the binder substitutes the user-supplied positive integer into k and clears this back to None.

Trait Implementations§

Source§

impl Clone for SearchCommand

Source§

fn clone(&self) -> SearchCommand

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 SearchCommand

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> 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> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<L> LayerExt<L> for L

Source§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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