linkrs-query 0.1.0

Query engine, parser, and executor for Linkrs
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

use crate::parser::ast::pattern::PathSemantic;
use linkrs_core::EdgeDirection;

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum TraversalKind {
    Expand,
    Traverse,
    ShortestPath,
    AllPaths,
    Subgraph,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum TraversalOrder {
    Bfs,
    Dfs,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum VisitedPolicy {
    Global,
    PerSeed,
    None,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum PathPolicy {
    VertexOnly,
    EdgeAndVertex,
    FullPath,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum EmitPolicy {
    EveryDepth,
    LeafOnly,
    DestinationOnly,
}

#[derive(Debug, Clone)]
pub struct TraversalConfig {
    pub kind: TraversalKind,
    pub direction: EdgeDirection,
    pub edge_types: Vec<String>,
    pub min_depth: u32,
    pub max_depth: u32,
    pub limit: usize,
    pub order: TraversalOrder,
    pub visited_policy: VisitedPolicy,
    pub path_policy: PathPolicy,
    pub emit_policy: EmitPolicy,
    pub space_name: String,
    /// Single neighbor tag for forced single-label traversal.
    pub vertex_tag: String,
    /// Optional path constraint from a variable-length pattern.
    pub path_semantic: Option<PathSemantic>,
}

impl TraversalConfig {
    pub fn expand(space_name: String, direction: EdgeDirection, edge_types: Vec<String>) -> Self {
        Self {
            kind: TraversalKind::Expand,
            direction,
            edge_types,
            min_depth: 1,
            max_depth: 1,
            limit: usize::MAX,
            order: TraversalOrder::Bfs,
            visited_policy: VisitedPolicy::None,
            path_policy: PathPolicy::EdgeAndVertex,
            emit_policy: EmitPolicy::EveryDepth,
            space_name,
            vertex_tag: String::new(),
            path_semantic: None,
        }
    }

    pub fn traverse(
        space_name: String,
        direction: EdgeDirection,
        min_depth: u32,
        max_depth: u32,
        edge_types: Vec<String>,
    ) -> Self {
        Self {
            kind: TraversalKind::Traverse,
            direction,
            edge_types,
            min_depth,
            max_depth,
            limit: usize::MAX,
            order: TraversalOrder::Dfs,
            visited_policy: VisitedPolicy::Global,
            path_policy: PathPolicy::VertexOnly,
            emit_policy: EmitPolicy::EveryDepth,
            space_name,
            vertex_tag: String::new(),
            path_semantic: None,
        }
    }
}