reifydb-engine 0.5.0

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
// SPDX-License-Identifier: Apache-2.0
// Copyright (c) 2025 ReifyDB

use std::sync::Arc;

use reifydb_core::{
	common::CommitVersion,
	encoded::{key::EncodedKey, row::EncodedRow, shape::RowShape},
	error::diagnostic::catalog::{namespace_not_found, series_not_found},
	interface::{
		catalog::{
			config::{ConfigKey, GetConfig},
			namespace::Namespace,
			policy::{DataOp, PolicyTargetType},
			series::{Series, SeriesMetadata},
			shape::ShapeId,
		},
		change::{Change, ChangeOrigin, Diff},
		resolved::{ResolvedNamespace, ResolvedSeries, ResolvedShape},
	},
	key::{
		EncodableKey,
		series_row::{SeriesRowKey, SeriesRowKeyRange},
	},
	value::column::{ColumnWithName, buffer::ColumnBuffer, columns::Columns},
};
use reifydb_rql::{nodes::DeleteSeriesNode, query::QueryPlan};
use reifydb_transaction::{interceptor::series_row::SeriesRowInterceptor, transaction::Transaction};
use reifydb_type::{
	fragment::Fragment,
	params::Params,
	return_error,
	value::{Value, datetime::DateTime, identity::IdentityId, row_number::RowNumber},
};
use smallvec::smallvec;
use tracing::instrument;

use super::{
	context::{SeriesTarget, WriteExecCtx},
	returning::{decode_rows_to_columns, evaluate_returning},
};
use crate::{
	Result,
	policy::PolicyEvaluator,
	vm::{
		instruction::dml::shape::get_or_create_series_shape,
		services::Services,
		stack::SymbolTable,
		volcano::{
			compile::compile,
			query::{QueryContext, QueryNode},
		},
	},
};

#[instrument(name = "mutate::series::delete", level = "trace", skip_all)]
pub(crate) fn delete_series(
	services: &Arc<Services>,
	txn: &mut Transaction<'_>,
	plan: DeleteSeriesNode,
	params: Params,
	symbols: &SymbolTable,
) -> Result<Columns> {
	let DeleteSeriesNode {
		input,
		target,
		returning,
	} = plan;
	let (namespace, series, mut metadata) = resolve_delete_series_target(services, txn, &target)?;
	let target_data = SeriesTarget {
		namespace: &namespace,
		series: &series,
	};
	let has_tag = series.tag.is_some();
	let has_returning = returning.is_some();

	let exec = WriteExecCtx {
		services,
		symbols,
	};
	let (deleted_count, returning_columns) = if let Some(input_plan) = input {
		run_series_delete_with_input(&exec, txn, *input_plan, &target_data, &params, has_tag, has_returning)?
	} else {
		run_series_delete_all(services, txn, &target_data, has_returning)?
	};

	if deleted_count > 0 {
		update_series_metadata_after_delete(&mut metadata, deleted_count);
		services.catalog.update_series_metadata_txn(txn, metadata)?;
	}

	if let Some(returning_exprs) = &returning {
		let cols = returning_columns.unwrap_or_else(Columns::empty);
		return evaluate_returning(services, symbols, returning_exprs, cols);
	}
	Ok(delete_series_result(namespace.name(), &series.name, deleted_count))
}

#[inline]
fn resolve_delete_series_target(
	services: &Arc<Services>,
	txn: &mut Transaction<'_>,
	target: &ResolvedSeries,
) -> Result<(Namespace, Series, SeriesMetadata)> {
	let namespace_name = target.namespace().name();
	let Some(namespace) = services.catalog.find_namespace_by_name(txn, namespace_name)? else {
		return_error!(namespace_not_found(Fragment::internal(namespace_name), namespace_name));
	};
	let series_name = target.name();
	let Some(series) = services.catalog.find_series_by_name(txn, namespace.id(), series_name)? else {
		let fragment = Fragment::internal(target.name());
		return_error!(series_not_found(fragment, namespace_name, series_name));
	};
	let Some(metadata) = services.catalog.find_series_metadata(txn, series.id)? else {
		let fragment = Fragment::internal(target.name());
		return_error!(series_not_found(fragment, namespace_name, series_name));
	};
	Ok((namespace, series, metadata))
}

