reifydb-catalog 0.4.13

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

use reifydb_core::{
	interface::catalog::{
		id::{NamespaceId, RingBufferId},
		ringbuffer::{PartitionedMetadata, RingBuffer, RingBufferMetadata},
	},
	key::{
		namespace_ringbuffer::NamespaceRingBufferKey,
		ringbuffer::{RingBufferKey, RingBufferMetadataKey},
	},
	util::encoding::keycode::deserializer::KeyDeserializer,
};
use reifydb_transaction::transaction::Transaction;
use reifydb_type::value::Value;

use crate::{
	CatalogStore, Result,
	store::ringbuffer::{
		shape::{ringbuffer, ringbuffer_metadata, ringbuffer_namespace},
		update::decode_ringbuffer_metadata,
	},
};

impl CatalogStore {
	pub(crate) fn find_ringbuffer(
		rx: &mut Transaction<'_>,
		ringbuffer: RingBufferId,
	) -> Result<Option<RingBuffer>> {
		let Some(multi) = rx.get(&RingBufferKey::encoded(ringbuffer))? else {
			return Ok(None);
		};

		let row = multi.row;
		let id = RingBufferId(ringbuffer::SHAPE.get_u64(&row, ringbuffer::ID));
		let namespace = NamespaceId(ringbuffer::SHAPE.get_u64(&row, ringbuffer::NAMESPACE));
		let name = ringbuffer::SHAPE.get_utf8(&row, ringbuffer::NAME).to_string();
		let capacity = ringbuffer::SHAPE.get_u64(&row, ringbuffer::CAPACITY);

		let partition_by_str = ringbuffer::SHAPE.get_utf8(&row, ringbuffer::PARTITION_BY);
		let partition_by = if partition_by_str.is_empty() {
			vec![]
		} else {
			partition_by_str.split(',').map(|s| s.to_string()).collect()
		};
		let underlying = ringbuffer::SHAPE.get_u8(&row, ringbuffer::UNDERLYING) != 0;

		Ok(Some(RingBuffer {
			id,
			namespace,
			name,
			capacity,
			columns: Self::list_columns(rx, id)?,
			primary_key: Self::find_primary_key(rx, id)?,
			partition_by,
			underlying,
		}))
	}

	pub(crate) fn find_ringbuffer_metadata(
		rx: &mut Transaction<'_>,
		ringbuffer: RingBufferId,
	) -> Result<Option<RingBufferMetadata>> {
		let Some(multi) = rx.get(&RingBufferMetadataKey::encoded(ringbuffer))? else {
			return Ok(None);
		};

		let row = multi.row;
		let buffer_id = RingBufferId(ringbuffer_metadata::SHAPE.get_u64(&row, ringbuffer_metadata::ID));
		let capacity = ringbuffer_metadata::SHAPE.get_u64(&row, ringbuffer_metadata::CAPACITY);
		let head = ringbuffer_metadata::SHAPE.get_u64(&row, ringbuffer_metadata::HEAD);
		let tail = ringbuffer_metadata::SHAPE.get_u64(&row, ringbuffer_metadata::TAIL);
		let current_size = ringbuffer_metadata::SHAPE.get_u64(&row, ringbuffer_metadata::COUNT);

		Ok(Some(RingBufferMetadata {
			id: buffer_id,
			capacity,
			count: current_size,
			head,
			tail,
		}))
	}

	pub(crate) fn find_ringbuffer_partition_metadata(
		rx: &mut Transaction<'_>,
		ringbuffer: RingBufferId,
		partition_values: &[Value],
	) -> Result<Option<RingBufferMetadata>> {
		let key = RingBufferMetadataKey::encoded_partition(ringbuffer, partition_values.to_vec());
		let Some(multi) = rx.get(&key)? else {
			return Ok(None);
		};

		Ok(Some(decode_ringbuffer_metadata(&multi.row)))
	}

	pub(crate) fn list_ringbuffer_partition_metadata(
		rx: &mut Transaction<'_>,
		ringbuffer: &RingBuffer,
	) -> Result<Vec<PartitionedMetadata>> {
		let range = RingBufferMetadataKey::full_scan_for_ringbuffer(ringbuffer.id);
		let stream = rx.range(range, 4096)?;
		let mut results = Vec::new();

		for entry in stream {
			let multi = entry?;
			let metadata = decode_ringbuffer_metadata(&multi.row);
			let mut de = KeyDeserializer::from_bytes(multi.key.as_slice());
			// Skip version (u8), kind (u8), ringbuffer_id (u64)
			let _ = (de.read_u8(), de.read_u8(), de.read_u64());
			let mut partition_values = vec![];
			while !de.is_empty() {
				if let Ok(value) = de.read_value() {
					partition_values.push(value);
				} else {
					break;
				}
			}
			results.push(PartitionedMetadata {
				metadata,
				partition_values,
			});
		}

		Ok(results)
	}

