Autonomy Software C++ 24.5.1
Welcome to the Autonomy Software repository of the Mars Rover Design Team (MRDT) at Missouri University of Science and Technology (Missouri S&T)! API reference contains the source code and other resources for the development of the autonomy software for our Mars rover. The Autonomy Software project aims to compete in the University Rover Challenge (URC) by demonstrating advanced autonomous capabilities and robust navigation algorithms.
Loading...
Searching...
No Matches
duckdb::PendingQueryResult Class Reference
Inheritance diagram for duckdb::PendingQueryResult:
Collaboration diagram for duckdb::PendingQueryResult:

Public Member Functions

DUCKDB_API PendingQueryResult (shared_ptr< ClientContext > context, PreparedStatementData &statement, vector< LogicalType > types, bool allow_stream_result)
 
DUCKDB_API PendingQueryResult (ErrorData error_message)
 
DUCKDB_API bool AllowStreamResult () const
 
 PendingQueryResult (const PendingQueryResult &)=delete
 
PendingQueryResultoperator= (const PendingQueryResult &)=delete
 
DUCKDB_API PendingExecutionResult ExecuteTask ()
 
DUCKDB_API PendingExecutionResult CheckPulse ()
 
void WaitForTask ()
 Halt execution of the thread until a Task is ready to be executed (use with caution)
 
DUCKDB_API unique_ptr< QueryResultExecute ()
 
DUCKDB_API void Close ()
 
- 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 ErrorDataGetErrorObject ()
 
DUCKDB_API idx_t ColumnCount ()
 

Static Public Member Functions

static DUCKDB_API bool IsResultReady (PendingExecutionResult result)
 Function to determine whether execution is considered finished.
 
static DUCKDB_API bool IsExecutionFinished (PendingExecutionResult result)
 

Static Public Attributes

static constexpr const QueryResultType TYPE = QueryResultType::PENDING_RESULT
 

Private Member Functions

void CheckExecutableInternal (ClientContextLock &lock)
 
PendingExecutionResult ExecuteTaskInternal (ClientContextLock &lock)
 
unique_ptr< QueryResultExecuteInternal (ClientContextLock &lock)
 
unique_ptr< ClientContextLockLockContext ()
 

Private Attributes

shared_ptr< ClientContextcontext
 
bool allow_stream_result
 

Friends

class ClientContext
 

Additional Inherited Members

- 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< LogicalTypetypes
 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

◆ ExecuteTask()

DUCKDB_API PendingExecutionResult duckdb::PendingQueryResult::ExecuteTask ( )

Executes a single task within the query, returning whether or not the query is ready. If this returns RESULT_READY, the Execute function can be called to obtain a pointer to the result. If this returns RESULT_NOT_READY, the ExecuteTask function should be called again. If this returns EXECUTION_ERROR, an error occurred during execution. If this returns NO_TASKS_AVAILABLE, this means currently no meaningful work can be done by the current executor, but tasks may become available in the future. The error message can be obtained by calling GetError() on the PendingQueryResult.

◆ Execute()

DUCKDB_API unique_ptr< QueryResult > duckdb::PendingQueryResult::Execute ( )

Returns the result of the query as an actual query result. This returns (mostly) instantly if ExecuteTask has been called until RESULT_READY was returned.


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