Struct BindInfo

pub struct BindInfo { /* private fields */ }

An interface to store and retrieve data during the function bind stage

Implementations

impl BindInfo

pub fn add_result_column(&self, column_name: &str, column_type: LogicalType)

Adds a result column to the output of the table function.

Arguments

• name: The name of the column
• type: The logical type of the column

pub fn set_error(&self, error: &str)

Report that an error has occurred while calling bind.

Arguments

• error: The error message

pub unsafe fn set_bind_data( &self, data: *mut c_void, free_function: Option<unsafe extern "C" fn(*mut c_void)>, )

Sets the user-provided bind data in the bind object. This object can be retrieved again during execution.

Arguments

• extra_data: The bind data object.
• destroy: The callback that will be called to destroy the bind data (if any)

Safety

pub fn get_parameter_count(&self) -> u64

Retrieves the number of regular (non-named) parameters to the function.

pub fn get_parameter(&self, param_index: u64) -> Value

Retrieves the parameter at the given index.

Arguments

• index: The index of the parameter to get

returns: The value of the parameter

pub fn set_cardinality(&self, cardinality: idx_t, is_exact: bool)

Sets the cardinality estimate for the table function, used for optimization.

Arguments

• cardinality: The cardinality estimate
• is_exact: Whether or not the cardinality estimate is exact, or an approximation

pub fn get_extra_info<T>(&self) -> *const T

Retrieves the extra info of the function as set in TableFunction::set_extra_info

Arguments

• returns: The extra info

Trait Implementations

impl Debug for BindInfo

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<*mut c_void> for BindInfo

fn from(ptr: duckdb_bind_info) -> Self

Converts to this type from the input type.