Inheritance diagram for duckdb::StreamQueryResult:

[legend]

Collaboration diagram for duckdb::StreamQueryResult:

[legend]

Public Member Functions
DUCKDB_API	StreamQueryResult (StatementType statement_type, StatementProperties properties, vector< LogicalType > types, vector< string > names, ClientProperties client_properties, shared_ptr< BufferedData > buffered_data)

DUCKDB_API	StreamQueryResult (ErrorData error)

DUCKDB_API void	WaitForTask ()
	Reschedules the tasks that work on producing a result chunk, returning when at least one task can be executed.

DUCKDB_API StreamExecutionResult	ExecuteTask ()
	Executes a single task within the final pipeline, returning whether or not a chunk is ready to be fetched.

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

DUCKDB_API unique_ptr< MaterializedQueryResult >	Materialize ()
	Materializes the query result and turns it into a materialized query result.

DUCKDB_API bool	IsOpen ()

DUCKDB_API void	Close ()
	Closes the StreamQueryResult.

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 ()

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

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 Member Functions
static bool	IsChunkReady (StreamExecutionResult result)

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

Public Attributes
shared_ptr< ClientContext >	context
	The client context this StreamQueryResult belongs to.

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.

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

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

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

Private Member Functions
StreamExecutionResult	ExecuteTaskInternal (ClientContextLock &lock)

unique_ptr< DataChunk >	FetchNextInternal (ClientContextLock &lock)

unique_ptr< ClientContextLock >	LockContext ()

void	CheckExecutableInternal (ClientContextLock &lock)

bool	IsOpenInternal (ClientContextLock &lock)

Private Attributes
shared_ptr< BufferedData >	buffered_data

Friends
class	ClientContext

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

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

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

Constructor & Destructor Documentation

◆ StreamQueryResult()

DUCKDB_API duckdb::StreamQueryResult::StreamQueryResult	(	StatementType	statement_type,
		StatementProperties	properties,
		vector< LogicalType >	types,
		vector< string >	names,
		ClientProperties	client_properties,
		shared_ptr< BufferedData >	buffered_data
	)

Create a successful StreamQueryResult. StreamQueryResults should always be successful initially (it makes no sense to stream an error).

Member Function Documentation

◆ ToString()

DUCKDB_API string duckdb::StreamQueryResult::ToString ( )

overridevirtual

Converts the QueryResult to a string.

Implements duckdb::QueryResult.

◆ FetchInternal()

DUCKDB_API unique_ptr< DataChunk > duckdb::StreamQueryResult::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 Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Constructor & Destructor Documentation

◆ StreamQueryResult()

Member Function Documentation

◆ ToString()

◆ FetchInternal()