reifydb-engine 0.10.1

Query execution and processing engine 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
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
// SPDX-License-Identifier: Apache-2.0
// Copyright (c) 2026 ReifyDB

use std::{iter, sync::Arc};

use arrow_array::{RecordBatch, UInt64Array};
use reifydb_codec::row::{
	bytes::{EncodedBytes, read_fingerprint},
	shape::RowShape,
};
use reifydb_core::{
	common::TimeSource,
	interface::{
		catalog::{dictionary::Dictionary, storage::StorageId},
		resolved::ResolvedObject,
	},
	internal_err, internal_error,
	key::{
		any::TaggedKey,
		row::{RowKey, RowKeyRange},
	},
	value::{
		batch::{append_rows, batch, empty_batch, empty_for, is_scalar, scalar_value},
		column::{builder::ColumnBuilder, headers::ColumnHeaders},
	},
};
use reifydb_evaluate::stack::{SymbolTable, Variable};
use reifydb_rql::{
	nodes::{RowKey as RqlRowKey, RowKeyPredicate},
	plan::logical::row_predicate::RowPredicate,
};
use reifydb_transaction::{
	multi::RangeScope,
	transaction::{ScanLayout, Transaction},
};
use reifydb_value::{
	reifydb_assertions,
	value::{
		Value,
		row_number::RowNumber,
		system_columns::{SystemColumn, with_system_column},
		value_type::ValueType,
	},
};
use tracing::instrument;

use crate::{
	Result,
	vm::volcano::{
		decode_dictionary_columns,
		query::{QueryContext, QueryNode},
		scan::{empty_scan, guard_view_read, scan_headers, source_system_columns},
		user_pairs,
	},
};

fn guard_source_read(source: &ResolvedObject, rx: &mut Transaction<'_>, ctx: &QueryContext) -> Result<()> {
	reifydb_assertions! {
		assert!(
			!matches!(source, ResolvedObject::DeferredView(_) | ResolvedObject::TransactionalView(_)),
			"physical planning must fold view kinds into ResolvedObject::View before row lookup, otherwise guard_view_read silently no-ops here"
		);
	}
	if let ResolvedObject::View(view) = source {
		guard_view_read(view, rx, &ctx.services)?;
	}
	Ok(())
}

pub(crate) struct RowPointLookupNode {
	source: ResolvedObject,
	row_number: u64,
	context: Option<Arc<QueryContext>>,
	headers: ColumnHeaders,
	system_columns: Vec<SystemColumn>,
	dictionaries: Vec<Option<(Dictionary, ValueType)>>,
	shape: Option<RowShape>,
	exhausted: bool,
}

impl RowPointLookupNode {
	pub fn new(source: ResolvedObject, row_number: u64, context: Arc<QueryContext>) -> Result<Self> {
		let system_columns = lookup_system_columns(&source);
		let (headers, _) = build_headers_and_storage_types(&source, &system_columns)?;

		Ok(Self {
			source,
			row_number,
			context: Some(context),
			headers,
			system_columns,
			dictionaries: Vec::new(),
			shape: None,
			exhausted: false,
		})
	}

	fn get_or_load_shape(&mut self, rx: &mut Transaction, first: &EncodedBytes) -> Result<RowShape> {
		if let Some(shape) = &self.shape {
			return Ok(shape.clone());
		}

		let fingerprint = read_fingerprint(first);

		let stored_ctx = self.context.as_ref().expect("RowPointLookupNode context not set");
		let shape =
			stored_ctx.services.catalog.get_or_load_row_shape(fingerprint, rx)?.ok_or_else(|| {
				internal_error!("RowShape with fingerprint {:?} not found", fingerprint)
			})?;

		self.shape = Some(shape.clone());

		Ok(shape)
	}

	#[instrument(level = "trace", skip_all, name = "volcano::lookup::point::append_rows")]
	fn append_batch<'a>(
		&mut self,
		rx: &mut Transaction<'a>,
		columns: RecordBatch,
		bytes: EncodedBytes,
	) -> Result<RecordBatch> {
		let shape = self.get_or_load_shape(rx, &bytes)?;
		append_rows(columns, &shape, iter::once(bytes), vec![RowNumber(self.row_number)])
	}
}

