duckdb::SQLStatement Class Reference

SQLStatement is the base class of any type of SQL statement. More...

Inheritance diagram for duckdb::SQLStatement:

Collaboration diagram for duckdb::SQLStatement:

Public Member Functions
	SQLStatement (StatementType type)
virtual string	ToString () const =0
virtual DUCKDB_API unique_ptr< SQLStatement >	Copy () const =0
	Create a copy of this SelectStatement.
template<class TARGET >
TARGET &	Cast ()
template<class TARGET >
const TARGET &	Cast () const

Public Attributes
StatementType	type
	The statement type.
idx_t	stmt_location = 0
	The statement location within the query string.
idx_t	stmt_length = 0
	The statement length within the query string.
case_insensitive_map_t< idx_t >	named_param_map
	The map of named parameter to param index.
string	query
	The query text that corresponds to this SQL statement.

Static Public Attributes
static constexpr const StatementType	TYPE = StatementType::INVALID_STATEMENT

Protected Member Functions
	SQLStatement (const SQLStatement &other)=default

Detailed Description

SQLStatement is the base class of any type of SQL statement.

Constructor & Destructor Documentation

SQLStatement()

duckdb::SQLStatement::SQLStatement ( StatementType  type )

inlineexplicit

                                              : type(type) {
    }

~SQLStatement()

virtual duckdb::SQLStatement::~SQLStatement ( )

inlinevirtual

                            {
    }

Member Function Documentation

ToString()

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

pure virtual

Implemented in duckdb::SelectStatement.

Copy()

virtual DUCKDB_API unique_ptr< SQLStatement > duckdb::SQLStatement::Copy ( ) const

pure virtual

Create a copy of this SelectStatement.

Implemented in duckdb::CreateStatement, duckdb::UpdateStatement, duckdb::InsertStatement, duckdb::ExplainStatement, duckdb::SelectStatement, and duckdb::CopyStatement.

Cast() [1/2]

template<class TARGET >

TARGET & duckdb::SQLStatement::Cast ( )

inline

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

Cast() [2/2]

template<class TARGET >

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

inline

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

---

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

• external/duckdb/duckdb.hpp