reifydb-core 0.4.12

Core database interfaces and data structures for ReifyDB
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
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
// SPDX-License-Identifier: Apache-2.0
// Copyright (c) 2025 ReifyDB

use reifydb_type::{
	fragment::Fragment,
	util::{bitvec::BitVec, cowvec::CowVec},
	value::{Value, datetime::DateTime, row_number::RowNumber, r#type::Type},
};

use crate::{
	encoded::{row::EncodedRow, shape::RowShape},
	interface::catalog::dictionary::Dictionary,
	value::column::{Column, columns::Columns, data::ColumnData},
};

/// Metadata for a column in a lazy batch
#[derive(Debug, Clone)]
pub struct LazyColumnMeta {
	/// Column name
	pub name: Fragment,
	/// Type as stored in encoded form (e.g., Uint2 for dictionary ID)
	pub storage_type: Type,
	/// Type after decoding (e.g., Utf8 for dictionary value)
	pub output_type: Type,
	/// Dictionary definition if this column uses dictionary encoding
	pub dictionary: Option<Dictionary>,
}

/// A batch of rows that defers column materialization until needed.
///
/// This allows filters to evaluate predicates on encoded data and only
/// materialize the rows that pass the filter.
#[derive(Debug, Clone)]
pub struct LazyBatch {
	/// Encoded row data
	rows: Vec<EncodedRow>,
	/// Row numbers from storage
	row_numbers: Vec<RowNumber>,
	/// RowShape for interpreting encoded rows
	shape: RowShape,
	/// Column metadata (names, types, dictionary defs)
	column_metas: Vec<LazyColumnMeta>,
	/// Validity bitmap - rows that passed filters (true = valid)
	validity: BitVec,
}

impl LazyBatch {
	pub fn new(
		rows: Vec<EncodedRow>,
		row_numbers: Vec<RowNumber>,
		shape: &RowShape,
		column_metas: Vec<LazyColumnMeta>,
	) -> Self {
		debug_assert_eq!(rows.len(), row_numbers.len());
		debug_assert_eq!(shape.field_count(), column_metas.len());

		let validity = BitVec::repeat(rows.len(), true);
		Self {
			rows,
			row_numbers,
			shape: shape.clone(),
			column_metas,
			validity,
		}
	}

	/// Total number of rows (before filtering)
	pub fn total_row_count(&self) -> usize {
		self.rows.len()
	}

	/// Number of valid (non-filtered) rows
	pub fn valid_row_count(&self) -> usize {
		self.validity.count_ones()
	}

	/// Check if a specific row is valid (not filtered out)
	#[inline]
	pub fn is_row_valid(&self, row_idx: usize) -> bool {
		self.validity.get(row_idx)
	}

	/// Number of columns
	pub fn column_count(&self) -> usize {
		self.column_metas.len()
	}

	/// Get column metadata by index
	pub fn column_meta(&self, col_idx: usize) -> Option<&LazyColumnMeta> {
		self.column_metas.get(col_idx)
	}

	/// Find column index by name
	pub fn column_index(&self, name: &str) -> Option<usize> {
		self.column_metas.iter().position(|m| m.name.text() == name)
	}

	/// Get a value from encoded row without full materialization
	pub fn get_value(&self, row_idx: usize, col_idx: usize) -> Value {
		self.shape.get_value(&self.rows[row_idx], col_idx)
	}

	/// Check if a value is defined (not null) without materializing
	#[inline]
	pub fn is_defined(&self, row_idx: usize, col_idx: usize) -> bool {
		self.rows[row_idx].is_defined(col_idx)
	}

	/// Apply a filter mask to this batch.
	/// Only keeps rows where the mask bit is true.
	/// ANDs with the existing validity mask.
	pub fn apply_filter(&mut self, filter: &BitVec) {
		debug_assert_eq!(filter.len(), self.rows.len());

		for i in 0..self.validity.len() {
			if self.validity.get(i) && !filter.get(i) {
				self.validity.set(i, false);
			}
		}
	}

	/// Materialize to Columns, only including valid rows.
	/// Does NOT decode dictionary columns - call decode_dictionaries separately if needed.
	pub fn into_columns(self) -> Columns {
		let valid_count = self.valid_row_count();

		// Collect valid row numbers and timestamps
		let mut result_row_numbers = Vec::with_capacity(valid_count);
		let mut result_created_at = Vec::with_capacity(valid_count);
		let mut result_updated_at = Vec::with_capacity(valid_count);
		for (row_idx, &row_num) in self.row_numbers.iter().enumerate() {
			if self.is_row_valid(row_idx) {
				result_row_numbers.push(row_num);
				result_created_at.push(DateTime::from_nanos(self.rows[row_idx].created_at_nanos()));
				result_updated_at.push(DateTime::from_nanos(self.rows[row_idx].updated_at_nanos()));
			}
		}

		// Materialize each column
		let mut result_columns = Vec::with_capacity(self.column_metas.len());
		for (col_idx, meta) in self.column_metas.iter().enumerate() {
			let mut data = ColumnData::with_capacity(meta.storage_type.clone(), valid_count);

			for (row_idx, row) in self.rows.iter().enumerate() {
				if self.is_row_valid(row_idx) {
					let value = self.shape.get_value(row, col_idx);
					data.push_value(value);
				}
			}

			result_columns.push(Column {
				name: meta.name.clone(),
				data,
			});
		}

		Columns {
			row_numbers: CowVec::new(result_row_numbers),
			created_at: CowVec::new(result_created_at),
			updated_at: CowVec::new(result_updated_at),
			columns: CowVec::new(result_columns),
		}
	}

	/// Get column names for headers
	pub fn column_names(&self) -> Vec<Fragment> {
		self.column_metas.iter().map(|m| m.name.clone()).collect()
	}

	/// Get the shape
	pub fn shape(&self) -> &RowShape {
		&self.shape
	}

	#[deprecated(since = "0.1.0", note = "Use shape() instead")]
	pub fn layout(&self) -> &RowShape {
		&self.shape
	}

	/// Get the column metas
	pub fn column_metas(&self) -> &[LazyColumnMeta] {
		&self.column_metas
	}

	/// Iterator over valid row indices
	pub fn valid_row_indices(&self) -> impl Iterator<Item = usize> + '_ {
		(0..self.rows.len()).filter(|&i| self.is_row_valid(i))
	}

	/// Get encoded row by index
	pub fn encoded_row(&self, row_idx: usize) -> &EncodedRow {
		&self.rows[row_idx]
	}

	/// Get row number by index
	pub fn row_number(&self, row_idx: usize) -> RowNumber {
		self.row_numbers[row_idx]
	}
}