impl QueryNode for RowPointLookupNode {
	#[instrument(name = "volcano::lookup::point::initialize", level = "trace", skip_all)]
	fn initialize<'a>(&mut self, rx: &mut Transaction<'a>, ctx: &QueryContext) -> Result<()> {
		guard_source_read(&self.source, rx, ctx)?;
		self.dictionaries = lookup_dictionaries(&self.source, rx, ctx)?;
		Ok(())
	}

	#[instrument(name = "volcano::lookup::point::next", level = "trace", skip_all)]
	fn next<'a>(&mut self, rx: &mut Transaction<'a>, _ctx: &mut QueryContext) -> Result<Option<RecordBatch>> {
		if self.exhausted {
			return Ok(None);
		}
		self.exhausted = true;

		let object_id = get_object_id(&self.source)?;
		let encoded_key = RowKey::new(object_id, RowNumber(self.row_number));

		if let Some(multi_values) = rx.get(&[encoded_key.clone().into()])?.pop().flatten() {
			let columns = storage_columns(&self.source, &self.dictionaries)?;
			let columns = self.append_batch(rx, columns, multi_values.bytes)?;
			let columns = decode_dictionary_columns(columns, &self.dictionaries, rx)?;

			Ok(Some(with_commit_versions(columns, &self.system_columns, vec![multi_values.version.0])?))
		} else {
			Ok(Some(empty_lookup(&self.source, &self.system_columns)?))
		}
	}

	fn headers(&self) -> Option<ColumnHeaders> {
		Some(self.headers.clone())
	}
}

pub(crate) struct RowListLookupNode {
	source: ResolvedObject,
	row_numbers: Vec<u64>,
	context: Option<Arc<QueryContext>>,
	headers: ColumnHeaders,
	system_columns: Vec<SystemColumn>,
	dictionaries: Vec<Option<(Dictionary, ValueType)>>,
	shape: Option<RowShape>,
	current_index: usize,
	emitted: bool,
}

impl RowListLookupNode {
	pub fn new(source: ResolvedObject, row_numbers: Vec<u64>, context: Arc<QueryContext>) -> Result<Self> {
		let system_columns = lookup_system_columns(&source);
		let (headers, _) = build_headers_and_storage_types(&source, &system_columns)?;

		Ok(Self {
			source,
			row_numbers,
			context: Some(context),
			headers,
			system_columns,
			dictionaries: Vec::new(),
			shape: None,
			current_index: 0,
			emitted: false,
		})
	}

	fn finish(&mut self) -> Result<Option<RecordBatch>> {
		if self.emitted {
			return Ok(None);
		}
		self.emitted = true;
		Ok(Some(empty_lookup(&self.source, &self.system_columns)?))
	}

	fn get_or_load_shape(&mut self, rx: &mut Transaction, first: &EncodedBytes) -> Result<RowShape> {
		if let Some(shape) = &self.shape {
			return Ok(shape.clone());
		}

		let fingerprint = read_fingerprint(first);

		let stored_ctx = self.context.as_ref().expect("RowListLookupNode context not set");
		let shape =
			stored_ctx.services.catalog.get_or_load_row_shape(fingerprint, rx)?.ok_or_else(|| {
				internal_error!("RowShape with fingerprint {:?} not found", fingerprint)
			})?;

		self.shape = Some(shape.clone());

		Ok(shape)
	}

	#[instrument(level = "trace", skip_all, name = "volcano::lookup::list::fetch")]
	fn fetch_batch<'a>(
		&self,
		rx: &mut Transaction<'a>,
		object_id: StorageId,
		start: usize,
		end: usize,
	) -> Result<(Vec<EncodedBytes>, Vec<RowNumber>, Vec<u64>)> {
		let mut batch = Vec::new();
		let mut found_row_numbers = Vec::new();
		let mut commit_versions = Vec::new();

		for &row_num in &self.row_numbers[start..end] {
			let encoded_key = RowKey::new(object_id, RowNumber(row_num));

			if let Some(multi_values) = rx.get(&[encoded_key.clone().into()])?.pop().flatten() {
				batch.push(multi_values.bytes);
				found_row_numbers.push(RowNumber(row_num));
				commit_versions.push(multi_values.version.0);
			}
		}

		Ok((batch, found_row_numbers, commit_versions))
	}

	#[instrument(level = "trace", skip_all, name = "volcano::lookup::list::append_rows")]
	fn append_batch<'a>(
		&mut self,
		rx: &mut Transaction<'a>,
		columns: RecordBatch,
		bytes_vec: Vec<EncodedBytes>,
		row_numbers: Vec<RowNumber>,
	) -> Result<RecordBatch> {
		let shape = self.get_or_load_shape(rx, &bytes_vec[0])?;
		append_rows(columns, &shape, bytes_vec, row_numbers)
	}
}

