Kuzu C++ API
Loading...
Searching...
No Matches
kuzu::function::TableFunction Struct Referencefinal

#include <table_function.h>

Inheritance diagram for kuzu::function::TableFunction:
kuzu::function::Function

Public Member Functions

 TableFunction ()
 TableFunction (std::string name, std::vector< common::LogicalTypeID > inputTypes)
 ~TableFunction () override
 TableFunction (const TableFunction &)=default
TableFunction & operator= (const TableFunction &other)=default
 DEFAULT_BOTH_MOVE (TableFunction)
std::string signatureToString () const override
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 ()

Static Public Member Functions

static std::unique_ptr< TableFuncLocalState > initEmptyLocalState (const TableFuncInitLocalStateInput &input)
static std::unique_ptr< TableFuncSharedState > initEmptySharedState (const TableFuncInitSharedStateInput &input)
static std::unique_ptr< TableFuncOutput > initSingleDataChunkScanOutput (const TableFuncInitOutputInput &input)
static std::vector< std::string > extractYieldVariables (const std::vector< std::string > &names, const std::vector< parser::YieldVariable > &yieldVariables)
static void getLogicalPlan (planner::Planner *planner, const binder::BoundReadingClause &boundReadingClause, binder::expression_vector predicates, planner::LogicalPlan &plan)
static std::unique_ptr< processor::PhysicalOperator > getPhysicalPlan (processor::PlanMapper *planMapper, const planner::LogicalOperator *logicalOp)
static common::offset_t emptyTableFunc (const TableFuncInput &input, TableFuncOutput &output)

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_init_output_t initOutputFunc = 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) {}
table_func_rewrite_t rewriteFunc = nullptr
table_func_get_logical_plan_t getLogicalPlanFunc = getLogicalPlan
table_func_get_physical_plan_t getPhysicalPlanFunc = getPhysicalPlan
table_func_infer_input_types inferInputTypes = nullptr
Public Attributes inherited from kuzu::function::Function
std::string name
std::vector< common::LogicalTypeID > parameterTypeIDs
bool isVarLength = false
bool isListLambda = false
bool isReadOnly = true

Constructor & Destructor Documentation

◆ TableFunction() [1/3]

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

◆ TableFunction() [2/3]

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

◆ ~TableFunction()

kuzu::function::TableFunction::~TableFunction ( )
override

◆ TableFunction() [3/3]

kuzu::function::TableFunction::TableFunction ( const TableFunction & )
default

Member Function Documentation

◆ copy()

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

◆ DEFAULT_BOTH_MOVE()

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

◆ emptyTableFunc()

common::offset_t kuzu::function::TableFunction::emptyTableFunc ( const TableFuncInput & input,
TableFuncOutput & output )
static

◆ extractYieldVariables()

std::vector< std::string > kuzu::function::TableFunction::extractYieldVariables ( const std::vector< std::string > & names,
const std::vector< parser::YieldVariable > & yieldVariables )
static

◆ getLogicalPlan()

void kuzu::function::TableFunction::getLogicalPlan ( planner::Planner * planner,
const binder::BoundReadingClause & boundReadingClause,
binder::expression_vector predicates,
planner::LogicalPlan & plan )
static

◆ getPhysicalPlan()

std::unique_ptr< processor::PhysicalOperator > kuzu::function::TableFunction::getPhysicalPlan ( processor::PlanMapper * planMapper,
const planner::LogicalOperator * logicalOp )
static

◆ initEmptyLocalState()

std::unique_ptr< TableFuncLocalState > kuzu::function::TableFunction::initEmptyLocalState ( const TableFuncInitLocalStateInput & input)
static

◆ initEmptySharedState()

std::unique_ptr< TableFuncSharedState > kuzu::function::TableFunction::initEmptySharedState ( const TableFuncInitSharedStateInput & input)
static

◆ initSingleDataChunkScanOutput()

std::unique_ptr< TableFuncOutput > kuzu::function::TableFunction::initSingleDataChunkScanOutput ( const TableFuncInitOutputInput & input)
static

◆ operator=()

TableFunction & kuzu::function::TableFunction::operator= ( const TableFunction & other)
default

◆ 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) {}

◆ getLogicalPlanFunc

table_func_get_logical_plan_t kuzu::function::TableFunction::getLogicalPlanFunc = getLogicalPlan

◆ getPhysicalPlanFunc

table_func_get_physical_plan_t kuzu::function::TableFunction::getPhysicalPlanFunc = getPhysicalPlan

◆ inferInputTypes

table_func_infer_input_types kuzu::function::TableFunction::inferInputTypes = nullptr

◆ initLocalStateFunc

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

◆ initOutputFunc

table_func_init_output_t kuzu::function::TableFunction::initOutputFunc = 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 = nullptr

◆ tableFunc

table_func_t kuzu::function::TableFunction::tableFunc = nullptr
The documentation for this struct was generated from the following file: