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
// Copyright (c) 2026 Austin Han <austinhan1024@gmail.com>
//
// This file is part of RocksGraph.
//
// RocksGraph is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 2 of the License, or
// (at your option) any later version.
//
// RocksGraph is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with RocksGraph. If not, see <https://www.gnu.org/licenses/>.
use crate::types::{PIPELINE_PRODUCE_SIZE, SMALL_VECTOR_LENGTH};
use std::rc::Rc;
use smallvec::{smallvec, SmallVec};
use crate::engine::volcano::steps::traits::ExplainNode;
use crate::{
engine::{
context::GraphCtx,
traverser::Traverser,
volcano::steps::traits::{CoreStep, StepRef},
},
types::{error::StoreError, keys::CanonicalKey, prop_key::LABEL_KEY_ID, GValue},
};
use smol_str::SmolStr;
/// A physical step that extracts property values from the elements carried by incoming traversers.
#[derive(Debug)]
pub struct ValuesStep {
// ── Upstream link ──
upstream: Option<StepRef>,
// ── Static/Fixed configuration ──
/// Specific property keys to extract as (name, key_id) pairs.
property_keys: SmallVec<[(SmolStr, u16); SMALL_VECTOR_LENGTH]>,
/// Whether to emit properties as `GValue::Property` (true) or their raw scalar values (false).
emit_property: bool,
/// Whether to link the parent chain on emitted traversers (`false` skips the `Rc::clone`
/// when the plan has no `as()`/`select()`/`path()` anywhere in it).
track_path: bool,
}
/// Creates a new `ValuesStep` to extract specified property values.
impl ValuesStep {
pub fn new(
property_keys: SmallVec<[(SmolStr, u16); SMALL_VECTOR_LENGTH]>,
emit_property: bool,
track_path: bool,
) -> Self {
Self { upstream: None, property_keys, emit_property, track_path }
}
}
impl CoreStep for ValuesStep {
fn add_upper(&mut self, upstream: StepRef) {
// Sets the upstream step for this property extraction.
self.upstream = Some(upstream);
}
fn produce(
&mut self,
ctx: &mut dyn GraphCtx,
) -> Result<Option<SmallVec<[Rc<Traverser>; PIPELINE_PRODUCE_SIZE]>>, StoreError> {
// Produces traversers carrying the extracted property values (either as `GValue::Scalar` or
// `GValue::Property`).
loop {
let Some(upstream) = self.upstream.as_ref() else { return Ok(None) };
let Some(t) = upstream.next(ctx)? else { return Ok(None) };
let canonical_key = match &t.value {
GValue::Vertex(vt) => CanonicalKey::Vertex(*vt),
GValue::Edge(eg) => CanonicalKey::Edge(eg.canonical_edge_key()),
other => {
return Err(StoreError::UnexpectedDataType(format!(
"values() expects a Vertex or Edge, got {:?}",
other
)))
}
};
if self.property_keys.is_empty() {
// Empty property_keys → fetch all properties (TinkerPop convention).
if let Some((_, props)) = ctx.get_all_props(&canonical_key)? {
let mut results = smallvec![];
if self.emit_property {
let schema = ctx.schema();
let guard = schema.read().unwrap();
for (name, value) in props {
let Some(key_id) = guard.prop_key_id(&name) else { continue };
let mut val = value;
if key_id == LABEL_KEY_ID {
val = guard.decode_label_value(&canonical_key, val);
}
results.push(Traverser::new_rc_conditional(
GValue::Property(crate::types::element::Property {
owner: canonical_key,
key: key_id,
value: val,
}),
&t,
self.track_path,
));
}
} else {
let schema = ctx.schema();
let guard = schema.read().unwrap();
for (name, value) in props {
let mut val = value;
if name == crate::types::prop_key::LABEL {
val = guard.decode_label_value(&canonical_key, val);
}
results.push(Traverser::new_rc_conditional(GValue::Scalar(val), &t, self.track_path));
}
}
if !results.is_empty() {
return Ok(Some(results));
}
}
continue;
}
let mut results = smallvec![];
if self.emit_property {
for (_, key_id) in &self.property_keys {
if let Some(mut value) = ctx.get_property(&canonical_key, *key_id)? {
if *key_id == LABEL_KEY_ID {
let schema_guard = ctx.schema();
value.value = schema_guard.read().unwrap().decode_label_value(&canonical_key, value.value);
}
results.push(Traverser::new_rc_conditional(GValue::Property(value), &t, self.track_path));
}
}
} else {
for (_, key_id) in &self.property_keys {
if let Some(mut value) = ctx.get_value(&canonical_key, *key_id)? {
if *key_id == LABEL_KEY_ID {
let schema_guard = ctx.schema();
value = schema_guard.read().unwrap().decode_label_value(&canonical_key, value);
}
results.push(Traverser::new_rc_conditional(GValue::Scalar(value), &t, self.track_path));
}
}
}
if !results.is_empty() {
return Ok(Some(results));
}
}
}
fn reset(&mut self) {
// Resets the state of this step and its upstream.
if let Some(up) = &self.upstream {
up.reset();
}
}
fn upper(&self) -> Option<StepRef> {
// Returns a clone of the upstream step reference.
self.upstream.clone()
}
fn explain(&self) -> ExplainNode {
let params = vec![("keys", format!("{:?}", self.property_keys))];
ExplainNode::new("ValuesStep").with_params(params)
}
}