reifydb-core 0.4.12

Core database interfaces and data structures 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

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

//! Catalog change tracking traits.
//!
//! These traits are used by command transactions to track changes to catalog entities
//! during a transaction, allowing for proper transactional semantics and rollback.

use reifydb_type::Result;

use crate::{
	interface::catalog::{
		authentication::Authentication,
		binding::Binding,
		config::Config,
		dictionary::Dictionary,
		flow::Flow,
		handler::Handler,
		identity::{GrantedRole, Identity, Role},
		migration::{Migration, MigrationEvent},
		namespace::Namespace,
		policy::Policy,
		procedure::Procedure,
		ringbuffer::RingBuffer,
		series::Series,
		shape::ShapeId,
		sink::Sink,
		source::Source,
		sumtype::SumType,
		table::Table,
		test::Test,
		view::View,
	},
	row::RowTtl,
};

/// Trait for tracking configuration changes during a transaction.
pub trait CatalogTrackConfigChangeOperations {
	fn track_config_set(&mut self, pre: Config, post: Config) -> Result<()>;
}

/// Trait for tracking table definition changes during a transaction.
pub trait CatalogTrackTableChangeOperations {
	fn track_table_created(&mut self, table: Table) -> Result<()>;

	fn track_table_updated(&mut self, pre: Table, post: Table) -> Result<()>;

	fn track_table_deleted(&mut self, table: Table) -> Result<()>;
}

/// Trait for tracking namespace definition changes during a transaction.
pub trait CatalogTrackNamespaceChangeOperations {
	fn track_namespace_created(&mut self, namespace: Namespace) -> Result<()>;

	fn track_namespace_updated(&mut self, pre: Namespace, post: Namespace) -> Result<()>;

	fn track_namespace_deleted(&mut self, namespace: Namespace) -> Result<()>;
}

/// Trait for tracking flow definition changes during a transaction.
pub trait CatalogTrackFlowChangeOperations {
	fn track_flow_created(&mut self, flow: Flow) -> Result<()>;

	fn track_flow_updated(&mut self, pre: Flow, post: Flow) -> Result<()>;

	fn track_flow_deleted(&mut self, flow: Flow) -> Result<()>;
}

/// Trait for tracking view definition changes during a transaction.
pub trait CatalogTrackViewChangeOperations {
	fn track_view_created(&mut self, view: View) -> Result<()>;

	fn track_view_updated(&mut self, pre: View, post: View) -> Result<()>;

	fn track_view_deleted(&mut self, view: View) -> Result<()>;
}

/// Trait for tracking dictionary definition changes during a transaction.
pub trait CatalogTrackDictionaryChangeOperations {
	fn track_dictionary_created(&mut self, dictionary: Dictionary) -> Result<()>;

	fn track_dictionary_updated(&mut self, pre: Dictionary, post: Dictionary) -> Result<()>;

	fn track_dictionary_deleted(&mut self, dictionary: Dictionary) -> Result<()>;
}

/// Trait for tracking series definition changes during a transaction.
pub trait CatalogTrackSeriesChangeOperations {
	fn track_series_created(&mut self, series: Series) -> Result<()>;

	fn track_series_updated(&mut self, pre: Series, post: Series) -> Result<()>;

	fn track_series_deleted(&mut self, series: Series) -> Result<()>;
}

/// Trait for tracking ringbuffer definition changes during a transaction.
pub trait CatalogTrackRingBufferChangeOperations {
	fn track_ringbuffer_created(&mut self, ringbuffer: RingBuffer) -> Result<()>;

	fn track_ringbuffer_updated(&mut self, pre: RingBuffer, post: RingBuffer) -> Result<()>;

	fn track_ringbuffer_deleted(&mut self, ringbuffer: RingBuffer) -> Result<()>;
}

/// Trait for tracking sum type definition changes during a transaction.
pub trait CatalogTrackSumTypeChangeOperations {
	fn track_sumtype_created(&mut self, sumtype: SumType) -> Result<()>;

	fn track_sumtype_updated(&mut self, pre: SumType, post: SumType) -> Result<()>;

	fn track_sumtype_deleted(&mut self, sumtype: SumType) -> Result<()>;
}

/// Trait for tracking procedure definition changes during a transaction.
pub trait CatalogTrackProcedureChangeOperations {
	fn track_procedure_created(&mut self, procedure: Procedure) -> Result<()>;

	fn track_procedure_updated(&mut self, pre: Procedure, post: Procedure) -> Result<()>;

	fn track_procedure_deleted(&mut self, procedure: Procedure) -> Result<()>;
}

/// Trait for tracking test definition changes during a transaction.
pub trait CatalogTrackTestChangeOperations {
	fn track_test_created(&mut self, test: Test) -> Result<()>;

	fn track_test_deleted(&mut self, test: Test) -> Result<()>;
}

/// Trait for tracking handler definition changes during a transaction.
pub trait CatalogTrackHandlerChangeOperations {
	fn track_handler_created(&mut self, handler: Handler) -> Result<()>;

