Expand description
Builder for registering DuckDB table functions.
Table functions are the backbone of “real” DuckDB extensions: they are
SELECT-able, support projection pushdown, named parameters, and can
produce arbitrary output schemas determined at query-parse time.
§Table function lifecycle
1. bind — parse args, declare output columns, optionally set cardinality hint
2. init — allocate global scan state (shared across threads)
3. local_init — allocate per-thread scan state (optional; parallelism itself
comes from `InitInfo::set_max_threads` in `init`)
4. scan — fill one output chunk; set chunk size to 0 when exhausted§Example: A constant table function
use quack_rs::table::{TableFunctionBuilder, FfiBindData, FfiInitData};
use quack_rs::types::TypeId;
use libduckdb_sys::{
duckdb_bind_info, duckdb_init_info, duckdb_function_info,
duckdb_data_chunk, duckdb_data_chunk_set_size,
};
struct Config { limit: u64 }
struct State { emitted: u64 }
unsafe extern "C" fn bind(info: duckdb_bind_info) {
unsafe {
// Declare the output schema.
quack_rs::table::BindInfo::new(info)
.add_result_column("n", TypeId::BigInt);
// Store bind-time configuration.
FfiBindData::<Config>::set(info, Config { limit: 100 });
}
}
unsafe extern "C" fn init(info: duckdb_init_info) {
unsafe { FfiInitData::<State>::set(info, State { emitted: 0 }); }
}
unsafe extern "C" fn scan(info: duckdb_function_info, output: duckdb_data_chunk) {
// scan logic
}
// fn register(con: libduckdb_sys::duckdb_connection) -> Result<(), quack_rs::error::ExtensionError> {
// unsafe {
// TableFunctionBuilder::new("my_table_fn")
// .bind(bind)
// .init(init)
// .scan(scan)
// .register(con)
// }
// }Structs§
- Table
Function Builder - Builder for registering a
DuckDBtable function. - Table
Function Handle - A configured
duckdb_table_functionthat has not been registered.
Type Aliases§
- BindFn
- The bind callback: declare output columns, read parameters, store bind data.
- Extra
Destroy Fn - The extra-info destructor callback: called by
DuckDBto free function-level extra data. - InitFn
- The init callback: allocate global scan state.
- ScanFn
- The scan callback: fill one output chunk; set chunk size to 0 when done.