impl QueryNode for RowListLookupNode {
	#[instrument(name = "volcano::lookup::list::initialize", level = "trace", skip_all)]
	fn initialize<'a>(&mut self, rx: &mut Transaction<'a>, ctx: &QueryContext) -> Result<()> {
		guard_source_read(&self.source, rx, ctx)?;
		self.dictionaries = lookup_dictionaries(&self.source, rx, ctx)?;
		Ok(())
	}

	#[instrument(name = "volcano::lookup::list::next", level = "trace", skip_all)]
	#[allow(clippy::only_used_in_recursion)]
	fn next<'a>(&mut self, rx: &mut Transaction<'a>, ctx: &mut QueryContext) -> Result<Option<RecordBatch>> {
		let stored_ctx = self.context.as_ref().unwrap();
		let batch_size = stored_ctx.batch_size as usize;

		if self.current_index >= self.row_numbers.len() {
			return self.finish();
		}

		let object_id = get_object_id(&self.source)?;
		let end_index = (self.current_index + batch_size).min(self.row_numbers.len());

		let (batch, found_row_numbers, commit_versions) =
			self.fetch_batch(rx, object_id, self.current_index, end_index)?;

		self.current_index = end_index;

		if batch.is_empty() {
			if self.current_index < self.row_numbers.len() {
				return self.next(rx, ctx);
			}
			return self.finish();
		}

		let columns = storage_columns(&self.source, &self.dictionaries)?;
		let columns = self.append_batch(rx, columns, batch, found_row_numbers)?;
		let columns = decode_dictionary_columns(columns, &self.dictionaries, rx)?;

		self.emitted = true;
		Ok(Some(with_commit_versions(columns, &self.system_columns, commit_versions)?))
	}

	fn headers(&self) -> Option<ColumnHeaders> {
		Some(self.headers.clone())
	}
}

pub(crate) struct RowRangeScanNode {
	source: ResolvedObject,
	end: u64,
	context: Option<Arc<QueryContext>>,
	headers: ColumnHeaders,
	system_columns: Vec<SystemColumn>,
	dictionaries: Vec<Option<(Dictionary, ValueType)>>,
	shape: Option<RowShape>,
	current_row: u64,
	exhausted: bool,
	emitted: bool,
}

impl RowRangeScanNode {
	pub fn new(source: ResolvedObject, start: u64, end: u64, context: Arc<QueryContext>) -> Result<Self> {
		let system_columns = lookup_system_columns(&source);
		let (headers, _) = build_headers_and_storage_types(&source, &system_columns)?;

		Ok(Self {
			source,
			end,
			context: Some(context),
			headers,
			system_columns,
			dictionaries: Vec::new(),
			shape: None,
			current_row: start,
			exhausted: false,
			emitted: false,
		})
	}

	fn finish(&mut self) -> Result<Option<RecordBatch>> {
		if self.emitted {
			return Ok(None);
		}
		self.emitted = true;
		Ok(Some(empty_lookup(&self.source, &self.system_columns)?))
	}

	fn get_or_load_shape(&mut self, rx: &mut Transaction, first: &EncodedBytes) -> Result<RowShape> {
		if let Some(shape) = &self.shape {
			return Ok(shape.clone());
		}

		let fingerprint = read_fingerprint(first);

		let stored_ctx = self.context.as_ref().expect("RowRangeScanNode context not set");
		let shape =
			stored_ctx.services.catalog.get_or_load_row_shape(fingerprint, rx)?.ok_or_else(|| {
				internal_error!("RowShape with fingerprint {:?} not found", fingerprint)
			})?;

		self.shape = Some(shape.clone());

		Ok(shape)
	}

