Skip to main content

parquet_variant_json/
lib.rs

1// SPDX-License-Identifier: Apache-2.0
2// SPDX-FileCopyrightText: See the NOTICE file distributed with this work for additional information regarding copyright ownership
3// SPDX-FileContributor: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements
4
5//! Conversion between [JSON] and the [Variant Binary Encoding] from [Apache Parquet].
6//!
7//! [JSON]: https://www.json.org/json-en.html
8//! [Variant Binary Encoding]: https://github.com/apache/parquet-format/blob/master/VariantEncoding.md
9//! [Apache Parquet]: https://parquet.apache.org/
10//!
11//! * See [`JsonToVariant`] trait for converting a JSON string to a Variant.
12//! * See [`VariantToJson`] trait for converting a Variant to a JSON string.
13//!
14//! ## 🚧 Work In Progress
15//!
16//! This crate is under active development and is not yet ready for production use.
17//! If you are interested in helping, you can find more information on the GitHub [Variant issue]
18//!
19//! [Variant issue]: https://github.com/apache/arrow-rs/issues/6736
20//!
21//! # Platform Support
22//!
23//! Only little-endian platforms are officially supported and tested in CI.
24//! Big-endian platforms are not tested in CI and may not work correctly.
25//! Fixes for big-endian platforms are welcome and handled on a best-effort basis,
26//! but compatibility is not guaranteed.
27
28mod from_json;
29mod to_json;
30
31pub use from_json::{JsonToVariant, append_json};
32pub use to_json::VariantToJson;