reifydb-sdk 0.4.13

SDK for building ReifyDB operators, procedures, transforms and more
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

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

use std::collections::HashMap;

use reifydb_type::value::{Value, row_number::RowNumber};

pub mod builder;
pub mod change;
pub mod column;
pub mod context;
pub mod diff;
pub mod view_column;
pub mod view_row;

use change::BorrowedChange;
use column::OperatorColumn;
use context::OperatorContext;
use reifydb_core::interface::catalog::flow::FlowNodeId;
use reifydb_type::value::datetime::DateTime;

use crate::error::Result;

pub trait FFIOperatorMetadata {
	const NAME: &'static str;
	const API: u32;
	const VERSION: &'static str;
	const DESCRIPTION: &'static str;
	const INPUT_COLUMNS: &'static [OperatorColumn];
	const OUTPUT_COLUMNS: &'static [OperatorColumn];
	const CAPABILITIES: u32;
}

pub trait FFIOperator: 'static {
	fn new(operator_id: FlowNodeId, config: &HashMap<String, Value>) -> Result<Self>
	where
		Self: Sized;

	fn apply(&mut self, ctx: &mut OperatorContext, input: BorrowedChange<'_>) -> Result<()>;

	fn pull(&mut self, ctx: &mut OperatorContext, row_numbers: &[RowNumber]) -> Result<()>;

	fn tick(&mut self, _ctx: &mut OperatorContext, _timestamp: DateTime) -> Result<bool> {
		Ok(false)
	}

	fn flush_state(&mut self, _ctx: &mut OperatorContext) -> Result<()> {
		Ok(())
	}
}

pub trait FFIOperatorWithMetadata: FFIOperator + FFIOperatorMetadata {}
impl<T> FFIOperatorWithMetadata for T where T: FFIOperator + FFIOperatorMetadata {}