fn run_series_delete_with_input(
	exec: &WriteExecCtx<'_>,
	txn: &mut Transaction<'_>,
	input_plan: QueryPlan,
	target: &SeriesTarget<'_>,
	params: &Params,
	has_tag: bool,
	has_returning: bool,
) -> Result<(u64, Option<Columns>)> {
	let series = target.series;
	let namespace_ident = Fragment::internal(target.namespace.name());
	let resolved_namespace = ResolvedNamespace::new(namespace_ident, target.namespace.clone());
	let series_ident = Fragment::internal(series.name.clone());
	let resolved_series = ResolvedSeries::new(series_ident, resolved_namespace, series.clone());
	let context = QueryContext {
		services: exec.services.clone(),
		source: Some(ResolvedShape::Series(resolved_series)),
		batch_size: exec.services.catalog.get_config_uint2(ConfigKey::QueryRowBatchSize) as u64,
		params: params.clone(),
		symbols: exec.symbols.clone(),
		identity: IdentityId::root(),
	};

	let mut input_node = compile(input_plan, txn, Arc::new(context.clone()));
	input_node.initialize(txn, &context)?;

	let mut deleted_count = 0u64;
	let mut returning_columns: Option<Columns> = None;
	let mut mutable_context = context.clone();

	while let Some(columns) = input_node.next(txn, &mut mutable_context)? {
		let row_count = columns.row_count();
		if row_count == 0 {
			continue;
		}
		PolicyEvaluator::new(exec.services, exec.symbols).enforce_write_policies(
			txn,
			target.namespace.name(),
			&series.name,
			DataOp::Delete,
			&columns,
			PolicyTargetType::Series,
		)?;

		let row_numbers = columns.row_numbers.clone();
		for row_idx in 0..row_count {
			let sequence = u64::from(row_numbers[row_idx]);
			let key_value = extract_series_delete_key_value(&columns, series, row_idx);
			let variant_tag = extract_series_delete_variant_tag(&columns, has_tag, row_idx);
			let key = SeriesRowKey {
				series: series.id,
				variant_tag,
				key: key_value,
				sequence,
			};
			let encoded_key = key.encode();

			let Some(pre_entry) = txn.get(&encoded_key)? else {
				continue;
			};
			let encoded_row = pre_entry.row;
			let row_number = RowNumber::from(sequence);

			let committed = txn.get_committed(&encoded_key)?.map(|v| v.row);
			let pre_for_cdc = committed.clone().unwrap_or_else(|| encoded_row.clone());

			let pre = build_series_delete_pre_columns_from_input(
				series,
				&columns,
				&pre_for_cdc,
				key_value,
				row_number,
				row_idx,
			);
			emit_series_remove_change(txn, series, pre);

			SeriesRowInterceptor::pre_delete(txn, series)?;
			if committed.is_some() {
				txn.mark_preexisting(&encoded_key)?;
			}
			txn.unset(&encoded_key, pre_for_cdc.clone())?;
			let pre_rows = [pre_for_cdc.clone()];
			SeriesRowInterceptor::post_delete(txn, series, &pre_rows)?;
			deleted_count += 1;
		}

		if has_returning {
			returning_columns = Some(accumulate_returning_columns(returning_columns, columns));
		}
	}

	if has_returning && returning_columns.is_none() {
		returning_columns = Some(Columns::empty());
	}
	Ok((deleted_count, returning_columns))
}

fn run_series_delete_all(
	services: &Arc<Services>,
	txn: &mut Transaction<'_>,
	target: &SeriesTarget<'_>,
	has_returning: bool,
) -> Result<(u64, Option<Columns>)> {
	let series = target.series;
	let range = SeriesRowKeyRange::full_scan(series.id, None);
	let mut entries_to_delete: Vec<(EncodedKey, EncodedRow)> = Vec::new();

	let mut stream = txn.range(range, 32)?;
	for entry in stream.by_ref() {
		let entry = entry?;
		entries_to_delete.push((entry.key, entry.row));
	}
	drop(stream);

	let delete_all_shape = get_or_create_series_shape(&services.catalog, series, txn)?;
	let mut deleted_count = 0u64;

	for (key, encoded_row) in entries_to_delete.iter() {
		let committed = txn.get_committed(key)?.map(|v| v.row);
		let pre_for_cdc = committed.clone().unwrap_or_else(|| encoded_row.clone());

		if let Some(decoded_key) = SeriesRowKey::decode(key) {
			let pre = build_series_delete_pre_columns_from_storage(
				series,
				&delete_all_shape,
				&pre_for_cdc,
				&decoded_key,
			);
			emit_series_remove_change(txn, series, pre);
		}

		SeriesRowInterceptor::pre_delete(txn, series)?;
		if committed.is_some() {
			txn.mark_preexisting(key)?;
		}
		txn.unset(key, pre_for_cdc.clone())?;
		let pre_rows = [pre_for_cdc.clone()];
		SeriesRowInterceptor::post_delete(txn, series, &pre_rows)?;
		deleted_count += 1;
	}

	let returning_columns = if has_returning {
		let mut returned_rows: Vec<(RowNumber, EncodedRow)> = Vec::new();
		for (key, encoded) in entries_to_delete.iter() {
			if let Some(decoded_key) = SeriesRowKey::decode(key) {
				returned_rows.push((RowNumber::from(decoded_key.sequence), encoded.clone()));
			}
		}
		Some(decode_rows_to_columns(&delete_all_shape, &returned_rows))
	} else {
		None
	};
	Ok((deleted_count, returning_columns))
}

#[inline]
fn extract_series_delete_key_value(columns: &Columns, series: &Series, row_idx: usize) -> u64 {
	columns.iter()
		.find(|c| c.name().text() == series.key.column())
		.and_then(|c| series.key_to_u64(c.data().get_value(row_idx)))
		.unwrap_or(0)
}

