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 ()
 
 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 Init (int64_t elements) override
 Allocates initial capacity requirements for the builder. More...
 
Status Resize (int64_t capacity) override
 Resizes the null_bitmap array. 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 elements)
 Ensures there is enough space for adding the number of elements by checking capacity and calling Resize if necessary. 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< PoolBuffernull_bitmap () const
 
Status Finish (std::shared_ptr< Array > *out)
 Return result of builder as an Array object. More...
 
std::shared_ptr< DataTypetype () const
 

Protected Attributes

AdaptiveIntBuilder values_builder_
 
- Protected Attributes inherited from arrow::ArrayBuilder
std::shared_ptr< DataTypetype_
 
MemoryPoolpool_
 
std::shared_ptr< PoolBuffernull_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 Reset ()
 
void UnsafeAppendToBitmap (bool is_valid)
 
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()

◆ 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

Parameters
[out]outthe finalized ArrayData object
Returns
Status

Implements arrow::ArrayBuilder.

◆ Init()

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

Allocates initial capacity requirements for the builder.

In most cases subclasses should override and call their parent class's method as well.

Reimplemented from arrow::ArrayBuilder.

◆ Resize()

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

Resizes the null_bitmap array.

In most cases subclasses should override and call their parent class's method as well.

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: