Inheritance diagram for duckdb::MaterializedQueryResult:

[legend]

Collaboration diagram for duckdb::MaterializedQueryResult:

[legend]

Public Member Functions
DUCKDB_API	MaterializedQueryResult (StatementType statement_type, StatementProperties properties, vector< string > names, unique_ptr< ColumnDataCollection > collection, ClientProperties client_properties)
	Creates a successful query result with the specified names and types.

DUCKDB_API	MaterializedQueryResult (ErrorData error)
	Creates an unsuccessful query result with error condition.

DUCKDB_API string	ToString () override
	Converts the QueryResult to a string.

DUCKDB_API string	ToBox (ClientContext &context, const BoxRendererConfig &config) override
	Converts the QueryResult to a box-rendered string.

DUCKDB_API Value	GetValue (idx_t column, idx_t index)

template<class T >
T	GetValue (idx_t column, idx_t index)

DUCKDB_API idx_t	RowCount () const

ColumnDataCollection &	Collection ()
	Returns a reference to the underlying column data collection.

unique_ptr< ColumnDataCollection >	TakeCollection ()
	Takes ownership of the collection, 'collection' is null after this operation.

Public Member Functions inherited from duckdb::QueryResult
DUCKDB_API	QueryResult (QueryResultType type, StatementType statement_type, StatementProperties properties, vector< LogicalType > types, vector< string > names, ClientProperties client_properties)
	Creates a successful query result with the specified names and types.

DUCKDB_API	QueryResult (QueryResultType type, ErrorData error)
	Creates an unsuccessful query result with error condition.

template<class TARGET >
TARGET &	Cast ()

template<class TARGET >
const TARGET &	Cast () const

DUCKDB_API const string &	ColumnName (idx_t index) const
	Returns the name of the column for the given index.

DUCKDB_API unique_ptr< DataChunk >	Fetch ()

DUCKDB_API unique_ptr< DataChunk >	FetchRaw ()

DUCKDB_API void	Print ()
	Prints the QueryResult to the console.

DUCKDB_API bool	Equals (QueryResult &other)

bool	TryFetch (unique_ptr< DataChunk > &result, ErrorData &error)

iterator	begin ()

iterator	end ()

Public Member Functions inherited from duckdb::BaseQueryResult
DUCKDB_API	BaseQueryResult (QueryResultType type, StatementType statement_type, StatementProperties properties, vector< LogicalType > types, vector< string > names)
	Creates a successful query result with the specified names and types.

DUCKDB_API	BaseQueryResult (QueryResultType type, ErrorData error)
	Creates an unsuccessful query result with error condition.

DUCKDB_API void	ThrowError (const string &prepended_message="") const

DUCKDB_API void	SetError (ErrorData error)

DUCKDB_API bool	HasError () const

DUCKDB_API const ExceptionType &	GetErrorType () const

DUCKDB_API const std::string &	GetError () const

DUCKDB_API ErrorData &	GetErrorObject ()

DUCKDB_API idx_t	ColumnCount ()

Static Public Attributes
static constexpr const QueryResultType	TYPE = QueryResultType::MATERIALIZED_RESULT

Protected Member Functions
DUCKDB_API unique_ptr< DataChunk >	FetchInternal () override

Protected Member Functions inherited from duckdb::QueryResult
DUCKDB_API string	HeaderToString ()

Private Attributes
unique_ptr< ColumnDataCollection >	collection

unique_ptr< ColumnDataRowCollection >	row_collection
	Row collection, only created if GetValue is called.

ColumnDataScanState	scan_state
	Scan state for Fetch calls.

bool	scan_initialized

Friends
class	ClientContext

Additional Inherited Members
Public Types inherited from duckdb::QueryResult
using	iterator = QueryResultIterator

Static Public Member Functions inherited from duckdb::QueryResult
static void	DeduplicateColumns (vector< string > &names)
	Deduplicate column names for interop with external libraries.

Public Attributes inherited from duckdb::QueryResult
ClientProperties	client_properties
	Properties from the client context.

unique_ptr< QueryResult >	next
	The next result (if any)

Public Attributes inherited from duckdb::BaseQueryResult
QueryResultType	type
	The type of the result (MATERIALIZED or STREAMING)

StatementType	statement_type
	The type of the statement that created this result.

StatementProperties	properties
	Properties of the statement.

vector< LogicalType >	types
	The SQL types of the result.

vector< string >	names
	The names of the result.

Protected Attributes inherited from duckdb::BaseQueryResult
bool	success
	Whether or not execution was successful.

ErrorData	error
	The error (in case execution was not successful)

Member Function Documentation

◆ ToString()

DUCKDB_API string duckdb::MaterializedQueryResult::ToString ( )

overridevirtual

Converts the QueryResult to a string.

Implements duckdb::QueryResult.

◆ ToBox()

DUCKDB_API string duckdb::MaterializedQueryResult::ToBox	(	ClientContext &	context,
		const BoxRendererConfig &	config
	)

overridevirtual

Converts the QueryResult to a box-rendered string.

Reimplemented from duckdb::QueryResult.

◆ GetValue() [1/2]

DUCKDB_API Value duckdb::MaterializedQueryResult::GetValue	(	idx_t	column,
		idx_t	index
	)

Gets the (index) value of the (column index) column. Note: this is very slow. Scanning over the underlying collection is much faster.

◆ GetValue() [2/2]

template<class T >

T duckdb::MaterializedQueryResult::GetValue	(	idx_t	column,
		idx_t	index
	)

inline

                                          {
        auto value = GetValue(column, index);
        return (T)value.GetValue<int64_t>();
    }

◆ FetchInternal()

DUCKDB_API unique_ptr< DataChunk > duckdb::MaterializedQueryResult::FetchInternal ( )

overrideprotectedvirtual

Implements duckdb::QueryResult.

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

external/duckdb/duckdb.hpp

Public Member Functions

Static Public Attributes

Protected Member Functions

Private Attributes