Expand description
Partial support for the Apache Arrow JSON test data format
These utilities define structs that read the integration JSON format for integration testing purposes.
This is not a canonical format, but provides a human-readable way of verifying language implementations
This crate is only intended for integration testing the Arrow project. It is not intended for usage outside of this context.
ยงPlatform Support
Only little-endian platforms are officially supported and tested in CI. Big-endian platforms are not tested in CI and may not work correctly. Fixes for big-endian platforms are welcome and handled on a best-effort basis, but compatibility is not guaranteed.
Re-exportsยง
pub(crate) use IntervalDayTime;๐pub(crate) use IntervalMonthDayNano;๐pub(crate) use ScalarBuffer;๐pub(crate) use hex::decode;๐pub(crate) use num_bigint::BigInt;๐pub(crate) use num_traits::Signed;๐pub(crate) use Deserialize;๐pub(crate) use Deserialize;๐pub(crate) use Serialize;๐pub(crate) use Serialize;๐pub(crate) use Map as SJMap;๐pub(crate) use Value;๐pub(crate) use std::collections::HashMap;๐pub(crate) use std::sync::Arc;๐pub(crate) use Buffer;๐pub(crate) use MutableBuffer;๐pub(crate) use ArrowError;๐pub(crate) use Result;๐pub(crate) use arrow::util::bit_util;๐pub(crate) use arrow::array::*;๐pub(crate) use arrow::datatypes::*;๐
Modulesยง
Structsยง
- Arrow
Json - A struct that represents an Arrow file with a schema and record batches
- Arrow
Json Batch - A struct that partially reads the Arrow JSON record batch
- Arrow
Json Column - A struct that partially reads the Arrow JSON column/array
- Arrow
Json Dictionary Batch - A struct that partially reads the Arrow JSON dictionary batch
- Arrow
Json Field - Fields are left as JSON
Valueas they vary byDataType - Arrow
Json Field Dictionary - Represents a dictionary-encoded field in the Arrow JSON format
- Arrow
Json Schema - A struct that partially reads the Arrow JSON schema.
- Dictionary
Index Type - Type of an index for a dictionary-encoded field in the Arrow JSON format
- Metadata
KeyValue
Functionsยง
- array_
from_ json - Construct an Arrow array from a partially typed JSON column
- create_
null_ ๐buf - A helper to create a null buffer from a
Vec<bool> - data_
type_ from_ json - Parse a data type from a JSON representation.
- data_
type_ to_ json - Generate a JSON representation of the data type.
- dictionary_
array_ from_ json - Construct a [
DictionaryArray] from a partially typed JSON column - field_
from_ json - Parse a
Fielddefinition from a JSON representation. - field_
to_ json - Generate a JSON representation of the
Field. - from_
metadata - Parse a
metadatadefinition from a JSON representation. The JSON can either be an Object or an Array of Objects. - json_
int - Read a JSON number as an integer of type
T. - record_
batch_ from_ json - Generates a [
RecordBatch] from an Arrow JSON batch, given a schema - schema_
from_ json - Parse a
Schemadefinition from a JSON representation. - schema_
to_ json - Generate a JSON representation of the
Schema.