kuzu::function::TableFunction Struct Reference

#include <table_functions.h>

Inheritance diagram for kuzu::function::TableFunction:

Public Member Functions
	TableFunction ()
	TableFunction (std::string name, std::vector< common::LogicalTypeID > inputTypes)
	TableFunction (std::string name, table_func_t tableFunc, table_func_bind_t bindFunc, table_func_init_shared_t initSharedFunc, table_func_init_local_t initLocalFunc, std::vector< common::LogicalTypeID > inputTypes, std::optional< table_func_finalize_t > finalizeFunc={})
	TableFunction (std::string name, table_func_t tableFunc, table_func_bind_t bindFunc, table_func_init_shared_t initSharedFunc, table_func_init_local_t initLocalFunc, table_func_progress_t progressFunc, std::vector< common::LogicalTypeID > inputTypes, std::optional< table_func_finalize_t > finalizeFunc={})
std::string	signatureToString () const override
virtual std::unique_ptr< TableFunction >	copy () const
Public Member Functions inherited from kuzu::function::Function
	Function ()
	Function (std::string name, std::vector< common::LogicalTypeID > parameterTypeIDs)
	Function (const Function &)=default
virtual	~Function ()=default
template<class TARGET >
const TARGET *	constPtrCast () const
template<class TARGET >
TARGET *	ptrCast ()

Public Attributes
table_func_t	tableFunc = nullptr
table_func_bind_t	bindFunc = nullptr
table_func_init_shared_t	initSharedStateFunc = nullptr
table_func_init_local_t	initLocalStateFunc = nullptr
table_func_can_parallel_t	canParallelFunc = [] { return true; }
table_func_progress_t	progressFunc = [](TableFuncSharedState*) { return 0.0; }
table_func_finalize_t	finalizeFunc = [](auto, auto, auto) {}
table_func_rewrite_t	rewriteFunc
Public Attributes inherited from kuzu::function::Function
std::string	name
std::vector< common::LogicalTypeID >	parameterTypeIDs
bool	isVarLength = false
bool	isListLambda = false

Constructor & Destructor Documentation

TableFunction() [1/4]

kuzu::function::TableFunction::TableFunction ( )

inline

TableFunction() [2/4]

kuzu::function::TableFunction::TableFunction ( std::string name, std::vector< common::LogicalTypeID > inputTypes )

inline

TableFunction() [3/4]

kuzu::function::TableFunction::TableFunction ( std::string name, table_func_t tableFunc, table_func_bind_t bindFunc, table_func_init_shared_t initSharedFunc, table_func_init_local_t initLocalFunc, std::vector< common::LogicalTypeID > inputTypes, std::optional< table_func_finalize_t > finalizeFunc = {} )

inline

TableFunction() [4/4]

kuzu::function::TableFunction::TableFunction ( std::string name, table_func_t tableFunc, table_func_bind_t bindFunc, table_func_init_shared_t initSharedFunc, table_func_init_local_t initLocalFunc, table_func_progress_t progressFunc, std::vector< common::LogicalTypeID > inputTypes, std::optional< table_func_finalize_t > finalizeFunc = {} )

inline

Member Function Documentation

copy()

virtual std::unique_ptr< TableFunction > kuzu::function::TableFunction::copy ( ) const

inlinevirtual

signatureToString()

std::string kuzu::function::TableFunction::signatureToString ( ) const

inlineoverridevirtual

Reimplemented from kuzu::function::Function.

Member Data Documentation

bindFunc

table_func_bind_t kuzu::function::TableFunction::bindFunc = nullptr

canParallelFunc

table_func_can_parallel_t kuzu::function::TableFunction::canParallelFunc = [] { return true; }

finalizeFunc

table_func_finalize_t kuzu::function::TableFunction::finalizeFunc = [](auto, auto, auto) {}

initLocalStateFunc

table_func_init_local_t kuzu::function::TableFunction::initLocalStateFunc = nullptr

initSharedStateFunc

table_func_init_shared_t kuzu::function::TableFunction::initSharedStateFunc = nullptr

progressFunc

table_func_progress_t kuzu::function::TableFunction::progressFunc = [](TableFuncSharedState*) { return 0.0; }

rewriteFunc

table_func_rewrite_t kuzu::function::TableFunction::rewriteFunc

tableFunc

table_func_t kuzu::function::TableFunction::tableFunc = nullptr

---

The documentation for this struct was generated from the following file:

• headers/table_functions.h