表函数API可用于定义一个表函数，然后可以在DuckDB的查询的FROM子句中调用该函数。
API Reference Overview
duckdb_table_function duckdb_create_table_function();
void duckdb_destroy_table_function(duckdb_table_function *table_function);
void duckdb_table_function_set_name(duckdb_table_function table_function, const char *name);
void duckdb_table_function_add_parameter(duckdb_table_function table_function, duckdb_logical_type type);
void duckdb_table_function_add_named_parameter(duckdb_table_function table_function, const char *name, duckdb_logical_type type);
void duckdb_table_function_set_extra_info(duckdb_table_function table_function, void *extra_info, duckdb_delete_callback_t destroy);
void duckdb_table_function_set_bind(duckdb_table_function table_function, duckdb_table_function_bind_t bind);
void duckdb_table_function_set_init(duckdb_table_function table_function, duckdb_table_function_init_t init);
void duckdb_table_function_set_local_init(duckdb_table_function table_function, duckdb_table_function_init_t init);
void duckdb_table_function_set_function(duckdb_table_function table_function, duckdb_table_function_t function);
void duckdb_table_function_supports_projection_pushdown(duckdb_table_function table_function, bool pushdown);
duckdb_state duckdb_register_table_function(duckdb_connection con, duckdb_table_function function);
表函数绑定
void *duckdb_bind_get_extra_info(duckdb_bind_info info);
void duckdb_bind_add_result_column(duckdb_bind_info info, const char *name, duckdb_logical_type type);
idx_t duckdb_bind_get_parameter_count(duckdb_bind_info info);
duckdb_value duckdb_bind_get_parameter(duckdb_bind_info info, idx_t index);
duckdb_value duckdb_bind_get_named_parameter(duckdb_bind_info info, const char *name);
void duckdb_bind_set_bind_data(duckdb_bind_info info, void *bind_data, duckdb_delete_callback_t destroy);
void duckdb_bind_set_cardinality(duckdb_bind_info info, idx_t cardinality, bool is_exact);
void duckdb_bind_set_error(duckdb_bind_info info, const char *error);
表函数初始化
void *duckdb_init_get_extra_info(duckdb_init_info info);
void *duckdb_init_get_bind_data(duckdb_init_info info);
void duckdb_init_set_init_data(duckdb_init_info info, void *init_data, duckdb_delete_callback_t destroy);
idx_t duckdb_init_get_column_count(duckdb_init_info info);
idx_t duckdb_init_get_column_index(duckdb_init_info info, idx_t column_index);
void duckdb_init_set_max_threads(duckdb_init_info info, idx_t max_threads);
void duckdb_init_set_error(duckdb_init_info info, const char *error);
Table Function
void *duckdb_function_get_extra_info(duckdb_function_info info);
void *duckdb_function_get_bind_data(duckdb_function_info info);
void *duckdb_function_get_init_data(duckdb_function_info info);
void *duckdb_function_get_local_init_data(duckdb_function_info info);
void duckdb_function_set_error(duckdb_function_info info, const char *error);
duckdb_create_table_function
创建一个新的空表函数。
返回值应使用duckdb_destroy_table_function销毁。
Return Value
表格函数对象。
Syntax
duckdb_table_function duckdb_create_table_function(
);
duckdb_destroy_table_function
销毁给定的表函数对象。
Syntax
void duckdb_destroy_table_function(
duckdb_table_function *table_function
);
Parameters
table_function: 要销毁的表函数
duckdb_table_function_set_name
设置给定表函数的名称。
Syntax
void duckdb_table_function_set_name(
duckdb_table_function table_function,
const char *name
);
Parameters
table_function: 表函数name: 表函数的名称
duckdb_table_function_add_parameter
向表函数添加一个参数。
Syntax
void duckdb_table_function_add_parameter(
duckdb_table_function table_function,
duckdb_logical_type type
);
Parameters
table_function: 表函数。type: 参数类型。不能包含 INVALID。
duckdb_table_function_add_named_parameter
向表函数添加一个命名参数。
Syntax
void duckdb_table_function_add_named_parameter(
duckdb_table_function table_function,
const char *name,
duckdb_logical_type type
);
Parameters
table_function: 表函数。name: 参数名称。type: 参数类型。不能包含 INVALID。
duckdb_table_function_set_extra_info
为表函数分配额外的信息，这些信息可以在绑定等过程中获取。
Syntax
void duckdb_table_function_set_extra_info(
duckdb_table_function table_function,
void *extra_info,
duckdb_delete_callback_t destroy
);
Parameters
table_function: 表函数extra_info: 额外信息destroy: 将调用的回调函数，用于销毁绑定的数据（如果有的话）
duckdb_table_function_set_bind
设置表函数的绑定函数。
Syntax
void duckdb_table_function_set_bind(
duckdb_table_function table_function,
duckdb_table_function_bind_t bind
);
Parameters
table_function: The table functionbind: 绑定函数
duckdb_table_function_set_init
设置表函数的初始化函数。
Syntax
void duckdb_table_function_set_init(
duckdb_table_function table_function,
duckdb_table_function_init_t init
);
Parameters
table_function: The table functioninit: 初始化函数
duckdb_table_function_set_local_init
设置表函数的线程本地初始化函数。
Syntax
void duckdb_table_function_set_local_init(
duckdb_table_function table_function,
duckdb_table_function_init_t init
);
Parameters
table_function: The table functioninit: 初始化函数
duckdb_table_function_set_function
设置表函数的主要功能。
Syntax
void duckdb_table_function_set_function(
duckdb_table_function table_function,
duckdb_table_function_t function
);
Parameters
table_function: The table functionfunction: 函数
duckdb_table_function_supports_projection_pushdown
设置给定的表函数是否支持投影下推。
如果将此设置为true，系统将在init阶段通过duckdb_init_get_column_count和duckdb_init_get_column_index函数提供所有所需列的列表。
如果将此设置为false（默认值），系统将期望所有列都被投影。
Syntax
void duckdb_table_function_supports_projection_pushdown(
duckdb_table_function table_function,
bool pushdown
);
Parameters
table_function: The table functionpushdown: 如果表函数支持投影下推，则为True，否则为False。
duckdb_register_table_function
在给定的连接中注册表函数对象。
该函数至少需要一个名称、一个绑定函数、一个初始化函数和一个主函数。
如果函数不完整或已存在同名函数，则返回DuckDBError。
Syntax
duckdb_state duckdb_register_table_function(
duckdb_connection con,
duckdb_table_function function
);
Parameters
con: 注册它的连接。function: 函数指针
Return Value
注册是否成功。
duckdb_bind_get_extra_info
检索在duckdb_table_function_set_extra_info中设置的函数的额外信息。
Syntax
void *duckdb_bind_get_extra_info(
duckdb_bind_info info
);
Parameters
info: The info object
Return Value
额外信息
duckdb_bind_add_result_column
向表函数的输出添加一个结果列。
Syntax
void duckdb_bind_add_result_column(
duckdb_bind_info info,
const char *name,
duckdb_logical_type type
);
Parameters
info: 表函数的绑定信息。name: 列名。type: 逻辑列类型。
duckdb_bind_get_parameter_count
获取函数的常规（非命名）参数的数量。
Syntax
idx_t duckdb_bind_get_parameter_count(
duckdb_bind_info info
);
Parameters
info: The info object
Return Value
参数的数量
duckdb_bind_get_parameter
检索给定索引处的参数。
结果必须使用duckdb_destroy_value销毁。
Syntax
duckdb_value duckdb_bind_get_parameter(
duckdb_bind_info info,
idx_t index
);
Parameters
info: The info objectindex: 要获取的参数的索引
Return Value
参数的值。必须使用duckdb_destroy_value销毁。
duckdb_bind_get_named_parameter
检索具有给定名称的命名参数。
结果必须使用duckdb_destroy_value销毁。
Syntax
duckdb_value duckdb_bind_get_named_parameter(
duckdb_bind_info info,
const char *name
);
Parameters
info: The info objectname: 参数的名称
Return Value
参数的值。必须使用duckdb_destroy_value销毁。
duckdb_bind_set_bind_data
在绑定对象中设置用户提供的绑定数据。此对象可以在执行期间再次检索。
Syntax
void duckdb_bind_set_bind_data(
duckdb_bind_info info,
void *bind_data,
duckdb_delete_callback_t destroy
);
Parameters
info: The info objectbind_data: 绑定数据对象。destroy: The callback that will be called to destroy the bind data (if any)
duckdb_bind_set_cardinality
设置表函数的基数估计，用于优化。
Syntax
void duckdb_bind_set_cardinality(
duckdb_bind_info info,
idx_t cardinality,
bool is_exact
);
Parameters
info: 绑定的数据对象。is_exact: 基数估计是否精确，或者是一个近似值
duckdb_bind_set_error
报告在调用bind时发生错误。
Syntax
void duckdb_bind_set_error(
duckdb_bind_info info,
const char *error
);
Parameters
info: The info objecterror: The error message
duckdb_init_get_extra_info
Retrieves the extra info of the function as set in duckdb_table_function_set_extra_info.
Syntax
void *duckdb_init_get_extra_info(
duckdb_init_info info
);
Parameters
info: The info object
Return Value
额外信息
duckdb_init_get_bind_data
获取在绑定期间由duckdb_bind_set_bind_data设置的绑定数据集。
请注意，绑定数据应被视为只读。 对于跟踪状态，请改用初始化数据。
Syntax
void *duckdb_init_get_bind_data(
duckdb_init_info info
);
Parameters
info: The info object
Return Value
绑定数据对象
duckdb_init_set_init_data
在初始化对象中设置用户提供的初始化数据。此对象可以在执行期间再次检索。
Syntax
void duckdb_init_set_init_data(
duckdb_init_info info,
void *init_data,
duckdb_delete_callback_t destroy
);
Parameters
info: The info objectinit_data: 初始化数据对象。destroy: 用于销毁初始化数据（如果有的话）的回调函数
duckdb_init_get_column_count
返回投影列的数量。
如果启用了投影下推，必须使用此函数来确定要发出的列。
Syntax
idx_t duckdb_init_get_column_count(
duckdb_init_info info
);
Parameters
info: The info object
Return Value
预计的列数。
duckdb_init_get_column_index
返回指定位置投影列的列索引。
如果启用了投影下推，必须使用此函数来确定要发出的列。
Syntax
idx_t duckdb_init_get_column_index(
duckdb_init_info info,
idx_t column_index
);
Parameters
info: The info objectcolumn_index: 获取投影列索引的位置，范围从0到duckdb_init_get_column_count(info)
Return Value
投影列的列索引。
duckdb_init_set_max_threads
设置可以并行处理此表函数的线程数（默认值：1）
Syntax
void duckdb_init_set_max_threads(
duckdb_init_info info,
idx_t max_threads
);
Parameters
info: The info objectmax_threads: 可以处理此表函数的最大线程数
duckdb_init_set_error
报告在调用init时发生错误。
Syntax
void duckdb_init_set_error(
duckdb_init_info info,
const char *error
);
Parameters
info: The info objecterror: The error message
duckdb_function_get_extra_info
Retrieves the extra info of the function as set in duckdb_table_function_set_extra_info.
Syntax
void *duckdb_function_get_extra_info(
duckdb_function_info info
);
Parameters
info: The info object
Return Value
额外信息
duckdb_function_get_bind_data
Gets the bind data set by duckdb_bind_set_bind_data during the bind.
请注意，绑定数据应被视为只读。 对于跟踪状态，请改用初始化数据。
Syntax
void *duckdb_function_get_bind_data(
duckdb_function_info info
);
Parameters
info: The info object
Return Value
绑定数据对象
duckdb_function_get_init_data
获取在初始化期间由duckdb_init_set_init_data设置的初始数据集。
Syntax
void *duckdb_function_get_init_data(
duckdb_function_info info
);
Parameters
info: The info object
Return Value
初始化数据对象
duckdb_function_get_local_init_data
获取在local_init期间由duckdb_init_set_init_data设置的线程本地初始化数据。
Syntax
void *duckdb_function_get_local_init_data(
duckdb_function_info info
);
Parameters
info: The info object
Return Value
初始化数据对象
duckdb_function_set_error
报告在执行函数时发生了错误。
Syntax
void duckdb_function_set_error(
duckdb_function_info info,
const char *error
);
Parameters
info: The info objecterror: The error message