	#[instrument(level = "trace", skip_all, name = "volcano::scan::range::fetch")]
	fn fetch_batch<'a>(
		&self,
		rx: &mut Transaction<'a>,
		object_id: StorageId,
		start: u64,
		end: u64,
	) -> Result<(Vec<EncodedBytes>, Vec<RowNumber>, Vec<u64>)> {
		let mut batch = Vec::new();
		let mut found_row_numbers = Vec::new();
		let mut commit_versions = Vec::new();

		for row_num in start..=end {
			let encoded_key = RowKey::new(object_id, RowNumber(row_num));

			if let Some(multi_values) = rx.get(&[encoded_key.clone().into()])?.pop().flatten() {
				batch.push(multi_values.bytes);
				found_row_numbers.push(RowNumber(row_num));
				commit_versions.push(multi_values.version.0);
			}
		}

		Ok((batch, found_row_numbers, commit_versions))
	}

	#[instrument(level = "trace", skip_all, name = "volcano::scan::range::append_rows")]
	fn append_batch<'a>(
		&mut self,
		rx: &mut Transaction<'a>,
		columns: RecordBatch,
		bytes_vec: Vec<EncodedBytes>,
		row_numbers: Vec<RowNumber>,
	) -> Result<RecordBatch> {
		let shape = self.get_or_load_shape(rx, &bytes_vec[0])?;
		append_rows(columns, &shape, bytes_vec, row_numbers)
	}
}

impl QueryNode for RowRangeScanNode {
	#[instrument(name = "volcano::scan::range::initialize", level = "trace", skip_all)]
	fn initialize<'a>(&mut self, rx: &mut Transaction<'a>, ctx: &QueryContext) -> Result<()> {
		guard_source_read(&self.source, rx, ctx)?;
		self.dictionaries = lookup_dictionaries(&self.source, rx, ctx)?;
		match last_row_number(rx, get_object_id(&self.source)?)? {
			Some(last) => self.end = self.end.min(last),
			None => self.exhausted = true,
		}
		Ok(())
	}

	#[instrument(name = "volcano::scan::range::next", level = "trace", skip_all)]
	fn next<'a>(&mut self, rx: &mut Transaction<'a>, _ctx: &mut QueryContext) -> Result<Option<RecordBatch>> {
		let stored_ctx = self.context.as_ref().unwrap();
		let batch_size = stored_ctx.batch_size as usize;

		let (batch, found_row_numbers, commit_versions) = loop {
			if self.exhausted || self.current_row > self.end {
				return self.finish();
			}

			let object_id = get_object_id(&self.source)?;

			let batch_end = self.current_row.saturating_add(batch_size as u64 - 1).min(self.end);
			let fetched = self.fetch_batch(rx, object_id, self.current_row, batch_end)?;

			match batch_end.checked_add(1) {
				Some(next_row) if next_row <= self.end => self.current_row = next_row,
				_ => self.exhausted = true,
			}

			if !fetched.0.is_empty() {
				break fetched;
			}
		};

		let columns = storage_columns(&self.source, &self.dictionaries)?;
		let columns = self.append_batch(rx, columns, batch, found_row_numbers)?;
		let columns = decode_dictionary_columns(columns, &self.dictionaries, rx)?;

		self.emitted = true;
		Ok(Some(with_commit_versions(columns, &self.system_columns, commit_versions)?))
	}

	fn headers(&self) -> Option<ColumnHeaders> {
		Some(self.headers.clone())
	}
}

fn build_headers_and_storage_types(
	source: &ResolvedObject,
	system_columns: &[SystemColumn],
) -> Result<(ColumnHeaders, Vec<ValueType>)> {
	let columns = match source {
		ResolvedObject::Table(table) => table.columns(),
		ResolvedObject::View(view) => view.columns(),
		ResolvedObject::RingBuffer(rb) => rb.columns(),
		_ => {
			unreachable!("Row lookup not supported for this source type");
		}
	};

	let storage_types = columns.iter().map(|c| c.constraint.get_type()).collect::<Vec<_>>();

	let headers = scan_headers(columns.iter().map(|col| col.name.as_str()), system_columns);

	Ok((headers, storage_types))
}

fn last_row_number(rx: &mut Transaction<'_>, storage: StorageId) -> Result<Option<u64>> {
	let mut rows = rx.range(RowKeyRange::storage_scan(storage), RangeScope::All, 1)?;
	match rows.next().transpose()? {
		None => Ok(None),
		Some(row) => match row.key {
			TaggedKey::Row(key) => Ok(Some(key.row.0)),
			other => internal_err!("row range scan met a non row key {:?}", other),
		},
	}
}

fn get_object_id(source: &ResolvedObject) -> Result<StorageId> {
	match source {
		ResolvedObject::Table(table) => Ok(table.def().id.into()),
		ResolvedObject::View(view) => Ok(view.def().storage_id()),
		ResolvedObject::RingBuffer(rb) => Ok(rb.def().id.into()),
		_ => internal_err!("Row lookup not supported for this source type"),
	}
}

