Struct VectorSearchQuery 

pub struct VectorSearchQuery {

    pub table: String,
    pub column: String,
    pub query_vector: Embedding,
    pub metric: DistanceMetric,
    pub limit: usize,
    pub select_columns: Vec<String>,
    pub where_clauses: Vec<String>,
    pub include_distance: bool,
    pub distance_alias: String,
    pub max_distance: Option<f64>,
    pub min_distance: Option<f64>,
    pub extra_order_by: Vec<String>,
    pub offset: Option<usize>,
    pub search_params: SearchParams,
}

A fully constructed vector search query ready for execution.

Fields

table: String

The table to search.

column: String

The vector column.

query_vector: Embedding

The query vector.

metric: DistanceMetric

Distance metric.

limit: usize

Maximum number of results.

select_columns: Vec<String>

Columns to select (empty = all).

where_clauses: Vec<String>

Additional WHERE conditions.

include_distance: bool

Whether to include the distance in results.

distance_alias: String

Alias for the distance column.

max_distance: Option<f64>

Maximum distance threshold (radius search).

min_distance: Option<f64>

Minimum distance threshold.

extra_order_by: Vec<String>

Additional ORDER BY clauses (after distance).

offset: Option<usize>

Offset for pagination.

search_params: SearchParams

Search parameters (probes, ef_search).

Implementations

impl VectorSearchQuery

pub fn to_sql(&self) -> String

Generate the complete SQL query.

The query vector should be passed as parameter $1.

pub fn to_sql_with_param(&self, param_index: usize) -> String

Generate the complete SQL query with a custom parameter index.

pub fn param_set_sql(&self) -> Vec<String>

Generate SET commands for search parameters.

These should be executed before the search query to tune index scan behavior.

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<'de> Deserialize<'de> for VectorSearchQuery

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for VectorSearchQuery

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.