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

#include <arrow/builder.h>

Inheritance diagram for arrow::FixedSizeBinaryBuilder:
arrow::ArrayBuilder arrow::DecimalBuilder

Public Member Functions

 FixedSizeBinaryBuilder (const std::shared_ptr< DataType > &type, MemoryPool *pool ARROW_MEMORY_POOL_DEFAULT)
 
Status Append (const uint8_t *value)
 
template<size_t NBYTES>
Status Append (const std::array< uint8_t, NBYTES > &value)
 
Status Append (const uint8_t *data, int64_t length, const uint8_t *valid_bytes=NULLPTR)
 
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) 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
 

Protected Attributes

int32_t byte_width_
 
BufferBuilder byte_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

◆ FixedSizeBinaryBuilder()

arrow::FixedSizeBinaryBuilder::FixedSizeBinaryBuilder ( const std::shared_ptr< DataType > &  type,
MemoryPool *pool  ARROW_MEMORY_POOL_DEFAULT 
)

Member Function Documentation

◆ Append() [1/4]

Status arrow::FixedSizeBinaryBuilder::Append ( const uint8_t *  value)

◆ Append() [2/4]

template<size_t NBYTES>
Status arrow::FixedSizeBinaryBuilder::Append ( const std::array< uint8_t, NBYTES > &  value)
inline

◆ Append() [3/4]

Status arrow::FixedSizeBinaryBuilder::Append ( const uint8_t *  data,
int64_t  length,
const uint8_t *  valid_bytes = NULLPTR 
)

◆ Append() [4/4]

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

◆ AppendNull()

Status arrow::FixedSizeBinaryBuilder::AppendNull ( )

◆ FinishInternal()

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

Reimplemented in arrow::DecimalBuilder.

◆ GetValue()

const uint8_t* arrow::FixedSizeBinaryBuilder::GetValue ( int64_t  i) const

Temporary access to a value.

This pointer becomes invalid on the next modifying operation.

◆ Init()

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

◆ value_data_length()

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

Member Data Documentation

◆ byte_builder_

BufferBuilder arrow::FixedSizeBinaryBuilder::byte_builder_
protected

◆ byte_width_

int32_t arrow::FixedSizeBinaryBuilder::byte_width_
protected

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