fn columns_from_object(source: &ResolvedObject) -> Result<RecordBatch> {
	Ok(match source {
		ResolvedObject::Table(table) => empty_for(table.columns())?,
		ResolvedObject::View(view) => empty_for(view.columns())?,
		ResolvedObject::RingBuffer(rb) => empty_for(rb.columns())?,
		_ => empty_batch(),
	})
}

fn lookup_dictionaries(
	source: &ResolvedObject,
	rx: &mut Transaction<'_>,
	ctx: &QueryContext,
) -> Result<Vec<Option<(Dictionary, ValueType)>>> {
	let columns = match source {
		ResolvedObject::Table(table) => table.columns(),
		ResolvedObject::View(view) => view.columns(),
		ResolvedObject::RingBuffer(rb) => rb.columns(),
		_ => return Ok(Vec::new()),
	};
	let mut dictionaries = Vec::with_capacity(columns.len());
	for column in columns {
		dictionaries.push(match column.dictionary_id {
			Some(id) => ctx
				.services
				.catalog
				.find_dictionary(rx, id)?
				.map(|dictionary| (dictionary, column.constraint.get_type())),
			None => None,
		});
	}
	Ok(dictionaries)
}

fn storage_columns(source: &ResolvedObject, dictionaries: &[Option<(Dictionary, ValueType)>]) -> Result<RecordBatch> {
	batch(user_pairs(&columns_from_object(source)?)
		.into_iter()
		.enumerate()
		.map(|(index, (field, array))| match dictionaries.get(index).and_then(Option::as_ref) {
			Some(_) => ColumnBuilder::with_capacity(ValueType::DictionaryId, 0).finish(field.name()),
			None => (field, array),
		})
		.collect())
}

fn lookup_system_columns(source: &ResolvedObject) -> Vec<SystemColumn> {
	match source {
		ResolvedObject::Table(table) => {
			source_system_columns(false, table.def().time != TimeSource::None, true)
		}
		ResolvedObject::View(_) => source_system_columns(false, true, false),
		ResolvedObject::RingBuffer(rb) => {
			source_system_columns(false, rb.def().time != TimeSource::None, false)
		}
		_ => Vec::new(),
	}
}

fn empty_lookup(source: &ResolvedObject, system_columns: &[SystemColumn]) -> Result<RecordBatch> {
	empty_scan(user_pairs(&columns_from_object(source)?), system_columns)
}

fn with_commit_versions(
	columns: RecordBatch,
	system_columns: &[SystemColumn],
	commit_versions: Vec<u64>,
) -> Result<RecordBatch> {
	if !system_columns.contains(&SystemColumn::CommitVersion) {
		return Ok(columns);
	}
	with_system_column(columns, SystemColumn::CommitVersion, Arc::new(UInt64Array::from(commit_versions)))
}

pub(crate) fn choose_row_lookup(
	predicate: &RowKeyPredicate,
	layout: ScanLayout,
	symbols: &SymbolTable,
) -> Option<RowPredicate> {
	match layout {
		ScanLayout::Row => resolve_row_keys(predicate, symbols),
		ScanLayout::Column => None,
	}
}

fn resolve_row_keys(predicate: &RowKeyPredicate, symbols: &SymbolTable) -> Option<RowPredicate> {
	match predicate {
		RowKeyPredicate::Point(key) => resolve_row_key(key, symbols).map(RowPredicate::Point),
		RowKeyPredicate::List(keys) => keys
			.iter()
			.map(|key| resolve_row_key(key, symbols))
			.collect::<Option<Vec<_>>>()
			.map(RowPredicate::List),
		RowKeyPredicate::Range {
			start,
			end,
		} => {
			let start = resolve_row_key(start, symbols)?;
			let end = resolve_row_key(end, symbols)?;
			(start <= end).then_some(RowPredicate::Range {
				start,
				end,
			})
		}
	}
}

