duckdb::UnionVector Struct Reference

Static Public Member Functions
static DUCKDB_API const Vector &	GetTags (const Vector &v)
	Get the tag vector of a union vector.
static DUCKDB_API Vector &	GetTags (Vector &v)
static DUCKDB_API bool	TryGetTag (const Vector &vector, idx_t index, union_tag_t &tag)
static DUCKDB_API const Vector &	GetMember (const Vector &vector, idx_t member_index)
	Get the member vector of a union vector by index.
static DUCKDB_API Vector &	GetMember (Vector &vector, idx_t member_index)
static DUCKDB_API void	SetToMember (Vector &vector, union_tag_t tag, Vector &member_vector, idx_t count, bool keep_tags_for_null)
static DUCKDB_API UnionInvalidReason	CheckUnionValidity (Vector &vector, idx_t count, const SelectionVector &sel= *FlatVector::IncrementalSelectionVector())

Member Function Documentation

TryGetTag()

static DUCKDB_API bool duckdb::UnionVector::TryGetTag ( const Vector &  vector, idx_t  index, union_tag_t &  tag  )

static

Try to get the tag at the specific flat index of the union vector. Returns false if the tag is NULL. This will handle and map the index properly for constant and dictionary vectors internally.

SetToMember()

static DUCKDB_API void duckdb::UnionVector::SetToMember ( Vector &  vector, union_tag_t  tag, Vector &  member_vector, idx_t  count, bool  keep_tags_for_null  )

static

Set every entry in the UnionVector to a specific member. This is useful to set the entire vector to a single member, e.g. when "creating" a union to return in a function, when you only have one alternative to return. if 'keep_tags_for_null' is false, the tags will be set to NULL where the member is NULL. (the validity of the tag vector will match the selected member vector) otherwise, they are all set to the 'tag'. This will also handle invalidation of the non-selected members

---

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

• external/duckdb/duckdb.hpp