Package org.apache.arrow.vector.ipc

Class JsonFileWriter

java.lang.Object

org.apache.arrow.vector.ipc.JsonFileWriter

All Implemented Interfaces:

AutoCloseable

public class JsonFileWriter
extends Object
implements AutoCloseable

A writer that converts binary Vectors into an internal, unstable JSON format suitable for integration testing.

This writer does NOT implement a JSON dataset format like JSONL.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	JsonFileWriter.JSONWriteConfig	Configuration POJO for writing JSON files.

Constructor Summary

Constructors

Constructor	Description
JsonFileWriter(File outputFile)	Constructs a new writer that will output to outputFile.
JsonFileWriter(File outputFile, JsonFileWriter.JSONWriteConfig config)	Constructs a new writer that will output to outputFile with the given options.

Method Summary

Modifier and Type	Method	Description
void	close()
static JsonFileWriter.JSONWriteConfig	config()
void	start(Schema schema, DictionaryProvider provider)	Writes out the "header" of the file including the schema and any dictionaries required.
void	write(VectorSchemaRoot recordBatch)	Writes the record batch to the JSON file.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

JsonFileWriter

public JsonFileWriter(File outputFile)
               throws IOException

Constructs a new writer that will output to outputFile.

Throws:

IOException

JsonFileWriter

public JsonFileWriter(File outputFile,
 JsonFileWriter.JSONWriteConfig config)
               throws IOException

Constructs a new writer that will output to outputFile with the given options.

Throws:

IOException

Method Details

config

public static JsonFileWriter.JSONWriteConfig config()

start

public void start(Schema schema,
 DictionaryProvider provider)
           throws IOException

Writes out the "header" of the file including the schema and any dictionaries required.

Throws:

IOException

write

public void write(VectorSchemaRoot recordBatch)
           throws IOException

Writes the record batch to the JSON file.

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Throws:

IOException