	/// Returns all partitions for a ringbuffer. Global = 1-element vec, partitioned = N-element vec.
	pub(crate) fn list_ringbuffer_partitions(
		rx: &mut Transaction<'_>,
		ringbuffer: &RingBuffer,
	) -> Result<Vec<PartitionedMetadata>> {
		if ringbuffer.partition_by.is_empty() {
			Ok(Self::find_ringbuffer_metadata(rx, ringbuffer.id)?
				.into_iter()
				.map(|metadata| PartitionedMetadata {
					metadata,
					partition_values: vec![],
				})
				.collect())
		} else {
			Self::list_ringbuffer_partition_metadata(rx, ringbuffer)
		}
	}

	/// Find metadata for a specific partition. Global uses empty key → RingBufferMetadataKey.
	pub(crate) fn find_partition_metadata(
		rx: &mut Transaction<'_>,
		ringbuffer: &RingBuffer,
		partition_key: &[Value],
	) -> Result<Option<RingBufferMetadata>> {
		if ringbuffer.partition_by.is_empty() {
			Self::find_ringbuffer_metadata(rx, ringbuffer.id)
		} else {
			Self::find_ringbuffer_partition_metadata(rx, ringbuffer.id, partition_key)
		}
	}

	pub(crate) fn find_ringbuffer_by_name(
		rx: &mut Transaction<'_>,
		namespace: NamespaceId,
		name: impl AsRef<str>,
	) -> Result<Option<RingBuffer>> {
		let name = name.as_ref();
		let mut stream = rx.range(NamespaceRingBufferKey::full_scan(namespace), 1024)?;

		let mut found_ringbuffer = None;
		for entry in stream.by_ref() {
			let multi = entry?;
			let row = &multi.row;
			let ringbuffer_name = ringbuffer_namespace::SHAPE.get_utf8(row, ringbuffer_namespace::NAME);
			if name == ringbuffer_name {
				found_ringbuffer = Some(RingBufferId(
					ringbuffer_namespace::SHAPE.get_u64(row, ringbuffer_namespace::ID),
				));
				break;
			}
		}

		drop(stream);

		let Some(ringbuffer) = found_ringbuffer else {
			return Ok(None);
		};

		Ok(Some(Self::get_ringbuffer(rx, ringbuffer)?))
	}
}

