duckdb::BufferedData Class Reference

Inheritance diagram for duckdb::BufferedData:

Collaboration diagram for duckdb::BufferedData:

Public Member Functions
	BufferedData (Type type, ClientContext &context)
StreamExecutionResult	ReplenishBuffer (StreamQueryResult &result, ClientContextLock &context_lock)
virtual StreamExecutionResult	ExecuteTaskInternal (StreamQueryResult &result, ClientContextLock &context_lock)=0
virtual unique_ptr< DataChunk >	Scan ()=0
virtual void	UnblockSinks ()=0
shared_ptr< ClientContext >	GetContext ()
bool	Closed () const
void	Close ()
template<class TARGET >
TARGET &	Cast ()
template<class TARGET >
const TARGET &	Cast () const

Protected Types
enum class	Type { SIMPLE , BATCHED }

Protected Attributes
Type	type
weak_ptr< ClientContext >	context
	This is weak to avoid a cyclical reference.
idx_t	total_buffer_size
	The maximum amount of memory we should keep buffered.
mutex	glock
	Protect against populate/fetch race condition.

Member Enumeration Documentation

Type

enum class duckdb::BufferedData::Type

strongprotected

{ SIMPLE, BATCHED };

Member Function Documentation

GetContext()

shared_ptr< ClientContext > duckdb::BufferedData::GetContext ( )

inline

                                           {
        return context.lock();
    }

Closed()

bool duckdb::BufferedData::Closed ( ) const

inline

                        {
        if (context.expired()) {
            return true;
        }
        auto c = context.lock();
        return c == nullptr;
    }

Close()

void duckdb::BufferedData::Close ( )

inline

                 {
        context.reset();
    }

Cast() [1/2]

template<class TARGET >

TARGET & duckdb::BufferedData::Cast ( )

inline

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

Cast() [2/2]

template<class TARGET >

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

inline

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

---

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

• external/duckdb/duckdb.hpp