Apache Arrow (C++)
A columnar in-memory analytics layer designed to accelerate big data.
Public Member Functions | Protected Attributes | List of all members
arrow::DictionaryBuilder< NullType > Class Template Reference

#include <arrow/builder.h>

Inheritance diagram for arrow::DictionaryBuilder< NullType >:
arrow::ArrayBuilder

Public Member Functions

 DictionaryBuilder (const std::shared_ptr< DataType > &type, MemoryPool *pool)
 
 DictionaryBuilder (MemoryPool *pool)
 
Status AppendNull ()
 Append a scalar null value. More...
 
Status AppendArray (const Array &array)
 Append a whole dense array to the builder. More...
 
Status Resize (int64_t capacity) override
 Ensure that enough memory has been allocated to fit the indicated number of total elements in the builder, including any that have already been appended. More...
 
Status FinishInternal (std::shared_ptr< ArrayData > *out) override
 Return result of builder as an internal generic ArrayData object. More...
 
- Public Member Functions inherited from arrow::ArrayBuilder
 ArrayBuilder (const std::shared_ptr< DataType > &type, MemoryPool *pool)
 
virtual ~ArrayBuilder ()=default
 
ArrayBuilderchild (int i)
 For nested types. More...
 
int num_children () const
 
int64_t length () const
 
int64_t null_count () const
 
int64_t capacity () const
 
Status AppendToBitmap (bool is_valid)
 Append to null bitmap. More...
 
Status AppendToBitmap (const uint8_t *valid_bytes, int64_t length)
 Vector append. More...
 
Status SetNotNull (int64_t length)
 Set the next length bits to not null (i.e. valid). More...
 
Status Reserve (int64_t additional_capacity)
 Ensure that there is enough space allocated to add the indicated number of elements without any further calls to Resize. More...
 
virtual void Reset ()
 Reset the builder. More...
 
Status Advance (int64_t elements)
 For cases where raw data was memcpy'd into the internal buffers, allows us to advance the length of the builder. More...
 
std::shared_ptr< ResizableBuffernull_bitmap () const
 
Status Finish (std::shared_ptr< Array > *out)
 Return result of builder as an Array object. More...
 
std::shared_ptr< DataTypetype () const
 
void UnsafeAppendToBitmap (bool is_valid)
 
template<typename IterType >
void UnsafeAppendToBitmap (const IterType &begin, const IterType &end)
 

Protected Attributes

AdaptiveIntBuilder values_builder_
 
- Protected Attributes inherited from arrow::ArrayBuilder
std::shared_ptr< DataTypetype_
 
MemoryPoolpool_
 
std::shared_ptr< ResizableBuffernull_bitmap_
 
int64_t null_count_
 
uint8_t * null_bitmap_data_
 
int64_t length_
 
int64_t capacity_
 
std::vector< std::unique_ptr< ArrayBuilder > > children_
 

Additional Inherited Members

- Protected Member Functions inherited from arrow::ArrayBuilder
 ArrayBuilder ()
 
void UnsafeAppendToBitmap (const uint8_t *valid_bytes, int64_t length)
 
void UnsafeAppendToBitmap (const std::vector< bool > &is_valid)
 
void UnsafeSetNotNull (int64_t length)
 

Constructor & Destructor Documentation

◆ DictionaryBuilder() [1/2]

arrow::DictionaryBuilder< NullType >::DictionaryBuilder ( const std::shared_ptr< DataType > &  type,
MemoryPool pool 
)

◆ DictionaryBuilder() [2/2]

Member Function Documentation

◆ AppendArray()

Status arrow::DictionaryBuilder< NullType >::AppendArray ( const Array array)

Append a whole dense array to the builder.

◆ AppendNull()

Append a scalar null value.

◆ FinishInternal()

Status arrow::DictionaryBuilder< NullType >::FinishInternal ( std::shared_ptr< ArrayData > *  out)
overridevirtual

Return result of builder as an internal generic ArrayData object.

Resets builder except for dictionary builder

Parameters
[out]outthe finalized ArrayData object
Returns
Status

Implements arrow::ArrayBuilder.

◆ Resize()

Status arrow::DictionaryBuilder< NullType >::Resize ( int64_t  capacity)
overridevirtual

Ensure that enough memory has been allocated to fit the indicated number of total elements in the builder, including any that have already been appended.

Does not account for reallocations that may be due to variable size data, like binary values. To make space for incremental appends, use Reserve instead.

Parameters
[in]capacitythe minimum number of additional array values
Returns
Status

Reimplemented from arrow::ArrayBuilder.

Member Data Documentation

◆ values_builder_

AdaptiveIntBuilder arrow::DictionaryBuilder< NullType >::values_builder_
protected

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