reifydb-catalog 0.5.6

Database catalog and metadata management 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

// SPDX-License-Identifier: Apache-2.0
// Copyright (c) 2025 ReifyDB

use reifydb_core::{
	interface::catalog::{
		change::{CatalogTrackOperatorTtlChangeOperations, CatalogTrackRowTtlChangeOperations},
		flow::FlowNodeId,
		shape::ShapeId,
	},
	key::{operator_ttl::OperatorTtlKey, row_ttl::RowTtlKey},
	row::Ttl,
};
use reifydb_transaction::transaction::admin::AdminTransaction;

use super::encode_ttl_config;
use crate::Result;

pub fn create_row_ttl(txn: &mut AdminTransaction, shape: ShapeId, config: &Ttl) -> Result<()> {
	let value = encode_ttl_config(config);
	txn.set(&RowTtlKey::encoded(shape), value)?;
	txn.track_row_ttl_created(shape, config.clone())?;
	Ok(())
}

pub fn create_operator_ttl(txn: &mut AdminTransaction, node: FlowNodeId, config: &Ttl) -> Result<()> {
	let value = encode_ttl_config(config);
	txn.set(&OperatorTtlKey::encoded(node), value)?;
	txn.track_operator_ttl_created(node, config.clone())?;
	Ok(())
}

#[cfg(test)]
pub mod tests {
	use reifydb_core::{
		interface::catalog::id::{RingBufferId, SeriesId, TableId},
		row::{Ttl, TtlAnchor, TtlCleanupMode},
	};
	use reifydb_engine::test_harness::create_test_admin_transaction;
	use reifydb_transaction::transaction::Transaction;

	use super::*;
	use crate::CatalogStore;

	#[test]
	fn test_create_row_ttl_for_table() {
		let mut txn = create_test_admin_transaction();
		let shape = ShapeId::Table(TableId(42));
		let config = Ttl {
			duration_nanos: 300_000_000_000,
			anchor: TtlAnchor::Created,
			cleanup_mode: TtlCleanupMode::Drop,
		};

		create_row_ttl(&mut txn, shape, &config).unwrap();

		let found = CatalogStore::find_row_ttl(&mut Transaction::Admin(&mut txn), shape)
			.unwrap()
			.expect("TTL config should be stored");
		assert_eq!(found, config);
	}

	#[test]
	fn test_create_row_ttl_for_ringbuffer() {
		let mut txn = create_test_admin_transaction();
		let shape = ShapeId::RingBuffer(RingBufferId(200));
		let config = Ttl {
			duration_nanos: 3_600_000_000_000,
			anchor: TtlAnchor::Updated,
			cleanup_mode: TtlCleanupMode::Delete,
		};

		create_row_ttl(&mut txn, shape, &config).unwrap();

		let found = CatalogStore::find_row_ttl(&mut Transaction::Admin(&mut txn), shape)
			.unwrap()
			.expect("TTL config should be stored");
		assert_eq!(found, config);
	}

	#[test]
	fn test_create_row_ttl_for_series() {
		let mut txn = create_test_admin_transaction();
		let shape = ShapeId::Series(SeriesId(7));
		let config = Ttl {
			duration_nanos: 86_400_000_000_000,
			anchor: TtlAnchor::Created,
			cleanup_mode: TtlCleanupMode::Drop,
		};

		create_row_ttl(&mut txn, shape, &config).unwrap();

		let found = CatalogStore::find_row_ttl(&mut Transaction::Admin(&mut txn), shape)
			.unwrap()
			.expect("TTL config should be stored");
		assert_eq!(found, config);
	}

	#[test]
	fn test_create_row_ttl_overwrite() {
		let mut txn = create_test_admin_transaction();
		let shape = ShapeId::Table(TableId(42));
		let config_v1 = Ttl {
			duration_nanos: 300_000_000_000,
			anchor: TtlAnchor::Created,
			cleanup_mode: TtlCleanupMode::Drop,
		};
		let config_v2 = Ttl {
			duration_nanos: 600_000_000_000,
			anchor: TtlAnchor::Updated,
			cleanup_mode: TtlCleanupMode::Delete,
		};

		create_row_ttl(&mut txn, shape, &config_v1).unwrap();
		create_row_ttl(&mut txn, shape, &config_v2).unwrap();

		let found = CatalogStore::find_row_ttl(&mut Transaction::Admin(&mut txn), shape)
			.unwrap()
			.expect("TTL config should be stored");
		assert_eq!(found, config_v2);
	}
}