fn resolve_row_key(key: &RqlRowKey, symbols: &SymbolTable) -> Option<u64> {
	let variable = match key {
		RqlRowKey::Constant(row_number) => return Some(*row_number),
		RqlRowKey::Variable(variable) => variable,
	};
	let Some(Variable::Columns {
		batch,
	}) = symbols.get(variable.name())
	else {
		return None;
	};
	if !is_scalar(batch) {
		return None;
	}
	match scalar_value(batch).ok()? {
		Value::Uint1(v) => Some(u64::from(v)),
		Value::Uint2(v) => Some(u64::from(v)),
		Value::Uint4(v) => Some(u64::from(v)),
		Value::Uint8(v) => Some(v),
		Value::Uint16(v) => u64::try_from(v).ok(),
		Value::Int1(v) => u64::try_from(v).ok(),
		Value::Int2(v) => u64::try_from(v).ok(),
		Value::Int4(v) => u64::try_from(v).ok(),
		Value::Int8(v) => u64::try_from(v).ok(),
		Value::Int16(v) => u64::try_from(v).ok(),
		_ => None,
	}
}

#[cfg(test)]
mod tests {
	use reifydb_core::expression::VariableExpression;
	use reifydb_value::fragment::Fragment;

	use super::*;

	fn key(text: &str) -> RqlRowKey {
		RqlRowKey::Variable(VariableExpression {
			fragment: Fragment::internal(text),
		})
	}

	fn symbols(values: Vec<(&str, Value)>) -> SymbolTable {
		let mut symbols = SymbolTable::new();
		for (name, value) in values {
			symbols.set(name.to_string(), Variable::scalar(value), false).expect("a fresh name");
		}
		symbols
	}

	#[test]
	fn an_integer_variable_resolves_to_a_row_lookup() {
		// Without this the parameter node always falls back to a full scan.
		let point = RowKeyPredicate::Point(key("$1"));
		let list = RowKeyPredicate::List(vec![key("$1"), RqlRowKey::Constant(7)]);
		let range = RowKeyPredicate::Range {
			start: key("$1"),
			end: key("$2"),
		};

		assert_eq!(
			resolve_row_keys(&point, &symbols(vec![("1", Value::Int4(2))])),
			Some(RowPredicate::Point(2))
		);
		assert_eq!(
			resolve_row_keys(&list, &symbols(vec![("1", Value::Uint8(3))])),
			Some(RowPredicate::List(vec![3, 7]))
		);
		assert_eq!(
			resolve_row_keys(&range, &symbols(vec![("1", Value::Int8(2)), ("2", Value::Uint1(4))])),
			Some(RowPredicate::Range {
				start: 2,
				end: 4
			})
		);
	}

	#[test]
	fn a_key_resolves_by_its_own_name() {
		// A key must read its own symbol, never another one.
		let point = RowKeyPredicate::Point(key("$id"));

		assert_eq!(
			resolve_row_keys(&point, &symbols(vec![("id", Value::Uint2(9))])),
			Some(RowPredicate::Point(9))
		);
		assert_eq!(resolve_row_keys(&point, &symbols(vec![("1", Value::Uint2(9))])), None);
	}

	#[test]
	fn a_value_that_is_not_a_row_number_falls_back() {
		// Each of these must take the scan and filter, otherwise its answer or error differs from today.
		let point = RowKeyPredicate::Point(key("$1"));
		let range = RowKeyPredicate::Range {
			start: key("$1"),
			end: RqlRowKey::Constant(2),
		};

		assert_eq!(resolve_row_keys(&point, &symbols(vec![("1", Value::Int4(-1))])), None);
		assert_eq!(resolve_row_keys(&point, &symbols(vec![("1", Value::Utf8("abc".to_string()))])), None);
		assert_eq!(resolve_row_keys(&point, &symbols(vec![("1", Value::none())])), None);
		assert_eq!(resolve_row_keys(&point, &symbols(vec![("1", Value::float8(5.0))])), None);
		assert_eq!(resolve_row_keys(&point, &symbols(vec![])), None);
		assert_eq!(resolve_row_keys(&range, &symbols(vec![("1", Value::Uint8(5))])), None);
	}

	#[test]
	fn a_row_layout_takes_the_lookup_and_a_column_layout_never_does() {
		// A column layout refuses row-store reads, so the lookup there must always fall back to the scan.
		let point = RowKeyPredicate::Point(key("$1"));
		let values = symbols(vec![("1", Value::Int4(2))]);

		assert_eq!(choose_row_lookup(&point, ScanLayout::Row, &values), Some(RowPredicate::Point(2)));
		assert_eq!(choose_row_lookup(&point, ScanLayout::Column, &values), None);
	}
}