duckdb::ArrowBatchTask Class Reference

Inheritance diagram for duckdb::ArrowBatchTask:

Collaboration diagram for duckdb::ArrowBatchTask:

Public Member Functions
	ArrowBatchTask (ArrowQueryResult &result, vector< idx_t > record_batch_indices, Executor &executor, shared_ptr< Event > event_p, BatchCollectionChunkScanState scan_state, vector< string > names, idx_t batch_size)
void	ProduceRecordBatches ()
TaskExecutionResult	ExecuteTask (TaskExecutionMode mode) override
string	TaskType () const override
Public Member Functions inherited from duckdb::ExecutorTask
	ExecutorTask (Executor &executor, shared_ptr< Event > event)
	ExecutorTask (ClientContext &context, shared_ptr< Event > event, const PhysicalOperator &op)
void	Deschedule () override
void	Reschedule () override
	Ensures a task is rescheduled to the correct queue.
TaskExecutionResult	Execute (TaskExecutionMode mode) override
Public Member Functions inherited from duckdb::Task
virtual bool	TaskBlockedOnResult () const
Public Member Functions inherited from duckdb::enable_shared_from_this< Task >
shared_ptr< Task >	shared_from_this ()
shared_ptr< Task const >	shared_from_this () const

Private Attributes
ArrowQueryResult &	result
vector< idx_t >	record_batch_indices
shared_ptr< Event >	event
idx_t	batch_size
vector< string >	names
BatchCollectionChunkScanState	scan_state

Additional Inherited Members
Public Attributes inherited from duckdb::ExecutorTask
Executor &	executor
shared_ptr< Event >	event
unique_ptr< ThreadContext >	thread_context
optional_ptr< const PhysicalOperator >	op
Public Attributes inherited from duckdb::Task
optional_ptr< ProducerToken >	token
Protected Member Functions inherited from duckdb::enable_shared_from_this< Task >
	enable_shared_from_this (enable_shared_from_this const &) noexcept
enable_shared_from_this &	operator= (enable_shared_from_this const &) noexcept

Constructor & Destructor Documentation

ArrowBatchTask()

duckdb::ArrowBatchTask::ArrowBatchTask	(	ArrowQueryResult &	result,
		vector< idx_t >	record_batch_indices,
		Executor &	executor,
		shared_ptr< Event >	event_p,
		BatchCollectionChunkScanState	scan_state,
		vector< string >	names,
		idx_t	batch_size
	)

    : ExecutorTask(executor, event_p), result(result), record_batch_indices(std::move(record_batch_indices)),
      event(std::move(event_p)), batch_size(batch_size), names(std::move(names)), scan_state(std::move(scan_state)) {
}

Member Function Documentation

ProduceRecordBatches()

void duckdb::ArrowBatchTask::ProduceRecordBatches

(

)

                                          {
    auto &arrays = result.Arrays();
    auto arrow_options = executor.context.GetClientProperties();
    for (auto &index : record_batch_indices) {
        auto &array = arrays[index];
        D_ASSERT(array);
        const idx_t count = ArrowUtil::FetchChunk(
            scan_state, arrow_options, batch_size, &array->arrow_array,
            ArrowTypeExtensionData::GetExtensionTypes(event->GetClientContext(), scan_state.Types()));
        (void)count;
        D_ASSERT(count != 0);
    }
}

ExecuteTask()

TaskExecutionResult duckdb::ArrowBatchTask::ExecuteTask ( TaskExecutionMode  mode )

overridevirtual

Implements duckdb::ExecutorTask.

                                                                      {
    ProduceRecordBatches();
    event->FinishTask();
    return TaskExecutionResult::TASK_FINISHED;
}

TaskType()

string duckdb::ArrowBatchTask::TaskType ( ) const

inlineoverridevirtual

Reimplemented from duckdb::Task.

                                     {
        return "ArrowBatchTask";
    }

---

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

• external/duckdb/duckdb.cpp