reifydb-routine 0.4.13

Built-in routines (functions and procedures) 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

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

use reifydb_catalog::catalog::Catalog;
use reifydb_core::util::ioc::IocContainer;
use reifydb_runtime::context::RuntimeContext;
use reifydb_transaction::transaction::Transaction;
use reifydb_type::{fragment::Fragment, params::Params, value::identity::IdentityId};

use super::{Context, sealed};

/// Execution context for a function.
///
/// A function impl writes `impl Routine<FunctionContext> for Foo`. The trait's
/// `execute` signature has no way to receive `&mut Transaction`, so a function
/// is guaranteed at the type level to be unable to mutate transactional state.
///
/// Functions don't get `catalog`/`ioc`  - they're pure operations on column
/// data. If a future "function" needs catalog access, it should be a
/// procedure instead.
pub struct FunctionContext<'a> {
	pub fragment: Fragment,
	pub identity: IdentityId,
	pub row_count: usize,
	pub runtime_context: &'a RuntimeContext,
}

impl sealed::Sealed for FunctionContext<'_> {}
impl Context for FunctionContext<'_> {}

/// Execution context for a procedure.
///
/// A procedure impl writes `impl Routine<ProcedureContext> for Foo`. The
/// transaction is reachable via `ctx.tx`. Procedures get the catalog and the
/// IOC container in addition to the shared facets, plus access to user-supplied
/// parameters as the legacy `Params` view.
pub struct ProcedureContext<'a, 'tx> {
	pub fragment: Fragment,
	pub identity: IdentityId,
	pub row_count: usize,
	pub runtime_context: &'a RuntimeContext,
	pub tx: &'a mut Transaction<'tx>,
	pub params: &'a Params,
	pub catalog: &'a Catalog,
	pub ioc: &'a IocContainer,
}

impl sealed::Sealed for ProcedureContext<'_, '_> {}
impl Context for ProcedureContext<'_, '_> {}