#[cfg(test)]
pub mod tests {
	use reifydb_type::value::{row_number::RowNumber, r#type::Type};

	use super::*;

	fn create_test_shape() -> RowShape {
		RowShape::testing(&[Type::Int4, Type::Utf8, Type::Boolean])
	}

	fn create_test_metas() -> Vec<LazyColumnMeta> {
		vec![
			LazyColumnMeta {
				name: Fragment::internal("id"),
				storage_type: Type::Int4,
				output_type: Type::Int4,
				dictionary: None,
			},
			LazyColumnMeta {
				name: Fragment::internal("name"),
				storage_type: Type::Utf8,
				output_type: Type::Utf8,
				dictionary: None,
			},
			LazyColumnMeta {
				name: Fragment::internal("active"),
				storage_type: Type::Boolean,
				output_type: Type::Boolean,
				dictionary: None,
			},
		]
	}

	#[test]
	fn test_lazy_batch_creation() {
		let shape = create_test_shape();
		let metas = create_test_metas();

		// Create some encoded rows
		let mut row1 = shape.allocate();
		shape.set_i32(&mut row1, 0, 1);
		shape.set_utf8(&mut row1, 1, "Alice");
		shape.set_bool(&mut row1, 2, true);

		let mut row2 = shape.allocate();
		shape.set_i32(&mut row2, 0, 2);
		shape.set_utf8(&mut row2, 1, "Bob");
		shape.set_bool(&mut row2, 2, false);

		let batch = LazyBatch::new(vec![row1, row2], vec![RowNumber(100), RowNumber(101)], &shape, metas);

		assert_eq!(batch.total_row_count(), 2);
		assert_eq!(batch.valid_row_count(), 2);
		assert_eq!(batch.column_count(), 3);
	}

	#[test]
	fn test_get_value() {
		let shape = create_test_shape();
		let metas = create_test_metas();

		let mut row1 = shape.allocate();
		shape.set_i32(&mut row1, 0, 42);
		shape.set_utf8(&mut row1, 1, "Test");
		shape.set_bool(&mut row1, 2, true);

		let batch = LazyBatch::new(vec![row1], vec![RowNumber(1)], &shape, metas);

		assert_eq!(batch.get_value(0, 0), Value::Int4(42));
		assert_eq!(batch.get_value(0, 1), Value::Utf8("Test".to_string()));
		assert_eq!(batch.get_value(0, 2), Value::Boolean(true));
	}

	#[test]
	fn test_apply_filter() {
		let shape = create_test_shape();
		let metas = create_test_metas();

		let mut row1 = shape.allocate();
		shape.set_i32(&mut row1, 0, 1);
		shape.set_utf8(&mut row1, 1, "A");
		shape.set_bool(&mut row1, 2, true);

		let mut row2 = shape.allocate();
		shape.set_i32(&mut row2, 0, 2);
		shape.set_utf8(&mut row2, 1, "B");
		shape.set_bool(&mut row2, 2, false);

		let mut row3 = shape.allocate();
		shape.set_i32(&mut row3, 0, 3);
		shape.set_utf8(&mut row3, 1, "C");
		shape.set_bool(&mut row3, 2, true);

		let mut batch = LazyBatch::new(
			vec![row1, row2, row3],
			vec![RowNumber(1), RowNumber(2), RowNumber(3)],
			&shape,
			metas,
		);

		// Filter: keep rows 0 and 2
		let mut filter = BitVec::repeat(3, false);
		filter.set(0, true);
		filter.set(2, true);
		batch.apply_filter(&filter);

		assert_eq!(batch.total_row_count(), 3);
		assert_eq!(batch.valid_row_count(), 2);
		assert!(batch.is_row_valid(0));
		assert!(!batch.is_row_valid(1));
		assert!(batch.is_row_valid(2));
	}

	#[test]
	fn test_into_columns() {
		let shape = create_test_shape();
		let metas = create_test_metas();

		let mut row1 = shape.allocate();
		shape.set_i32(&mut row1, 0, 1);
		shape.set_utf8(&mut row1, 1, "Alice");
		shape.set_bool(&mut row1, 2, true);

		let mut row2 = shape.allocate();
		shape.set_i32(&mut row2, 0, 2);
		shape.set_utf8(&mut row2, 1, "Bob");
		shape.set_bool(&mut row2, 2, false);

		let mut row3 = shape.allocate();
		shape.set_i32(&mut row3, 0, 3);
		shape.set_utf8(&mut row3, 1, "Charlie");
		shape.set_bool(&mut row3, 2, true);

		let mut batch = LazyBatch::new(
			vec![row1, row2, row3],
			vec![RowNumber(100), RowNumber(101), RowNumber(102)],
			&shape,
			metas,
		);

		// Filter: keep only row 1 (Bob)
		let mut filter = BitVec::repeat(3, false);
		filter.set(1, true);
		batch.apply_filter(&filter);

		let columns = batch.into_columns();

		assert_eq!(columns.row_count(), 1);
		assert_eq!(columns.row_numbers.len(), 1);
		assert_eq!(columns.row_numbers[0], RowNumber(101));

		// Check values
		assert_eq!(columns[0].data().get_value(0), Value::Int4(2));
		assert_eq!(columns[1].data().get_value(0), Value::Utf8("Bob".to_string()));
		assert_eq!(columns[2].data().get_value(0), Value::Boolean(false));
	}

	#[test]
	fn test_column_index() {
		let shape = create_test_shape();
		let metas = create_test_metas();

		let row = shape.allocate();
		let batch = LazyBatch::new(vec![row], vec![RowNumber(1)], &shape, metas);

		assert_eq!(batch.column_index("id"), Some(0));
		assert_eq!(batch.column_index("name"), Some(1));
		assert_eq!(batch.column_index("active"), Some(2));
		assert_eq!(batch.column_index("nonexistent"), None);
	}

	#[test]
	fn test_multiple_filters() {
		let shape = create_test_shape();
		let metas = create_test_metas();

		let mut rows = Vec::new();
		for i in 0..5 {
			let mut row = shape.allocate();
			shape.set_i32(&mut row, 0, i);
			shape.set_utf8(&mut row, 1, &format!("row{}", i));
			shape.set_bool(&mut row, 2, i % 2 == 0);
			rows.push(row);
		}

		let mut batch = LazyBatch::new(
			rows,
			vec![RowNumber(10), RowNumber(11), RowNumber(12), RowNumber(13), RowNumber(14)],
			&shape,
			metas,
		);

		// First filter: keep 0, 2, 4 (even indices)
		let mut filter1 = BitVec::repeat(5, false);
		filter1.set(0, true);
		filter1.set(2, true);
		filter1.set(4, true);
		batch.apply_filter(&filter1);

		assert_eq!(batch.valid_row_count(), 3);

		// Second filter: from remaining, keep only 2
		let mut filter2 = BitVec::repeat(5, false);
		filter2.set(2, true);
		batch.apply_filter(&filter2);

		assert_eq!(batch.valid_row_count(), 1);
		assert!(batch.is_row_valid(2));
		assert!(!batch.is_row_valid(0));
		assert!(!batch.is_row_valid(4));
	}
}