Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions parquet-variant-compute/src/variant_array_builder.rs
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,14 @@ use std::sync::Arc;
/// This builder always creates a `VariantArray` using [`BinaryViewArray`] for both
/// the metadata and value fields.
///
/// `VariantArrayBuilder` implements [`VariantBuilderExt`], so you append values
/// and nested objects or lists the same way as when building a single
/// [`Variant`] value with [`VariantBuilder`], rather than constructing a
/// `VariantBuilder` per row.
///
/// [`VariantBuilder`]: parquet_variant::VariantBuilder
/// [`VariantBuilderExt`]: parquet_variant::VariantBuilderExt
///
/// # TODO
/// 1. Support shredding: <https://github.com/apache/arrow-rs/issues/7895>
///
Expand Down
7 changes: 7 additions & 0 deletions parquet-variant/src/builder.rs
Original file line number Diff line number Diff line change
Expand Up @@ -477,6 +477,13 @@ impl<S: BuilderSpecificState> Drop for ParentState<'_, S> {

/// Top level builder for [`Variant`] values
///
/// `VariantBuilder` builds a single, self-contained [`Variant`] value -- useful
/// for one-off values and unit tests. To build an array (column) of variants,
/// one per input row, use [`VariantArrayBuilder`] from the
/// `parquet-variant-compute` crate rather than a `VariantBuilder` per row.
///
/// [`VariantArrayBuilder`]: https://docs.rs/parquet-variant-compute/latest/parquet_variant_compute/struct.VariantArrayBuilder.html
///
/// # Example: create a Primitive Int8
/// ```
/// # use parquet_variant::{Variant, VariantBuilder};
Expand Down
Loading