duckdb::TableRef Class Reference

Represents a generic expression that returns a table. More...

#include <duckdb.hpp>

Inheritance diagram for duckdb::TableRef:

Collaboration diagram for duckdb::TableRef:

Public Member Functions
	TableRef (TableReferenceType type)
virtual string	ToString () const =0
	Convert the object to a string.
void	Print ()
virtual bool	Equals (const TableRef &other) const
virtual unique_ptr< TableRef >	Copy ()=0
void	CopyProperties (TableRef &target) const
	Copy the properties of this table ref to the target.
virtual void	Serialize (Serializer &serializer) const
template<class TARGET >
TARGET &	Cast ()
template<class TARGET >
const TARGET &	Cast () const

Static Public Member Functions
static bool	Equals (const unique_ptr< TableRef > &left, const unique_ptr< TableRef > &right)
static unique_ptr< TableRef >	Deserialize (Deserializer &deserializer)

Public Attributes
TableReferenceType	type
string	alias
unique_ptr< SampleOptions >	sample
	Sample options (if any)
optional_idx	query_location
	The location in the query (if any)
shared_ptr< ExternalDependency >	external_dependency
	External dependencies of this table function.
vector< string >	column_name_alias
	Aliases for the column names.

Static Public Attributes
static constexpr const TableReferenceType	TYPE = TableReferenceType::INVALID

Protected Member Functions
string	BaseToString (string result) const
string	BaseToString (string result, const vector< string > &column_name_alias) const
string	AliasToString (const vector< string > &column_name_alias) const
string	SampleToString () const

Detailed Description

Represents a generic expression that returns a table.

Constructor & Destructor Documentation

TableRef()

duckdb::TableRef::TableRef ( TableReferenceType  type )

inlineexplicit

                                               : type(type) {
    }

~TableRef()

virtual duckdb::TableRef::~TableRef ( )

inlinevirtual

                        {
    }

Member Function Documentation

ToString()

virtual string duckdb::TableRef::ToString ( ) const

pure virtual

Convert the object to a string.

Implemented in duckdb::DelimGetRef, and duckdb::ShowRef.

Serialize()

virtual void duckdb::TableRef::Serialize ( Serializer &  serializer ) const

virtual

Reimplemented in duckdb::ShowRef.

Cast() [1/2]

template<class TARGET >

TARGET & duckdb::TableRef::Cast ( )

inline

                   {
        if (type != TARGET::TYPE && TARGET::TYPE != TableReferenceType::INVALID) {
            throw InternalException("Failed to cast constraint to type - constraint type mismatch");
        }
        return reinterpret_cast<TARGET &>(*this);
    }

Cast() [2/2]

template<class TARGET >

const TARGET & duckdb::TableRef::Cast ( ) const

inline

                               {
        if (type != TARGET::TYPE && TARGET::TYPE != TableReferenceType::INVALID) {
            throw InternalException("Failed to cast constraint to type - constraint type mismatch");
        }
        return reinterpret_cast<const TARGET &>(*this);
    }

---

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

• external/duckdb/duckdb.hpp