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

Builder class for UTF8 strings. More...

#include <arrow/builder.h>

Inheritance diagram for arrow::StringBuilder:
arrow::BinaryBuilder arrow::ArrayBuilder

Public Member Functions

 StringBuilder (MemoryPool *pool ARROW_MEMORY_POOL_DEFAULT)
Status Append (const std::vector< std::string > &values, uint8_t *null_bytes)
- Public Member Functions inherited from arrow::BinaryBuilder
 BinaryBuilder (MemoryPool *pool ARROW_MEMORY_POOL_DEFAULT)
 BinaryBuilder (const std::shared_ptr< DataType > &type, MemoryPool *pool)
Status Append (const uint8_t *value, int32_t length)
Status Append (const char *value, int32_t length)
Status Append (const std::string &value)
Status AppendNull ()
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...
int64_t value_data_length () const
const uint8_t * GetValue (int64_t i, int32_t *out_length) const
 Temporary access to a value. 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

- Protected Member Functions inherited from arrow::BinaryBuilder
Status AppendNextOffset ()
void Reset ()
- 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::BinaryBuilder
TypedBufferBuilder< int32_t > offsets_builder_
TypedBufferBuilder< uint8_t > value_data_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_
- Static Protected Attributes inherited from arrow::BinaryBuilder
static constexpr int64_t kMaximumCapacity = std::numeric_limits<int32_t>::max() - 1

Detailed Description

Builder class for UTF8 strings.

Constructor & Destructor Documentation

◆ StringBuilder()

arrow::StringBuilder::StringBuilder ( MemoryPool *pool  ARROW_MEMORY_POOL_DEFAULT)

Member Function Documentation

◆ Append()

Status arrow::StringBuilder::Append ( const std::vector< std::string > &  values,
uint8_t *  null_bytes 

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