pub struct InitInfo { /* private fields */ }Expand description
Helper wrapper around duckdb_init_info for use inside init callbacks.
Provides ergonomic methods for the most common init operations.
Implementations§
Source§impl InitInfo
impl InitInfo
Sourcepub fn projected_column_count(&self) -> usize
pub fn projected_column_count(&self) -> usize
Returns the number of projected (requested) columns.
Only valid when projection pushdown is enabled for the table function.
Sourcepub fn projected_column_index(&self, projection_idx: usize) -> Option<usize>
pub fn projected_column_index(&self, projection_idx: usize) -> Option<usize>
Returns the declared column index at the given projection position, or
None when projection_idx is not less than
projected_column_count.
Only meaningful when projection pushdown is enabled.
duckdb_init_get_column_index answers an out-of-range position with
0 — indistinguishable from “the first declared column” — so the range
check happens here.
Sourcepub fn set_max_threads(&self, n: u64)
pub fn set_max_threads(&self, n: u64)
Sets the maximum number of threads for parallel scanning.
The default is 1. Above 1, DuckDB may call the scan callback from up
to n threads at the same time, whether or not local_init is set
(local_init only gives each thread its own state; it is not what
enables parallelism). All of those calls share the one global init
data and the one bind data, so after raising this, the scan must not
use FfiInitData::get_mut; keep
shared mutable state behind a Mutex or atomics instead.
Sourcepub fn set_error(&self, message: &str)
pub fn set_error(&self, message: &str)
Reports an error from the init callback.
An interior null byte in message is replaced by ?.
An empty message is replaced by EMPTY_ERROR_PLACEHOLDER.
Sourcepub unsafe fn get_extra_info(&self) -> *mut c_void
pub unsafe fn get_extra_info(&self) -> *mut c_void
Returns the extra info pointer set on the table function.
§Safety
The caller must ensure the returned pointer (if non-null) is used according to its original type.