Expand description
Builder for registering DuckDB scalar functions.
Scalar functions process one data chunk at a time and return a single value
per row. They are the most common type of function in DuckDB extensions.
Both ScalarFunctionBuilder and ScalarFunctionSetBuilder support:
- Simple parameter types via
param(TypeId) - Complex parameterized types via
param_logical(LogicalType)(e.g.,LIST(BIGINT),MAP(VARCHAR, INTEGER),STRUCT(...)) - Complex return types via
returns_logical(LogicalType) - Per-function NULL handling via
null_handling(NullHandling)
§Example
use quack_rs::scalar::ScalarFunctionBuilder;
use quack_rs::types::TypeId;
use libduckdb_sys::{duckdb_connection, duckdb_function_info, duckdb_data_chunk,
duckdb_vector};
unsafe extern "C" fn my_func(
_info: duckdb_function_info,
_input: duckdb_data_chunk,
_output: duckdb_vector,
) {}
// fn register(con: duckdb_connection) -> Result<(), quack_rs::error::ExtensionError> {
// unsafe {
// ScalarFunctionBuilder::new("double_it")
// .param(TypeId::BigInt)
// .returns(TypeId::BigInt)
// .function(my_func)
// .register(con)
// }
// }Re-exports§
pub use builder::ScalarFunctionBuilder;pub use builder::ScalarFunctionSetBuilder;pub use builder::ScalarOverloadBuilder;pub use builder::ScalarFn;pub use builder::ScalarBindFn;pub use builder::ScalarInitFn;pub use info::ScalarFunctionInfo;pub use info::RawScalarBindInfo;pub use info::RawScalarInitInfo;pub use info::ScalarBindInfo;pub use info::ScalarInitInfo;pub use state::ScalarBindData;pub use state::ScalarLocalState;pub use typed::ScalarOut;pub use typed::ScalarValue;
Modules§
- builder
- Builder for registering
DuckDBscalar functions. - info
- Ergonomic wrapper around
duckdb_function_infofor scalar function callbacks. - state
- Typed bind data and per-thread local state for scalar functions.
Typed bind data and per-thread local state for scalar functions
(
DuckDB1.5.0+). - typed
- Scalar functions written as ordinary Rust closures.
Structs§
- Typed
Scalar Function Builder - A scalar function built from a safe Rust closure, ready to register.