#[cfg(test)]
pub mod tests {
	use reifydb_core::interface::catalog::id::{NamespaceId, RingBufferId};
	use reifydb_engine::test_harness::create_test_admin_transaction;
	use reifydb_transaction::transaction::Transaction;
	use reifydb_type::{
		fragment::Fragment,
		value::{constraint::TypeConstraint, r#type::Type},
	};

	use crate::{
		CatalogStore,
		store::{
			namespace::create::NamespaceToCreate,
			primary_key::create::PrimaryKeyToCreate,
			ringbuffer::create::{RingBufferColumnToCreate, RingBufferToCreate},
		},
		test_utils::{ensure_test_namespace, ensure_test_ringbuffer},
	};

	#[test]
	fn test_find_ringbuffer_exists() {
		let mut txn = create_test_admin_transaction();
		let ringbuffer = ensure_test_ringbuffer(&mut txn);

		let found = CatalogStore::find_ringbuffer(&mut Transaction::Admin(&mut txn), ringbuffer.id)
			.unwrap()
			.expect("Ring buffer should exist");

		assert_eq!(found.id, ringbuffer.id);
		assert_eq!(found.name, ringbuffer.name);
		assert_eq!(found.namespace, ringbuffer.namespace);
		assert_eq!(found.capacity, ringbuffer.capacity);
	}

	#[test]
	fn test_find_ringbuffer_not_exists() {
		let mut txn = create_test_admin_transaction();

		let result =
			CatalogStore::find_ringbuffer(&mut Transaction::Admin(&mut txn), RingBufferId(999)).unwrap();

		assert!(result.is_none());
	}

	#[test]
	fn test_find_ringbuffer_metadata() {
		let mut txn = create_test_admin_transaction();
		let ringbuffer = ensure_test_ringbuffer(&mut txn);

		let metadata = CatalogStore::find_ringbuffer_metadata(&mut Transaction::Admin(&mut txn), ringbuffer.id)
			.unwrap()
			.expect("Metadata should exist");

		assert_eq!(metadata.id, ringbuffer.id);
		assert_eq!(metadata.capacity, ringbuffer.capacity);
		assert_eq!(metadata.count, 0);
		assert_eq!(metadata.head, 1);
		assert_eq!(metadata.tail, 1);
	}

	#[test]
	fn test_find_ringbuffer_metadata_not_exists() {
		let mut txn = create_test_admin_transaction();

		let result =
			CatalogStore::find_ringbuffer_metadata(&mut Transaction::Admin(&mut txn), RingBufferId(999))
				.unwrap();

		assert!(result.is_none());
	}

	#[test]
	fn test_find_ringbuffer_by_name_exists() {
		let mut txn = create_test_admin_transaction();
		let namespace = ensure_test_namespace(&mut txn);

		// Create a ring buffer with specific name
		let to_create = RingBufferToCreate {
			namespace: namespace.id(),
			name: Fragment::internal("trades_buffer"),
			capacity: 200,
			columns: vec![RingBufferColumnToCreate {
				name: Fragment::internal("symbol"),
				fragment: Fragment::None,
				constraint: TypeConstraint::unconstrained(Type::Utf8),
				properties: vec![],
				auto_increment: false,
				dictionary_id: None,
			}],
			partition_by: vec![],
			underlying: false,
		};

		let created = CatalogStore::create_ringbuffer(&mut txn, to_create).unwrap();

		// Find by name
		let found = CatalogStore::find_ringbuffer_by_name(
			&mut Transaction::Admin(&mut txn),
			namespace.id(),
			"trades_buffer",
		)
		.unwrap()
		.expect("Should find ring buffer by name");

		assert_eq!(found.id, created.id);
		assert_eq!(found.name, "trades_buffer");
		assert_eq!(found.capacity, 200);
		assert_eq!(found.columns.len(), 1);
	}

	#[test]
	fn test_find_ringbuffer_by_name_not_exists() {
		let mut txn = create_test_admin_transaction();
		let namespace = ensure_test_namespace(&mut txn);

		let result = CatalogStore::find_ringbuffer_by_name(
			&mut Transaction::Admin(&mut txn),
			namespace.id(),
			"nonexistent_buffer",
		)
		.unwrap();

		assert!(result.is_none());
	}

	#[test]
	fn test_find_ringbuffer_by_name_different_namespace() {
		let mut txn = create_test_admin_transaction();
		let namespace1 = ensure_test_namespace(&mut txn);

		// Create namespace2
		let namespace2 = CatalogStore::create_namespace(
			&mut txn,
			NamespaceToCreate {
				namespace_fragment: None,
				name: "namespace2".to_string(),
				local_name: "namespace2".to_string(),
				parent_id: NamespaceId::ROOT,
				grpc: None,
				token: None,
			},
		)
		.unwrap();

		// Create ring buffer in namespace1
		let to_create = RingBufferToCreate {
			namespace: namespace1.id(),
			name: Fragment::internal("shared_name"),
			capacity: 50,
			columns: vec![],
			partition_by: vec![],
			underlying: false,
		};

		CatalogStore::create_ringbuffer(&mut txn, to_create).unwrap();

		// Try to find in namespace2 - should not exist
		let result = CatalogStore::find_ringbuffer_by_name(
			&mut Transaction::Admin(&mut txn),
			namespace2.id(),
			"shared_name",
		)
		.unwrap();

		assert!(result.is_none());

		// Find in namespace1 - should exist
		let found = CatalogStore::find_ringbuffer_by_name(
			&mut Transaction::Admin(&mut txn),
			namespace1.id(),
			"shared_name",
		)
		.unwrap();

		assert!(found.is_some());
	}

	#[test]
	fn test_find_ringbuffer_with_columns_and_primary_key() {
		let mut txn = create_test_admin_transaction();
		let namespace = ensure_test_namespace(&mut txn);

		// Create ring buffer with columns
		let to_create = RingBufferToCreate {
			namespace: namespace.id(),
			name: Fragment::internal("pk_buffer"),
			capacity: 100,
			columns: vec![
				RingBufferColumnToCreate {
					name: Fragment::internal("id"),
					fragment: Fragment::None,
					constraint: TypeConstraint::unconstrained(Type::Uint8),
					properties: vec![],
					auto_increment: true,
					dictionary_id: None,
				},
				RingBufferColumnToCreate {
					name: Fragment::internal("value"),
					fragment: Fragment::None,
					constraint: TypeConstraint::unconstrained(Type::Float8),
					properties: vec![],
					auto_increment: false,
					dictionary_id: None,
				},
			],
			partition_by: vec![],
			underlying: false,
		};

		let created = CatalogStore::create_ringbuffer(&mut txn, to_create).unwrap();

		// Add primary key
		let columns = CatalogStore::list_columns(&mut Transaction::Admin(&mut txn), created.id).unwrap();
		let pk_id = CatalogStore::create_primary_key(
			&mut txn,
			PrimaryKeyToCreate {
				shape: created.id.into(),
				column_ids: vec![columns[0].id],
			},
		)
		.unwrap();

		// Find and verify
		let found = CatalogStore::find_ringbuffer(&mut Transaction::Admin(&mut txn), created.id)
			.unwrap()
			.expect("Ring buffer should exist");

		assert_eq!(found.columns.len(), 2);
		assert_eq!(found.columns[0].name, "id");
		assert_eq!(found.columns[0].auto_increment, true);
		assert_eq!(found.columns[1].name, "value");
		assert!(found.primary_key.is_some());
		assert_eq!(found.primary_key.unwrap().id, pk_id);
	}
}