Skip to content

feat: display tree with no metadata #5898

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
danking merged 4 commits into from
Feb 6, 2026
Merged

feat: display tree with no metadata #5898

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
cd8080e
feat: display tree with no metadata
danking Jan 8, 2026
e54aff3
ci: Disable debug symbols on windows tests (#6056)
AdamGS Jan 20, 2026
9140007
chore(deps): update dependency protobuf to v6.33.5 [security] (#6267)
renovate[bot] Feb 3, 2026
6dc989a
alright sickos
danking Feb 6, 2026
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
268 changes: 263 additions & 5 deletions vortex-array/src/display/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,9 @@ pub enum DisplayOptions {
/// );
/// ```
CommaSeparatedScalars { omit_comma_after_space: bool },
/// The tree of encodings and all metadata but no values.
/// The tree of encodings without any concrete values.
///
/// With buffers, metadata, and stats:
///
/// ```
/// # use vortex_array::display::DisplayOptions;
Expand All @@ -57,9 +59,210 @@ pub enum DisplayOptions {
/// metadata: EmptyMetadata
/// buffer: values host 10 B (align=2) (100.00%)
/// ";
/// assert_eq!(format!("{}", array.display_as(DisplayOptions::TreeDisplay)), expected);
/// assert_eq!(format!("{}", array.display_as(DisplayOptions::TreeDisplay { buffers: true, metadata: true, stats: true })), expected);
///
/// # use vortex_array::arrays::StructArray;
/// let array = StructArray::from_fields(&[
/// ("x", buffer![1, 2].into_array()),
/// ("y", buffer![3, 4].into_array()),
/// ]).unwrap().into_array();
/// let expected = "root: vortex.struct({x=i32, y=i32}, len=2) nbytes=16 B (100.00%)
/// metadata: EmptyMetadata
/// x: vortex.primitive(i32, len=2) nbytes=8 B (50.00%)
/// metadata: EmptyMetadata
/// buffer: values host 8 B (align=4) (100.00%)
/// y: vortex.primitive(i32, len=2) nbytes=8 B (50.00%)
/// metadata: EmptyMetadata
/// buffer: values host 8 B (align=4) (100.00%)
/// ";
/// assert_eq!(format!("{}", array.display_as(DisplayOptions::TreeDisplay { buffers: true, metadata: true, stats: true })), expected);
/// ```
///
/// With metadata and stats but no buffers:
///
/// ```
TreeDisplay,
/// # use vortex_array::display::DisplayOptions;
/// # use vortex_array::IntoArray;
/// # use vortex_buffer::buffer;
/// let array = buffer![0_i16, 1, 2, 3, 4].into_array();
/// let expected = "root: vortex.primitive(i16, len=5) nbytes=10 B (100.00%)
/// metadata: EmptyMetadata
/// ";
/// assert_eq!(format!("{}", array.display_as(DisplayOptions::TreeDisplay { buffers: false, metadata: true, stats: true })), expected);
///
/// # use vortex_array::arrays::StructArray;
/// let array = StructArray::from_fields(&[
/// ("x", buffer![1, 2].into_array()),
/// ("y", buffer![3, 4].into_array()),
/// ]).unwrap().into_array();
/// let expected = "root: vortex.struct({x=i32, y=i32}, len=2) nbytes=16 B (100.00%)
/// metadata: EmptyMetadata
/// x: vortex.primitive(i32, len=2) nbytes=8 B (50.00%)
/// metadata: EmptyMetadata
/// y: vortex.primitive(i32, len=2) nbytes=8 B (50.00%)
/// metadata: EmptyMetadata
/// ";
/// assert_eq!(format!("{}", array.display_as(DisplayOptions::TreeDisplay { buffers: false, metadata: true, stats: true })), expected);
/// ```
///
/// With metadata and buffers but no stats:
///
/// ```
/// # use vortex_array::display::DisplayOptions;
/// # use vortex_array::IntoArray;
/// # use vortex_buffer::buffer;
/// let array = buffer![0_i16, 1, 2, 3, 4].into_array();
/// let expected = "root: vortex.primitive(i16, len=5)
/// metadata: EmptyMetadata
/// buffer: values host 10 B (align=2)
/// ";
/// assert_eq!(format!("{}", array.display_as(DisplayOptions::TreeDisplay { buffers: true, metadata: true, stats: false })), expected);
///
/// # use vortex_array::arrays::StructArray;
/// let array = StructArray::from_fields(&[
/// ("x", buffer![1, 2].into_array()),
/// ("y", buffer![3, 4].into_array()),
/// ]).unwrap().into_array();
/// let expected = "root: vortex.struct({x=i32, y=i32}, len=2)
/// metadata: EmptyMetadata
/// x: vortex.primitive(i32, len=2)
/// metadata: EmptyMetadata
/// buffer: values host 8 B (align=4)
/// y: vortex.primitive(i32, len=2)
/// metadata: EmptyMetadata
/// buffer: values host 8 B (align=4)
/// ";
/// assert_eq!(format!("{}", array.display_as(DisplayOptions::TreeDisplay { buffers: true, metadata: true, stats: false })), expected);
/// ```
///
/// With buffers and stats but no metadata:
///
/// ```
/// # use vortex_array::display::DisplayOptions;
/// # use vortex_array::IntoArray;
/// # use vortex_buffer::buffer;
/// let array = buffer![0_i16, 1, 2, 3, 4].into_array();
/// let expected = "root: vortex.primitive(i16, len=5) nbytes=10 B (100.00%)
/// buffer: values host 10 B (align=2) (100.00%)
/// ";
/// assert_eq!(format!("{}", array.display_as(DisplayOptions::TreeDisplay { buffers: true, metadata: false, stats: true })), expected);
///
/// # use vortex_array::arrays::StructArray;
/// let array = StructArray::from_fields(&[
/// ("x", buffer![1, 2].into_array()),
/// ("y", buffer![3, 4].into_array()),
/// ]).unwrap().into_array();
/// let expected = "root: vortex.struct({x=i32, y=i32}, len=2) nbytes=16 B (100.00%)
/// x: vortex.primitive(i32, len=2) nbytes=8 B (50.00%)
/// buffer: values host 8 B (align=4) (100.00%)
/// y: vortex.primitive(i32, len=2) nbytes=8 B (50.00%)
/// buffer: values host 8 B (align=4) (100.00%)
/// ";
/// assert_eq!(format!("{}", array.display_as(DisplayOptions::TreeDisplay { buffers: true, metadata: false, stats: true })), expected);
/// ```
///
/// With just buffers:
///
/// ```
/// # use vortex_array::display::DisplayOptions;
/// # use vortex_array::IntoArray;
/// # use vortex_buffer::buffer;
/// let array = buffer![0_i16, 1, 2, 3, 4].into_array();
/// let expected = "root: vortex.primitive(i16, len=5)
/// buffer: values host 10 B (align=2)
/// ";
/// assert_eq!(format!("{}", array.display_as(DisplayOptions::TreeDisplay { buffers: true, metadata: false, stats: false })), expected);
///
/// # use vortex_array::arrays::StructArray;
/// let array = StructArray::from_fields(&[
/// ("x", buffer![1, 2].into_array()),
/// ("y", buffer![3, 4].into_array()),
/// ]).unwrap().into_array();
/// let expected = "root: vortex.struct({x=i32, y=i32}, len=2)
/// x: vortex.primitive(i32, len=2)
/// buffer: values host 8 B (align=4)
/// y: vortex.primitive(i32, len=2)
/// buffer: values host 8 B (align=4)
/// ";
/// assert_eq!(format!("{}", array.display_as(DisplayOptions::TreeDisplay { buffers: true, metadata: false, stats: false })), expected);
/// ```
///
/// With just metadata:
///
/// ```
/// # use vortex_array::display::DisplayOptions;
/// # use vortex_array::IntoArray;
/// # use vortex_buffer::buffer;
/// let array = buffer![0_i16, 1, 2, 3, 4].into_array();
/// let expected = "root: vortex.primitive(i16, len=5)
/// metadata: EmptyMetadata
/// ";
/// assert_eq!(format!("{}", array.display_as(DisplayOptions::TreeDisplay { buffers: false, metadata: true, stats: false })), expected);
///
/// # use vortex_array::arrays::StructArray;
/// let array = StructArray::from_fields(&[
/// ("x", buffer![1, 2].into_array()),
/// ("y", buffer![3, 4].into_array()),
/// ]).unwrap().into_array();
/// let expected = "root: vortex.struct({x=i32, y=i32}, len=2)
/// metadata: EmptyMetadata
/// x: vortex.primitive(i32, len=2)
/// metadata: EmptyMetadata
/// y: vortex.primitive(i32, len=2)
/// metadata: EmptyMetadata
/// ";
/// assert_eq!(format!("{}", array.display_as(DisplayOptions::TreeDisplay { buffers: false, metadata: true, stats: false })), expected);
/// ```
///
/// With just stats:
///
/// ```
/// # use vortex_array::display::DisplayOptions;
/// # use vortex_array::IntoArray;
/// # use vortex_buffer::buffer;
/// let array = buffer![0_i16, 1, 2, 3, 4].into_array();
/// let expected = "root: vortex.primitive(i16, len=5) nbytes=10 B (100.00%)
/// ";
/// assert_eq!(format!("{}", array.display_as(DisplayOptions::TreeDisplay { buffers: false, metadata: false, stats: true })), expected);
///
/// # use vortex_array::arrays::StructArray;
/// let array = StructArray::from_fields(&[
/// ("x", buffer![1, 2].into_array()),
/// ("y", buffer![3, 4].into_array()),
/// ]).unwrap().into_array();
/// let expected = "root: vortex.struct({x=i32, y=i32}, len=2) nbytes=16 B (100.00%)
/// x: vortex.primitive(i32, len=2) nbytes=8 B (50.00%)
/// y: vortex.primitive(i32, len=2) nbytes=8 B (50.00%)
/// ";
/// assert_eq!(format!("{}", array.display_as(DisplayOptions::TreeDisplay { buffers: false, metadata: false, stats: true })), expected);
/// ```
///
/// With neither buffers, metadata, stats, nor values:
///
/// ```
/// # use vortex_array::display::DisplayOptions;
/// # use vortex_array::IntoArray;
/// # use vortex_buffer::buffer;
/// let array = buffer![0_i16, 1, 2, 3, 4].into_array();
/// let expected = "root: vortex.primitive(i16, len=5)\n";
/// assert_eq!(format!("{}", array.display_as(DisplayOptions::TreeDisplay { buffers: false, metadata: false, stats: false })), expected);
///
/// # use vortex_array::arrays::StructArray;
/// let array = StructArray::from_fields(&[
/// ("x", buffer![1, 2].into_array()),
/// ("y", buffer![3, 4].into_array()),
/// ]).unwrap().into_array();
/// let expected = "root: vortex.struct({x=i32, y=i32}, len=2)
/// x: vortex.primitive(i32, len=2)
/// y: vortex.primitive(i32, len=2)
/// ";
/// assert_eq!(format!("{}", array.display_as(DisplayOptions::TreeDisplay { buffers: false, metadata: false, stats: false })), expected);
/// ```
TreeDisplay {
buffers: bool,
metadata: bool,
stats: bool,
},
/// Display values in a formatted table with columns.
///
/// For struct arrays, displays a column for each field in the struct.
Expand Down Expand Up @@ -164,6 +367,39 @@ impl dyn Array + '_ {
DisplayArrayAs(self, options)
}

/// Display the tree of array encodings and lengths without metadata, buffers, or stats.
///
/// # Examples
/// ```
/// # use vortex_array::display::DisplayOptions;
/// # use vortex_array::IntoArray;
/// # use vortex_buffer::buffer;
/// let array = buffer![0_i16, 1, 2, 3, 4].into_array();
/// let expected = "root: vortex.primitive(i16, len=5)\n";
/// assert_eq!(format!("{}", array.display_tree_encodings_only()), expected);
///
/// # use vortex_array::arrays::StructArray;
/// let array = StructArray::from_fields(&[
/// ("x", buffer![1, 2].into_array()),
/// ("y", buffer![3, 4].into_array()),
/// ]).unwrap().into_array();
/// let expected = "root: vortex.struct({x=i32, y=i32}, len=2)
/// x: vortex.primitive(i32, len=2)
/// y: vortex.primitive(i32, len=2)
/// ";
/// assert_eq!(format!("{}", array.display_tree_encodings_only()), expected);
/// ```
pub fn display_tree_encodings_only(&self) -> impl Display {
DisplayArrayAs(
self,
DisplayOptions::TreeDisplay {
buffers: false,
metadata: false,
stats: false,
},
)
}

/// Display the tree of encodings of this array as an indented lists.
///
/// While some metadata (such as length, bytes and validity-rate) are included, the logical
Expand All @@ -184,7 +420,14 @@ impl dyn Array + '_ {
/// assert_eq!(format!("{}", array.display_tree()), expected);
/// ```
pub fn display_tree(&self) -> impl Display {
DisplayArrayAs(self, DisplayOptions::TreeDisplay)
DisplayArrayAs(
self,
DisplayOptions::TreeDisplay {
buffers: true,
metadata: true,
stats: true,
},
)
}

/// Display the array as a formatted table.
Expand Down Expand Up @@ -246,7 +489,22 @@ impl dyn Array + '_ {
)?;
write!(f, "]")
}
DisplayOptions::TreeDisplay => write!(f, "{}", TreeDisplayWrapper(self.to_array())),
DisplayOptions::TreeDisplay {
buffers,
metadata,
stats,
} => {
write!(
f,
"{}",
TreeDisplayWrapper {
array: self.to_array(),
buffers: *buffers,
metadata: *metadata,
stats: *stats
}
)
}
#[cfg(feature = "table-display")]
DisplayOptions::TableDisplay => {
use vortex_dtype::DType;
Expand Down
Loading
Loading