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

Builder class for variable-length binary data. More...

#include <arrow/builder.h>

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

Public Member Functions

 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 ()
 
void Reset () override
 Reset 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 ReserveData (int64_t elements)
 Ensures there is enough allocated capacity to append the indicated number of bytes to the value data buffer without additional allocations. 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
 
int64_t value_data_capacity () 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 additional_capacity)
 Ensure that there is enough space allocated to add the indicated number of elements without any further calls to Resize. 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 Member Functions

Status AppendNextOffset ()
 
- 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)
 

Protected Attributes

TypedBufferBuilder< int32_t > offsets_builder_
 
TypedBufferBuilder< uint8_t > value_data_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_
 

Detailed Description

Builder class for variable-length binary data.

Constructor & Destructor Documentation

◆ BinaryBuilder() [1/2]

arrow::BinaryBuilder::BinaryBuilder ( MemoryPool *pool  ARROW_MEMORY_POOL_DEFAULT)
explicit

◆ BinaryBuilder() [2/2]

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

Member Function Documentation

◆ Append() [1/3]

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

◆ Append() [2/3]

Status arrow::BinaryBuilder::Append ( const char *  value,
int32_t  length 
)
inline

◆ Append() [3/3]

Status arrow::BinaryBuilder::Append ( const std::string &  value)
inline

◆ AppendNextOffset()

Status arrow::BinaryBuilder::AppendNextOffset ( )
protected

◆ AppendNull()

Status arrow::BinaryBuilder::AppendNull ( )

◆ FinishInternal()

Status arrow::BinaryBuilder::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.

◆ GetValue()

const uint8_t* arrow::BinaryBuilder::GetValue ( int64_t  i,
int32_t *  out_length 
) const

Temporary access to a value.

This pointer becomes invalid on the next modifying operation.

◆ ReserveData()

Status arrow::BinaryBuilder::ReserveData ( int64_t  elements)

Ensures there is enough allocated capacity to append the indicated number of bytes to the value data buffer without additional allocations.

◆ Reset()

void arrow::BinaryBuilder::Reset ( )
overridevirtual

Reset the builder.

Reimplemented from arrow::ArrayBuilder.

◆ Resize()

Status arrow::BinaryBuilder::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.

◆ value_data_capacity()

int64_t arrow::BinaryBuilder::value_data_capacity ( ) const
inline
Returns
capacity of values buffer

◆ value_data_length()

int64_t arrow::BinaryBuilder::value_data_length ( ) const
inline
Returns
size of values buffer so far

Member Data Documentation

◆ offsets_builder_

TypedBufferBuilder<int32_t> arrow::BinaryBuilder::offsets_builder_
protected

◆ value_data_builder_

TypedBufferBuilder<uint8_t> arrow::BinaryBuilder::value_data_builder_
protected

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