duckdb::BindInfo Struct Reference

Collaboration diagram for duckdb::BindInfo:

Public Member Functions
	BindInfo (ScanType type_p)
	BindInfo (TableCatalogEntry &table)
void	InsertOption (const string &name, Value value)
template<class T >
T	GetOption (const string &name)
template<class T >
vector< T >	GetOptionList (const string &name)

Public Attributes
unordered_map< string, Value >	options
ScanType	type
optional_ptr< TableCatalogEntry >	table

Constructor & Destructor Documentation

BindInfo() [1/2]

duckdb::BindInfo::BindInfo ( ScanType  type_p )

inlineexplicit

: type(type_p) {};

BindInfo() [2/2]

duckdb::BindInfo::BindInfo ( TableCatalogEntry &  table )

inlineexplicit

: type(ScanType::TABLE), table(&table) {};

Member Function Documentation

InsertOption()

void duckdb::BindInfo::InsertOption ( const string &  name, Value  value  )

inline

                                                       { // NOLINT: work-around bug in clang-tidy
        if (options.find(name) != options.end()) {
            throw InternalException("This option already exists");
        }
        options.emplace(name, std::move(value));
    }

GetOption()

template<class T >

T duckdb::BindInfo::GetOption ( const string &  name )

inline

                                    {
        if (options.find(name) == options.end()) {
            throw InternalException("This option does not exist");
        }
        return options[name].GetValue<T>();
    }

GetOptionList()

template<class T >

vector< T > duckdb::BindInfo::GetOptionList ( const string &  name )

inline

                                                {
        if (options.find(name) == options.end()) {
            throw InternalException("This option does not exist");
        }
        auto option = options[name];
        if (option.type().id() != LogicalTypeId::LIST) {
            throw InternalException("This option is not a list");
        }
        vector<T> result;
        auto list_children = ListValue::GetChildren(option);
        for (auto &child : list_children) {
            result.emplace_back(child.GetValue<T>());
        }
        return result;
    }

---

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

• external/duckdb/duckdb.hpp