#[inline]
fn extract_series_delete_variant_tag(columns: &Columns, has_tag: bool, row_idx: usize) -> Option<u8> {
	if !has_tag {
		return None;
	}
	columns.iter().find(|c| c.name().text() == "tag").and_then(|c| match c.data().get_value(row_idx) {
		Value::Uint1(v) => Some(v),
		_ => None,
	})
}

fn build_series_delete_pre_columns_from_input(
	series: &Series,
	columns: &Columns,
	encoded_row: &EncodedRow,
	key_value: u64,
	row_number: RowNumber,
	row_idx: usize,
) -> Columns {
	let mut pre_col_vec = Vec::with_capacity(1 + series.columns.len());
	pre_col_vec.push(ColumnWithName::new(
		Fragment::internal(series.key.column()),
		series.key_column_data(vec![key_value]),
	));
	for col in columns.iter() {
		if col.name().text() != series.key.column() && col.name().text() != "tag" {
			let mut data = ColumnBuffer::with_capacity(col.data().get_type(), 1);
			data.push_value(col.data().get_value(row_idx));
			pre_col_vec.push(ColumnWithName {
				name: col.name().clone(),
				data,
			});
		}
	}
	Columns::with_system_columns(
		pre_col_vec,
		vec![row_number],
		vec![DateTime::from_nanos(encoded_row.created_at_nanos())],
		vec![DateTime::from_nanos(encoded_row.updated_at_nanos())],
	)
}

fn build_series_delete_pre_columns_from_storage(
	series: &Series,
	shape: &RowShape,
	encoded_row: &EncodedRow,
	decoded_key: &SeriesRowKey,
) -> Columns {
	let row_number = RowNumber::from(decoded_key.sequence);
	let data_values: Vec<Value> =
		series.data_columns().enumerate().map(|(i, _)| shape.get_value(encoded_row, i + 1)).collect();
	let mut pre_col_vec = Vec::with_capacity(1 + series.columns.len());
	pre_col_vec.push(ColumnWithName::new(
		Fragment::internal(series.key.column()),
		series.key_column_data(vec![decoded_key.key]),
	));
	for (col_idx, col_def) in series.data_columns().enumerate() {
		let mut data = ColumnBuffer::with_capacity(col_def.constraint.get_type(), 1);
		data.push_value(data_values.get(col_idx).cloned().unwrap_or(Value::none()));
		pre_col_vec.push(ColumnWithName {
			name: Fragment::internal(&col_def.name),
			data,
		});
	}
	Columns::with_system_columns(
		pre_col_vec,
		vec![row_number],
		vec![DateTime::from_nanos(encoded_row.created_at_nanos())],
		vec![DateTime::from_nanos(encoded_row.updated_at_nanos())],
	)
}

#[inline]
fn emit_series_remove_change(txn: &mut Transaction<'_>, series: &Series, pre: Columns) {
	txn.track_flow_change(Change {
		origin: ChangeOrigin::Shape(ShapeId::series(series.id)),
		version: CommitVersion(0),
		diffs: smallvec![Diff::remove(pre)],
		changed_at: DateTime::default(),
	});
}

fn accumulate_returning_columns(returning_columns: Option<Columns>, columns: Columns) -> Columns {
	match returning_columns {
		Some(existing) => {
			let mut cols = Vec::new();
			for (i, col) in columns.iter().enumerate() {
				if let Some(existing_col) = existing.get(i) {
					let mut data = ColumnBuffer::with_capacity(
						col.data().get_type(),
						existing_col.data().len() + col.data().len(),
					);
					for j in 0..existing_col.data().len() {
						data.push_value(existing_col.data().get_value(j));
					}
					for j in 0..col.data().len() {
						data.push_value(col.data().get_value(j));
					}
					cols.push(ColumnWithName {
						name: col.name().clone(),
						data,
					});
				}
			}
			let mut row_numbers = existing.row_numbers.to_vec();
			row_numbers.extend(columns.row_numbers.iter().copied());
			let mut created_at = existing.created_at.to_vec();
			created_at.extend(columns.created_at.iter().copied());
			let mut updated_at = existing.updated_at.to_vec();
			updated_at.extend(columns.updated_at.iter().copied());
			Columns::with_system_columns(cols, row_numbers, created_at, updated_at)
		}
		None => columns,
	}
}

#[inline]
fn update_series_metadata_after_delete(metadata: &mut SeriesMetadata, deleted_count: u64) {
	metadata.row_count = metadata.row_count.saturating_sub(deleted_count);
	if metadata.row_count == 0 {
		metadata.oldest_key = 0;
		metadata.newest_key = 0;
	}
}

#[inline]
fn delete_series_result(namespace: &str, series: &str, deleted: u64) -> Columns {
	Columns::single_row([
		("namespace", Value::Utf8(namespace.to_string())),
		("series", Value::Utf8(series.to_string())),
		("deleted", Value::Uint8(deleted)),
	])
}