nodedb-sql 0.6.2

SQL parser, planner, and optimizer for NodeDB
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

// SPDX-License-Identifier: Apache-2.0

//! Which spatial predicates route a query to the R-tree index.
//!
//! Search routing is a planner concern, not a property of the function's
//! semantics, so it lives here rather than in the shared catalog. Only the
//! four predicates the spatial engine can answer from its index are routed;
//! every other geo function evaluates per-row.

use crate::functions::registry::SearchTrigger;

pub(super) fn search_trigger(canonical: &str) -> SearchTrigger {
    match canonical {
        "st_dwithin" => SearchTrigger::SpatialDWithin,
        "st_contains" => SearchTrigger::SpatialContains,
        "st_intersects" => SearchTrigger::SpatialIntersects,
        "st_within" => SearchTrigger::SpatialWithin,
        _ => SearchTrigger::None,
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use nodedb_query::geo_functions::catalog;

    /// Every routed predicate must exist in the catalog — a trigger for a
    /// name the catalog does not declare would never fire.
    #[test]
    fn routed_predicates_are_declared_in_the_catalog() {
        for name in ["st_dwithin", "st_contains", "st_intersects", "st_within"] {
            assert!(
                catalog::lookup(name).is_some(),
                "'{name}' is routed to the spatial index but is not in the catalog"
            );
            assert_ne!(search_trigger(name), SearchTrigger::None);
        }
    }

    #[test]
    fn unrouted_functions_evaluate_per_row() {
        assert_eq!(search_trigger("st_distance"), SearchTrigger::None);
        assert_eq!(search_trigger("st_astext"), SearchTrigger::None);
    }
}