Struct duckdb_extension_framework::TableFunction

pub struct TableFunction { /* private fields */ }

A function that returns a queryable table

Implementations

impl TableFunction

pub fn supports_pushdown(&self, supports: bool) -> &Self

Sets whether or not the given table function supports projection pushdown.

If this is set to true, the system will provide a list of all required columns in the init stage through the InitInfo::get_column_indices method. If this is set to false (the default), the system will expect all columns to be projected.

Arguments

• pushdown: True if the table function supports projection pushdown, false otherwise.

pub fn add_parameter(&self, logical_type: &LogicalType) -> &Self

Adds a parameter to the table function.

Arguments

• logical_type: The type of the parameter to add.

pub fn set_function(
    &self,
    func: Option<unsafe extern "C" fn(_: *mut c_void, _: *mut c_void)>
) -> &Self

Sets the main function of the table function

Arguments

• function: The function

pub fn set_init(
    &self,
    init_func: Option<unsafe extern "C" fn(_: *mut c_void)>
) -> &Self

Sets the init function of the table function

Arguments

• function: The init function

pub fn set_bind(
    &self,
    bind_func: Option<unsafe extern "C" fn(_: *mut c_void)>
) -> &Self

Sets the bind function of the table function

Arguments

• function: The bind function

pub fn new() -> Self

Creates a new empty table function.

pub fn set_name(&self, name: &str) -> &TableFunction

Sets the name of the given table function.

Arguments

• name: The name of the table function

pub unsafe fn set_extra_info(
    &self,
    extra_info: *mut c_void,
    destroy: duckdb_delete_callback_t
)

Assigns extra information to the table function that can be fetched during binding, etc.

Arguments

• extra_info: The extra information
• destroy: The callback that will be called to destroy the bind data (if any)

Safety

pub fn set_local_init(&self, init: duckdb_table_function_init_t)

Sets the thread-local init function of the table function

Arguments

• init: The init function

Trait Implementations

impl Debug for TableFunction

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

Formats the value using the given formatter.

impl Default for TableFunction

fn default() -> Self

Returns the “default value” for a type.

impl Drop for TableFunction

fn drop(&mut self)

Executes the destructor for this type.