	fn track_handler_deleted(&mut self, handler: Handler) -> Result<()>;
}

/// Trait for tracking identity definition changes during a transaction.
pub trait CatalogTrackIdentityChangeOperations {
	fn track_identity_created(&mut self, identity: Identity) -> Result<()>;

	fn track_identity_updated(&mut self, pre: Identity, post: Identity) -> Result<()>;

	fn track_identity_deleted(&mut self, identity: Identity) -> Result<()>;
}

/// Trait for tracking role definition changes during a transaction.
pub trait CatalogTrackRoleChangeOperations {
	fn track_role_created(&mut self, role: Role) -> Result<()>;

	fn track_role_updated(&mut self, pre: Role, post: Role) -> Result<()>;

	fn track_role_deleted(&mut self, role: Role) -> Result<()>;
}

/// Trait for tracking granted-role changes during a transaction.
pub trait CatalogTrackGrantedRoleChangeOperations {
	fn track_granted_role_created(&mut self, granted_role: GrantedRole) -> Result<()>;

	fn track_granted_role_deleted(&mut self, granted_role: GrantedRole) -> Result<()>;
}

/// Trait for tracking policy definition changes during a transaction.
pub trait CatalogTrackPolicyChangeOperations {
	fn track_policy_created(&mut self, policy: Policy) -> Result<()>;

	fn track_policy_updated(&mut self, pre: Policy, post: Policy) -> Result<()>;

	fn track_policy_deleted(&mut self, policy: Policy) -> Result<()>;
}

/// Trait for tracking migration definition changes during a transaction.
pub trait CatalogTrackMigrationChangeOperations {
	fn track_migration_created(&mut self, migration: Migration) -> Result<()>;

	fn track_migration_deleted(&mut self, migration: Migration) -> Result<()>;
}

/// Trait for tracking migration event changes during a transaction.
pub trait CatalogTrackMigrationEventChangeOperations {
	fn track_migration_event_created(&mut self, event: MigrationEvent) -> Result<()>;
}

/// Trait for tracking authentication definition changes during a transaction.
pub trait CatalogTrackAuthenticationChangeOperations {
	fn track_authentication_created(&mut self, auth: Authentication) -> Result<()>;

	fn track_authentication_deleted(&mut self, auth: Authentication) -> Result<()>;
}

/// Trait for tracking source definition changes during a transaction.
pub trait CatalogTrackSourceChangeOperations {
	fn track_source_created(&mut self, source: Source) -> Result<()>;

	fn track_source_deleted(&mut self, source: Source) -> Result<()>;
}

/// Trait for tracking binding definition changes during a transaction.
pub trait CatalogTrackBindingChangeOperations {
	fn track_binding_created(&mut self, binding: Binding) -> Result<()>;

	fn track_binding_deleted(&mut self, binding: Binding) -> Result<()>;
}

/// Trait for tracking sink definition changes during a transaction.
pub trait CatalogTrackSinkChangeOperations {
	fn track_sink_created(&mut self, sink: Sink) -> Result<()>;

	fn track_sink_deleted(&mut self, sink: Sink) -> Result<()>;
}

/// Trait for tracking row TTL changes during a transaction.
pub trait CatalogTrackRowTtlChangeOperations {
	fn track_row_ttl_created(&mut self, shape: ShapeId, ttl: RowTtl) -> Result<()>;

	fn track_row_ttl_updated(&mut self, shape: ShapeId, pre: RowTtl, post: RowTtl) -> Result<()>;

	fn track_row_ttl_deleted(&mut self, shape: ShapeId, ttl: RowTtl) -> Result<()>;
}

/// Umbrella trait for all catalog change tracking operations.
pub trait CatalogTrackChangeOperations:
	CatalogTrackBindingChangeOperations
	+ CatalogTrackDictionaryChangeOperations
	+ CatalogTrackFlowChangeOperations
	+ CatalogTrackHandlerChangeOperations
	+ CatalogTrackMigrationChangeOperations
	+ CatalogTrackMigrationEventChangeOperations
	+ CatalogTrackNamespaceChangeOperations
	+ CatalogTrackProcedureChangeOperations
	+ CatalogTrackRingBufferChangeOperations
	+ CatalogTrackRoleChangeOperations
	+ CatalogTrackPolicyChangeOperations
	+ CatalogTrackSeriesChangeOperations
	+ CatalogTrackSinkChangeOperations
	+ CatalogTrackSourceChangeOperations
	+ CatalogTrackSumTypeChangeOperations
	+ CatalogTrackTableChangeOperations
	+ CatalogTrackTestChangeOperations
	+ CatalogTrackAuthenticationChangeOperations
	+ CatalogTrackIdentityChangeOperations
	+ CatalogTrackGrantedRoleChangeOperations
	+ CatalogTrackViewChangeOperations
	+ CatalogTrackConfigChangeOperations
	+ CatalogTrackRowTtlChangeOperations
{
}