flusso-query 0.5.0

Backend-neutral OpenSearch/Elasticsearch query client for flusso indexes.
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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238

//! Field handles. Each handle carries a field path **and a scope** `S`, and
//! exposes only the operators its mapping type supports; every operator builds a
//! [`Query`]`<S>`.
//!
//! Root fields and flattened object / to-one-join sub-fields are scope
//! [`Root`](crate::Root); a `nested` array's element handles carry the element type as their
//! scope, so their queries must be lifted with [`Nested::any`]/[`Nested::all`]
//! before joining a parent query. (The derive picks the right scope; hand-written
//! handles default to `Root`.)
//!
//! The handles are grouped by field family:
//!
//! - `string` — [`Keyword`], [`Text`], and the cross-field [`multi_match`].
//! - `scalar` — [`Bool`], [`Number`], [`Date`] (exact/range value fields).
//! - `map` — [`TextMap`]/[`KeywordMap`] dynamic-key objects and [`MapSearch`].
//! - `nested` — [`Nested`] arrays and their [`NestedProjection`].
//! - `object` — [`Object`] sub-documents and the opaque [`Binary`]/[`Json`] fields.
//! - `geo` — [`Geo`] points and [`GeoPoint`].
//! - `sort` — [`Sort`]/[`SortOrder`].
//!
//! This module holds the pieces they share: the leaf-query builders and the
//! [`trait@FlussoValue`] type-kind machinery.

use serde_json::{Map, Value};

use crate::query::Query;

mod compound;
mod extra;
mod geo;
mod map;
mod nested;
mod object;
mod scalar;
mod sort;
mod string;

pub use compound::{
    BoostingQuery, ConstantScoreQuery, DisMaxQuery, FunctionScoreQuery, boosting, constant_score,
    dis_max, function_score,
};
pub use extra::{
    CombinedFieldsQuery, DistanceFeatureQuery, IdsQuery, MoreLikeThisQuery, QueryStringQuery,
    RankFeatureQuery, ScriptQuery, ScriptScoreQuery, SimpleQueryStringQuery, combined_fields,
    distance_feature, ids, more_like_this, query_string, rank_feature, script, script_score,
    simple_query_string,
};
pub use geo::{Geo, GeoDistanceQuery, GeoPoint};
pub use map::{DateMap, KeywordMap, MapSearch, NumberMap, TextMap};
pub use nested::{Nested, NestedProjection, NestedQuery};
pub use object::{Binary, Json, Object};
pub use scalar::{Bool, Date, EqQuery, Number, RangeQuery, TermsQuery};
pub use sort::{Sort, SortMode, SortOrder};
pub use string::{
    FuzzyQuery, Keyword, MatchQuery, MultiMatchQuery, PrefixQuery, RegexpQuery, TermQuery, Text,
    WildcardQuery, multi_match,
};

/// `{ "<wrapper>": { "<path>": <value> } }`.
fn single<S>(wrapper: &str, path: &str, value: Value) -> Query<S> {
    let mut inner = Map::new();
    inner.insert(path.to_string(), value);
    wrap(wrapper, inner)
}

/// `{ "<wrapper>": { <body> } }`.
fn wrap<S>(wrapper: &str, body: Map<String, Value>) -> Query<S> {
    let mut outer = Map::new();
    outer.insert(wrapper.to_string(), Value::Object(body));
    Query::leaf(Value::Object(outer))
}

/// The universal leaf-query modifiers every builder carries: `boost` (a
/// relevance multiplier) and `name` (`_name`, surfaced in a hit's
/// `matched_queries`). Builders embed one and call [`Common::write`] when
/// rendering.
#[derive(Debug, Clone, Default)]
pub(crate) struct Common {
    boost: Option<f32>,
    name: Option<String>,
}

impl Common {
    pub(crate) fn set_boost(&mut self, boost: f32) {
        self.boost = Some(boost);
    }

    pub(crate) fn set_name(&mut self, name: String) {
        self.name = Some(name);
    }

    /// Whether neither modifier is set (so a builder may render the shorthand).
    pub(crate) fn is_empty(&self) -> bool {
        self.boost.is_none() && self.name.is_none()
    }

    /// Write `boost` / `_name` into an option map, if set.
    pub(crate) fn write(&self, map: &mut Map<String, Value>) {
        if let Some(boost) = self.boost {
            map.insert("boost".to_string(), Value::from(boost));
        }
        if let Some(name) = &self.name {
            map.insert("_name".to_string(), Value::String(name.clone()));
        }
    }
}

/// Emit the universal `boost` / `name` setters on a builder whose [`Common`]
/// lives in `self.$field`. Keeps the two methods identical across every builder.
macro_rules! common_opts {
    ($field:ident) => {
        /// Multiply this clause's relevance score by `boost`.
        #[must_use]
        pub fn boost(mut self, boost: f32) -> Self {
            self.$field.set_boost(boost);
            self
        }

        /// Tag this clause with `_name`, surfaced in a hit's `matched_queries`.
        #[must_use]
        pub fn name(mut self, name: impl Into<String>) -> Self {
            self.$field.set_name(name.into());
            self
        }
    };
}
pub(crate) use common_opts;

