Struct SQLQuery 

pub struct SQLQuery { /* private fields */ }

SQL-like query for Redis Search.

Holds a SQL SELECT statement and optional named parameters. Parameter placeholders use the :name syntax (e.g. :id, :product_id).

When used with SearchIndex::query(), the SQL is parsed and translated into a Redis Search FT.SEARCH filter string. Non-aggregate queries with WHERE, ORDER BY, LIMIT, and OFFSET clauses are supported.

Example

use redis_vl::{SQLQuery, SqlParam};

let query = SQLQuery::new("SELECT * FROM idx WHERE price > :min_price")
    .with_param("min_price", SqlParam::Float(99.99));

assert!(!query.substituted_sql().contains(":min_price"));
assert!(query.substituted_sql().contains("99.99"));

Implementations

impl SQLQuery

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

Creates an SQL query wrapper with no parameters.

pub fn with_params( sql: impl Into<String>, params: HashMap<String, SqlParam>, ) -> Self

Creates an SQL query with pre-populated parameters.

pub fn with_param(self, name: impl Into<String>, value: SqlParam) -> Self

Adds a single named parameter.

pub fn sql(&self) -> &str

Returns the raw SQL string.

pub fn params_map(&self) -> &HashMap<String, SqlParam>

Returns the parameter map.

pub fn substituted_sql(&self) -> String

Returns the SQL string with non-binary parameters substituted.

Uses a token-based approach: splits the SQL on :param boundaries to prevent partial matching (:id inside :product_id stays intact). Single quotes in string values are SQL-escaped (' → '').

pub fn is_aggregate(&self) -> bool

Returns true if this SQL query is an aggregate query (contains aggregate functions like COUNT, SUM, AVG, etc., or GROUP BY).

Aggregate queries are translated to FT.AGGREGATE rather than FT.SEARCH.

pub fn build_aggregate_cmd(&self, index_name: &str) -> Option<Cmd>

Builds an FT.AGGREGATE command for aggregate SQL queries.

Returns None if the SQL is not an aggregate query.

The index_name parameter is the Redis Search index to query.

pub fn is_vector_query(&self) -> bool

Returns true if this SQL query contains vector search functions (vector_distance() or cosine_distance()).

pub fn is_geo_aggregate(&self) -> bool

Returns true if this SQL query contains geo_distance() in the SELECT clause (which generates FT.AGGREGATE with APPLY geodistance).

pub fn build_geo_aggregate_cmd(&self, index_name: &str) -> Option<Cmd>

Builds an FT.AGGREGATE command for geo_distance in SELECT.

Returns None if the SQL doesn’t have geo_distance() in SELECT.

Trait Implementations

impl Clone for SQLQuery

fn clone(&self) -> SQLQuery

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SQLQuery

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

Formats the value using the given formatter.

impl QueryString for SQLQuery

fn to_redis_query(&self) -> String

Builds a Redis Search query string.

fn params(&self) -> Vec<QueryParam>

Query parameters used with Redis PARAMS.

fn return_fields(&self) -> Vec<String>

Return fields requested by the query.

fn sort_by(&self) -> Option<SortBy>

Sort order requested by the query.

fn limit(&self) -> Option<QueryLimit>

Limit clause requested by the query.

fn should_unpack_json(&self) -> bool

Whether JSON search results should be unpacked into top-level fields when no explicit projection is requested.

fn geofilter(&self) -> Option<GeoFilter>

Optional geo-spatial filter for FT.SEARCH GEOFILTER clause.

fn render(&self) -> QueryRender

Builds the full query render, including search options and params.

fn dialect(&self) -> u32

Query dialect.

fn in_order(&self) -> bool

Whether the query should use INORDER.

fn no_content(&self) -> bool

Whether the query should use NOCONTENT.

fn scorer(&self) -> Option<String>

Optional scorer.

fn kind(&self) -> QueryKind

The processed result shape for this query.