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

Write the JSON representation of an Arrow record batch file or stream. More...

#include <arrow/ipc/json.h>

Public Member Functions

 ~JsonWriter ()
 
Status WriteRecordBatch (const RecordBatch &batch)
 Append a record batch. More...
 
Status Finish (std::string *result)
 Finish the JSON payload and return as a std::string. More...
 

Static Public Member Functions

static Status Open (const std::shared_ptr< Schema > &schema, std::unique_ptr< JsonWriter > *out)
 Create a new JSON writer that writes to memory. More...
 

Detailed Description

Write the JSON representation of an Arrow record batch file or stream.

This is used for integration testing

Constructor & Destructor Documentation

◆ ~JsonWriter()

arrow::ipc::JsonWriter::~JsonWriter ( )

Member Function Documentation

◆ Finish()

Status arrow::ipc::JsonWriter::Finish ( std::string *  result)

Finish the JSON payload and return as a std::string.

Parameters
[out]resultthe JSON as as a std::string
Returns
Status

◆ Open()

static Status arrow::ipc::JsonWriter::Open ( const std::shared_ptr< Schema > &  schema,
std::unique_ptr< JsonWriter > *  out 
)
static

Create a new JSON writer that writes to memory.

Parameters
[in]schemathe schema of record batches
[out]outthe returned writer object
Returns
Status

◆ WriteRecordBatch()

Status arrow::ipc::JsonWriter::WriteRecordBatch ( const RecordBatch batch)

Append a record batch.


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