/// Render `{ wrapper: { path: <value> } }` (the DSL shorthand) when `opts` is
/// empty, else `{ wrapper: { path: { <key>: <value>, ...opts } } }`. The shared
/// shape for the value-bearing leaf queries (`term`/`prefix`/`wildcard`/… with
/// `key = "value"`; `match`/`match_phrase`/… with `key = "query"`).
fn keyed_value_query<S>(
    wrapper: &str,
    path: &str,
    key: &str,
    value: Value,
    mut opts: Map<String, Value>,
) -> Query<S> {
    if opts.is_empty() {
        single(wrapper, path, value)
    } else {
        opts.insert(key.to_string(), value);
        single(wrapper, path, Value::Object(opts))
    }
}

/// `{ "exists": { "field": "<path>" } }`.
fn exists_q<S>(path: &str) -> Query<S> {
    let mut inner = Map::new();
    inner.insert("field".to_string(), Value::String(path.to_string()));
    let mut outer = Map::new();
    outer.insert("exists".to_string(), Value::Object(inner));
    Query::leaf(Value::Object(outer))
}

/// `{ "match_all": {} }`.
pub(crate) fn match_all_value() -> Value {
    let mut outer = Map::new();
    outer.insert("match_all".to_string(), Value::Object(Map::new()));
    Value::Object(outer)
}

/// Field-category markers for [`trait@FlussoValue`]. Zero-size and uninhabited — they
/// exist only as the `K` type parameter, so one type can be a valid value for
/// several kinds (e.g. `String` is a [`kind::Keyword`], [`kind::Text`], and
/// [`kind::Date`] value).
pub mod kind {
    /// A `keyword` field — an exact string.
    #[derive(Debug)]
    pub enum Keyword {}
    /// A `text` field — an analyzed string.
    #[derive(Debug)]
    pub enum Text {}
    /// A numeric field (`byte`…`double`, `scaled_float`).
    #[derive(Debug)]
    pub enum Number {}
    /// A `date`/`timestamp` field — an ISO-8601 string.
    #[derive(Debug)]
    pub enum Date {}
}

/// A Rust type usable where a field of kind `K` is expected: as the field type
/// in a `#[derive(FlussoDocument)]` struct, and (for [`kind::Keyword`]) as a
/// query value on [`Keyword::eq`]/[`Keyword::in_`].
///
/// Built-in leaf types are pre-implemented (`String`/`&str` for keyword, the
/// numeric primitives for number, …). Custom enums and newtype wrappers opt in
/// with `#[derive(FlussoValue)]` (e.g. a `Pro`/`Enterprise`/`Free` tier enum →
/// `Account::tier().eq(AccountTier::Pro)`, matched against its serde string).
/// `FlussoDocument` emits a deferred bound on this trait for any non-primitive
/// field type, so a document only compiles when the type genuinely fits.
#[diagnostic::on_unimplemented(
    message = "`{Self}` is not a valid value for a `{K}` field",
    label = "unsupported field type",
    note = "use a built-in leaf type, or add `#[derive(FlussoValue)]` (with the matching kind) to `{Self}`"
)]
pub trait FlussoValue<K> {}

impl FlussoValue<kind::Keyword> for String {}
impl FlussoValue<kind::Keyword> for &str {}
#[cfg(feature = "uuid")]
impl FlussoValue<kind::Keyword> for uuid::Uuid {}
#[cfg(feature = "uuid")]
impl FlussoValue<kind::Keyword> for &uuid::Uuid {}

impl FlussoValue<kind::Text> for String {}
impl FlussoValue<kind::Text> for &str {}

impl FlussoValue<kind::Number> for i8 {}
impl FlussoValue<kind::Number> for i16 {}
impl FlussoValue<kind::Number> for i32 {}
impl FlussoValue<kind::Number> for i64 {}
impl FlussoValue<kind::Number> for f32 {}
impl FlussoValue<kind::Number> for f64 {}
#[cfg(feature = "decimal")]
impl FlussoValue<kind::Number> for crate::Decimal {}

impl FlussoValue<kind::Date> for String {}

/// A Rust type usable as the **document type** of a `map` field of value kind
/// `K`: a dynamic-key object whose values are all of kind `K`.
///
/// The canonical map type — `HashMap<String, V>` where `V` is a `K` value — is
/// pre-implemented via a blanket impl, so `HashMap<String, String>` is a valid
/// `text`/`keyword` map and `HashMap<String, i64>` a valid `long` map with no
/// extra code. A whole-map newtype wrapper (`struct Translations(HashMap<…>)`)
/// opts in with `#[derive(FlussoMap)]`. `FlussoDocument` emits a deferred bound
/// on this trait for a `map` field, so the document only compiles when its type
/// genuinely fits the declared value kind.
#[diagnostic::on_unimplemented(
    message = "`{Self}` is not a valid map for a `{K}` field",
    label = "unsupported map type",
    note = "use `HashMap<String, V>` with a `{K}` value type, or add `#[derive(FlussoMap)]` (with the matching kind) to `{Self}`"
)]
pub trait FlussoMap<K> {}

impl<K, V: FlussoValue<K>> FlussoMap<K> for std::collections::HashMap<String, V> {}