duckdb::TableScanBindData Struct Reference

Inheritance diagram for duckdb::TableScanBindData:

Collaboration diagram for duckdb::TableScanBindData:

Public Member Functions
	TableScanBindData (TableCatalogEntry &table)
bool	Equals (const FunctionData &other_p) const override
unique_ptr< FunctionData >	Copy () const override
Public Member Functions inherited from duckdb::FunctionData
virtual DUCKDB_API bool	SupportStatementCache () const
template<class TARGET >
TARGET &	Cast ()
template<class TARGET >
const TARGET &	Cast () const
template<class TARGET >
TARGET &	CastNoConst () const

Public Attributes
TableCatalogEntry &	table
	The table to scan.
bool	is_index_scan
bool	is_create_index
	Whether or not the table scan is for index creation.
unique_ptr< RowGroupOrderOptions >	order_options
	In what order to scan the row groups.
Public Attributes inherited from duckdb::TableFunctionData
vector< idx_t >	column_ids

Additional Inherited Members
Static Public Member Functions inherited from duckdb::FunctionData
static DUCKDB_API bool	Equals (const FunctionData *left, const FunctionData *right)

Constructor & Destructor Documentation

TableScanBindData()

duckdb::TableScanBindData::TableScanBindData ( TableCatalogEntry &  table )

inlineexplicit

                                                         : table(table), is_index_scan(false), is_create_index(false) {
    }

Member Function Documentation

Equals()

bool duckdb::TableScanBindData::Equals ( const FunctionData &  other_p ) const

inlineoverridevirtual

Reimplemented from duckdb::TableFunctionData.

                                                            {
        auto &other = other_p.Cast<TableScanBindData>();
        return &other.table == &table;
    }

Copy()

unique_ptr< FunctionData > duckdb::TableScanBindData::Copy ( ) const

inlineoverridevirtual

Reimplemented from duckdb::TableFunctionData.

                                                   {
        auto bind_data = make_uniq<TableScanBindData>(table);
        bind_data->is_index_scan = is_index_scan;
        bind_data->is_create_index = is_create_index;
        bind_data->column_ids = column_ids;
        bind_data->order_options = order_options ? make_uniq<RowGroupOrderOptions>(*order_options) : nullptr;
        return std::move(bind_data);
    }

Member Data Documentation

is_index_scan

bool duckdb::TableScanBindData::is_index_scan

The old purpose of this field has been deprecated. We now use it to express an index scan in the ANALYZE call. I.e., we const-cast the bind data and set this to true, if we opt for an index scan.

---

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

• external/duckdb/duckdb.cpp