uni-query 2.1.0

OpenCypher query parser, planner, and vectorized executor for Uni
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

#![allow(dead_code, unused_imports, clippy::all)]
//! M5b — verify replacement-scan providers are reachable via the registry
//! and gated by the `replacement_scans_enabled` config (default off).
//
// Rust guideline compliant

use std::sync::Arc;

use uni_plugin::traits::catalog::{
    CatalogTable, Replacement, ReplacementRequest, ReplacementScanProvider,
};
use uni_plugin::{
    Capability, CapabilitySet, FnError, PluginId, PluginRegistrar, PluginRegistry, QName,
};

#[derive(Debug)]
struct FunctionRerouteScan;

impl ReplacementScanProvider for FunctionRerouteScan {
    fn replace(&self, request: &ReplacementRequest<'_>) -> Option<Replacement> {
        match request {
            ReplacementRequest::Function(q) if q.local() == "missing_fn" => {
                Some(Replacement::Function(QName::new("uni", "abs")))
            }
            _ => None,
        }
    }
}

#[test]
fn replacement_scan_provider_reachable_via_registry() {
    let registry = Arc::new(PluginRegistry::default());
    let plugin_id = PluginId::new("test_rs");
    let caps = CapabilitySet::from_iter_of([Capability::Catalog]);
    let mut r = PluginRegistrar::new(plugin_id, &caps, &registry);
    r.replacement_scan(Arc::new(FunctionRerouteScan)).unwrap();
    r.commit_to_registry().unwrap();

    let scans = registry.replacement_scans();
    assert_eq!(scans.len(), 1);
    let q = QName::new("uni", "missing_fn");
    let result = scans[0].replace(&ReplacementRequest::Function(&q));
    assert!(matches!(result, Some(Replacement::Function(_))));
    let q_other = QName::new("uni", "other");
    assert!(
        scans[0]
            .replace(&ReplacementRequest::Function(&q_other))
            .is_none()
    );
}

// ── Label-replacement reachability ──────────────────────────────────

/// Stub `CatalogTable` returned by the label-replacement provider; we
/// only assert the registry consultation returns this table, not that
/// the planner wires it into a real plan (that work is deferred —
/// virtual label-id allocation is a prerequisite).
#[derive(Debug)]
struct StubCatalogTable;

impl CatalogTable for StubCatalogTable {
    fn schema(&self) -> arrow_schema::SchemaRef {
        Arc::new(arrow_schema::Schema::empty())
    }
    fn scan(
        &self,
        _proj: Option<&[usize]>,
        _filters: &[datafusion::logical_expr::Expr],
        _limit: Option<usize>,
    ) -> Result<datafusion::execution::SendableRecordBatchStream, FnError> {
        Err(FnError::new(0, "unused in this test"))
    }
}

#[derive(Debug)]
struct LabelReplacementScan;

impl ReplacementScanProvider for LabelReplacementScan {
    fn replace(&self, request: &ReplacementRequest<'_>) -> Option<Replacement> {
        if let ReplacementRequest::Label(name) = request
            && *name == "External"
        {
            return Some(Replacement::CatalogTable(Arc::new(StubCatalogTable)));
        }
        None
    }
}

/// Reachability test for the new `Label` replacement-request branch.
///
/// The planner-side rewrite for label-replacement is blocked on
/// virtual-label-id allocation (deferred to Batch 3, see plan doc).
/// This test exercises the registry consultation site directly so
/// the wiring is covered end-to-end at the surface available today.
#[test]
fn label_replacement_scan_reachable_via_registry() {
    let registry = Arc::new(PluginRegistry::default());
    let plugin_id = PluginId::new("test_rs_label");
    let caps = CapabilitySet::from_iter_of([Capability::Catalog]);
    let mut r = PluginRegistrar::new(plugin_id, &caps, &registry);
    r.replacement_scan(Arc::new(LabelReplacementScan)).unwrap();
    r.commit_to_registry().unwrap();

    let scans = registry.replacement_scans();
    assert_eq!(scans.len(), 1);
    let hit = scans[0].replace(&ReplacementRequest::Label("External"));
    assert!(
        matches!(hit, Some(Replacement::CatalogTable(_))),
        "registry consultation must yield CatalogTable replacement",
    );
    let miss = scans[0].replace(&ReplacementRequest::Label("Other"));
    assert!(miss.is_none(), "unknown label must not resolve");
}