qql-core 0.4.1

Parser, typed AST, validation, and transformations for the Qdrant Query Language
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56

//! Parameter binding and prepared query substitution.
//!
//! Provides type-safe substitution of named (`:name`) and positional (`?`)
//! parameter placeholders in QQL query text.
//!
//! ### Placeholders & Syntax Rules
//!
//! - **Named placeholders**: `:name` (e.g. `:category`, `:limit`).
//! - **Positional placeholders**: `?` (sequential 1-to-1 mapping with parameters list).
//!
//! In QQL, `$` is a first-class identifier character (e.g. `$category`, `$1`), so
//! parameter placeholders exclusively use `:name` and `?`. This guarantees that
//! `$`-prefixed identifiers in queries are never accidentally or silently rewritten.
//!
//! Furthermore, a colon `:` is only recognized as a parameter placeholder when it occurs
//! at a valid token boundary (preceded by whitespace, punctuation, or start of query).
//! Colons in compact dictionary syntax (e.g. `{a:b}`, `{'a':b}`) are not placeholders
//! and are preserved without modification. Note that unconventional spacing with whitespace
//! before the colon (`{a :b}`) makes `:b` lexically indistinguishable from a placeholder.
//!
//! Literals and dictionary keys are safely formatted and escaped to prevent
//! query injection breakouts. String literals (`'...'`, `r'...'`, `"""..."""`,
//! and `` `...` ``) and comments (`-- ...`) in the source query are preserved
//! verbatim and never substituted.
//!
//! `params` (typed `Value`) and `params_json` (JSON `serde_json::Value`) are
//! dual contracts that must stay in lockstep: a binding-rule fix in one must
//! be ported to the other. JSON is the host-SDK round-trip; typed `Value` is
//! the zero-copy FFI fast path (`F32Array`, packed multivector).

pub(crate) mod ast;
pub(crate) mod filter;
pub(crate) mod formula;
pub(crate) mod input;
pub(crate) mod render;
pub(crate) mod scan;
pub(crate) mod text;
pub(crate) mod validate;
pub(crate) mod validate_collect;
pub(crate) mod value;

#[cfg(test)]
mod tests;

pub use ast::{bind_page_spec, bind_query_expr, bind_query_stmt, bind_stmt};
pub use filter::{bind_filter, bind_point_selector};
pub use formula::bind_formula;
pub use input::bind_query_input;
pub use render::{escape_str_literal, truncate_vector_literals, value_to_literal};
pub use scan::{ident_at, is_ident_continue, is_ident_start, is_placeholder_start, skip_protected};
pub use text::{bind_named, bind_named_readable, bind_positional, bind_positional_readable};
pub use validate::{
    collect_statement_params, stmt_has_point_params, validate_no_unbound_params,
    validate_no_unbound_scalar_params,
};
pub use value::{bind_point_id, bind_shard_key, bind_value, resolve_param_u64};