Apache Arrow (C++)
A columnar in-memory analytics layer designed to accelerate big data.
Public Member Functions | List of all members
arrow::StringDictionaryBuilder Class Reference

Dictionary array builder with convenience methods for strings. More...

#include <arrow/builder.h>

Inheritance diagram for arrow::StringDictionaryBuilder:
arrow::DictionaryBuilder< StringType > arrow::ArrayBuilder

Public Member Functions

Status Append (const uint8_t *value, int32_t length)
Status Append (const char *value, int32_t length)
Status Append (const std::string &value)
- Public Member Functions inherited from arrow::DictionaryBuilder< StringType >
 ~DictionaryBuilder ()
 DictionaryBuilder (const std::shared_ptr< DataType > &type, MemoryPool *pool)
 DictionaryBuilder (typename std::enable_if< TypeTraits< T1 >::is_parameter_free, MemoryPool * >::type pool)
Status Append (const Scalar &value)
 Append a scalar value. More...
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

Additional Inherited Members

- Public Types inherited from arrow::DictionaryBuilder< StringType >
using Scalar = typename internal::DictionaryScalar< StringType >::type
- 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)
- Protected Attributes inherited from arrow::DictionaryBuilder< StringType >
UniqueBuilder< StringTypeunique_builder_
AdaptiveIntBuilder values_builder_
- Protected Attributes inherited from arrow::ArrayBuilder
std::shared_ptr< DataTypetype_
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_

Detailed Description

Dictionary array builder with convenience methods for strings.

Member Function Documentation

◆ Append() [1/3]

Status arrow::StringDictionaryBuilder::Append ( const uint8_t *  value,
int32_t  length 

◆ Append() [2/3]

Status arrow::StringDictionaryBuilder::Append ( const char *  value,
int32_t  length 

◆ Append() [3/3]

Status arrow::StringDictionaryBuilder::Append ( const std::string &  value)

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