Struct VectorSearchQuery 

pub struct VectorSearchQuery {
    pub table: String,
    pub embedding_column: String,
    pub select_columns: Vec<String>,
    pub distance_metric: DistanceMetric,
    pub limit: u32,
    pub where_clause: Option<String>,
    pub order_by: Option<String>,
    pub include_distance: bool,
    pub offset: Option<u32>,
}

Configuration for a similarity search query.

Fields

table: String

Table or view to query.

embedding_column: String

Column containing the vector embedding.

select_columns: Vec<String>

Columns to select (empty = all).

distance_metric: DistanceMetric

Distance metric to use.

limit: u32

Maximum number of results.

where_clause: Option<String>

Optional WHERE clause (without “WHERE” keyword).

order_by: Option<String>

Optional additional ORDER BY clause (applied after distance ordering).

include_distance: bool

Whether to include the distance score in results.

offset: Option<u32>

Optional offset for pagination.

Implementations

impl VectorSearchQuery

pub fn new(table: impl Into<String>) -> Self

Create a new search query for a table.

pub fn with_embedding_column(self, column: impl Into<String>) -> Self

Set the embedding column.

pub fn with_select_columns(self, columns: Vec<String>) -> Self

Set the columns to select.

pub fn with_distance_metric(self, metric: DistanceMetric) -> Self

Set the distance metric.

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

Set the result limit.

pub fn with_where(self, clause: impl Into<String>) -> Self

Set a WHERE clause filter.

pub fn with_distance_score(self) -> Self

Include distance score in results.

pub fn with_offset(self, offset: u32) -> Self

Set pagination offset.

Trait Implementations

impl Clone for VectorSearchQuery

fn clone(&self) -> VectorSearchQuery

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VectorSearchQuery

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

Formats the value using the given formatter.

impl Default for VectorSearchQuery

fn default() -> Self

Returns the “default value” for a type.