reifydb-cdc 0.4.6

Change Data Capture module 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

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

//! Engine interface trait for CDC consumers.
//!
//! This trait abstracts the engine operations needed by CDC consumers,
//! allowing the CDC crate to avoid a direct dependency on the engine crate.

use std::time::Duration;

use reifydb_catalog::schema::RowSchemaRegistry;
use reifydb_core::common::CommitVersion;
use reifydb_transaction::transaction::{command::CommandTransaction, query::QueryTransaction};
use reifydb_type::Result;

pub trait CdcHost: Clone + Send + Sync + 'static {
	/// Begin a new command transaction.
	fn begin_command(&self) -> Result<CommandTransaction>;

	/// Begin a new read-only query transaction.
	fn begin_query(&self) -> Result<QueryTransaction>;

	/// Get the current committed version.
	fn current_version(&self) -> Result<CommitVersion>;

	/// Get the version up to which all transactions are complete.
	fn done_until(&self) -> CommitVersion;

	/// Wait for the watermark to reach the specified version.
	/// Returns true if the version was reached, false if timeout.
	fn wait_for_mark_timeout(&self, version: CommitVersion, timeout: Duration) -> bool;

	/// Get the schema registry for fingerprint-based schema lookup.
	fn row_schema_registry(&self) -> &RowSchemaRegistry;
}