Inheritance diagram for duckdb::Appender:

Collaboration diagram for duckdb::Appender:

[legend]

Public Member Functions
DUCKDB_API	Appender (Connection &con, const string &database_name, const string &schema_name, const string &table_name, const idx_t flush_memory_threshold=DConstants::INVALID_INDEX)

DUCKDB_API	Appender (Connection &con, const string &schema_name, const string &table_name, const idx_t flush_memory_threshold=DConstants::INVALID_INDEX)

DUCKDB_API	Appender (Connection &con, const string &table_name, const idx_t flush_memory_threshold=DConstants::INVALID_INDEX)

void	AppendDefault () override

void	AppendDefault (DataChunk &chunk, idx_t col, idx_t row) override

void	AddColumn (const string &name) override

void	ClearColumns () override

vector< string >	GetExpectedNames ()
	Get the expected names based on the active columns.

Public Member Functions inherited from duckdb::BaseAppender
DUCKDB_API void	BeginRow ()

DUCKDB_API void	EndRow ()
	Finishes appending the current row.

template<class T >
void	Append (T value)=delete

DUCKDB_API void	Append (DataChunk &target, const Value &value, idx_t col, idx_t row)

DUCKDB_API void	Append (const char *value, uint32_t length)

template<typename... ARGS>
void	AppendRow (ARGS... args)

DUCKDB_API void	Flush ()
	Commit the changes made by the appender.

DUCKDB_API void	Close ()
	Flush the changes made by the appender and close it. The appender cannot be used after this point.

DUCKDB_API void	Clear ()
	Clears any appended data (without flushing).

const vector< LogicalType > &	GetActiveTypes () const
	Returns the active types of the appender.

idx_t	CurrentColumn () const

DUCKDB_API void	AppendDataChunk (DataChunk &value)

template<>
DUCKDB_API void	Append (bool value)

template<>
DUCKDB_API void	Append (int8_t value)

template<>
DUCKDB_API void	Append (int16_t value)

template<>
DUCKDB_API void	Append (int32_t value)

template<>
DUCKDB_API void	Append (int64_t value)

template<>
DUCKDB_API void	Append (hugeint_t value)

template<>
DUCKDB_API void	Append (uhugeint_t value)

template<>
DUCKDB_API void	Append (uint8_t value)

template<>
DUCKDB_API void	Append (uint16_t value)

template<>
DUCKDB_API void	Append (uint32_t value)

template<>
DUCKDB_API void	Append (uint64_t value)

template<>
DUCKDB_API void	Append (float value)

template<>
DUCKDB_API void	Append (double value)

template<>
DUCKDB_API void	Append (date_t value)

template<>
DUCKDB_API void	Append (dtime_t value)

template<>
DUCKDB_API void	Append (timestamp_t value)

template<>
DUCKDB_API void	Append (interval_t value)

template<>
DUCKDB_API void	Append (const char *value)

template<>
DUCKDB_API void	Append (string_t value)

template<>
DUCKDB_API void	Append (Value value)

template<>
DUCKDB_API void	Append (std::nullptr_t value)

Static Public Member Functions
static string	ConstructQuery (TableDescription &description_p, const string &table_name, const vector< string > &expected_names)
	Construct a query that appends data from, typically, a column data collection.

Static Public Member Functions inherited from duckdb::BaseAppender
static unique_ptr< TableRef >	GetColumnDataTableRef (ColumnDataCollection &collection, const string &table_name, const vector< string > &expected_names)
	Returns a table reference to the appended data.

static unique_ptr< SQLStatement >	ParseStatement (unique_ptr< TableRef > table_ref, const string &query, const string &table_name)
	Parses the statement to append data.

Protected Member Functions
void	FlushInternal (ColumnDataCollection &collection) override

Value	GetDefaultValue (idx_t column)

Protected Member Functions inherited from duckdb::BaseAppender
DUCKDB_API	BaseAppender (Allocator &allocator, const AppenderType type)

DUCKDB_API	BaseAppender (Allocator &allocator, vector< LogicalType > types, const AppenderType type, const idx_t flush_count=DEFAULT_FLUSH_COUNT)

void	Destructor ()

void	InitializeChunk ()

void	FlushChunk ()

bool	ShouldFlushChunk () const

bool	ShouldFlush () const

template<class T >
void	AppendValueInternal (T value)

template<class SRC , class DST >
void	AppendValueInternal (Vector &vector, SRC input)

template<class SRC , class DST >
void	AppendDecimalValueInternal (Vector &vector, SRC input)

void	AppendRowRecursive ()

template<typename T , typename... ARGS>
void	AppendRowRecursive (T value, ARGS... args)

void	AppendValue (const Value &value)

void	AppendValue (DataChunk target, const Value &value)

Private Attributes
weak_ptr< ClientContext >	context
	A shared pointer to the context of this appender.

unique_ptr< TableDescription >	description
	The table description including the column names.

unordered_map< column_t, Value >	default_values
	All table default values.

vector< LogicalIndex >	column_ids

Additional Inherited Members
Static Public Attributes inherited from duckdb::BaseAppender
static constexpr const idx_t	DEFAULT_FLUSH_COUNT = STANDARD_VECTOR_SIZE * 100ULL
	The amount of tuples that are gathered in the column data collection before flushing.

Protected Attributes inherited from duckdb::BaseAppender
Allocator &	allocator
	The allocator for the column data collection.

vector< LogicalType >	types
	The column types of the associated table.

vector< LogicalType >	active_types
	The active column types.

unique_ptr< ColumnDataCollection >	collection
	The buffered to-be-appended data.

DataChunk	chunk
	The active chunk for row-based appends.

idx_t	column = 0
	The currently active column of row-based appends.

AppenderType	appender_type
	The type of the appender.

idx_t	flush_count = DEFAULT_FLUSH_COUNT
	The amount of rows after which the appender flushes automatically.

optional_idx	flush_memory_threshold
	Peak allocation threshold at which to flush the allocator when appender flushs chunk.

Member Function Documentation

◆ AppendDefault() [1/2]

void duckdb::Appender::AppendDefault ( )

overridevirtual

Reimplemented from duckdb::BaseAppender.

◆ AppendDefault() [2/2]

void duckdb::Appender::AppendDefault	(	DataChunk &	chunk,
		idx_t	col,
		idx_t	row
	)

overridevirtual

Reimplemented from duckdb::BaseAppender.

◆ AddColumn()

void duckdb::Appender::AddColumn ( const string & name )

overridevirtual

Appends a column to the active column list. Immediately flushes all previous data.

Reimplemented from duckdb::BaseAppender.

◆ ClearColumns()

void duckdb::Appender::ClearColumns ( )

overridevirtual

Removes all columns from the active column list. Immediately flushes all previous data.

Reimplemented from duckdb::BaseAppender.

◆ FlushInternal()

void duckdb::Appender::FlushInternal ( ColumnDataCollection & collection )

overrideprotectedvirtual

Implements duckdb::BaseAppender.

Member Data Documentation

◆ column_ids

vector<LogicalIndex> duckdb::Appender::column_ids

private

If not empty, then this holds all logical column IDs of columns provided by the appender. Any other columns default to NULL, or their default values.

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

external/duckdb/duckdb.hpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Member Function Documentation

◆ AppendDefault() [1/2]

◆ AppendDefault() [2/2]

◆ AddColumn()

◆ ClearColumns()

◆ FlushInternal()

Member Data Documentation

◆ column_ids