Skip to content

Commit 7c9a72b

Browse files
committed
move to explicit but hardcoded id
Signed-off-by: Onur Satici <onur@spiraldb.com>
1 parent 9ea80e0 commit 7c9a72b

1 file changed

Lines changed: 13 additions & 7 deletions

File tree

  • vortex-layout/src/layouts/array_tree

vortex-layout/src/layouts/array_tree/mod.rs

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -123,10 +123,15 @@ impl ArrayTreeLayout {
123123
/// }
124124
/// ```
125125
///
126-
/// The List<> element types are exactly the canonical per-tree schemas defined by
127-
/// [`vortex_array::serde::NODES_COLUMNS_DTYPE`] / [`vortex_array::serde::BUFFER_COLUMNS_DTYPE`],
128-
/// so slicing one row's nodes (resp. buffers) yields a [`StructArray`] matching the inner
126+
/// The List<> element types are produced by
127+
/// [`vortex_array::serde::nodes_columns_dtype`] / [`vortex_array::serde::BUFFER_COLUMNS_DTYPE`].
128+
/// Slicing one row's nodes (resp. buffers) yields a [`StructArray`] matching the inner
129129
/// shape of a [`ColumnarArrayTree`].
130+
///
131+
/// The `nodes` schema is parameterized by the stat menu the layout tracks; today this
132+
/// defaults to [`vortex_array::serde::DEFAULT_STATS`] (the historical 11-stat set), but
133+
/// future writers can pick a different menu and the schema field names carry that menu
134+
/// across the wire.
130135
pub fn array_trees_dtype() -> DType {
131136
let nn = Nullability::NonNullable;
132137
DType::Struct(
@@ -148,8 +153,9 @@ impl ArrayTreeLayout {
148153
}
149154

150155
/// Derive a [`LayoutReaderContext`] that publishes an [`ArrayTreesSource`] backed by this
151-
/// layout's auxiliary `array_trees` child. Descendant [`ArrayTreeFlatLayout`] readers
152-
/// pull the source via `ctx.get::<ArrayTreesSource>()` to resolve their compact trees.
156+
/// layout's auxiliary `array_trees` child under [`ARRAY_TREES_SOURCE_ID`]. Descendant
157+
/// [`ArrayTreeFlatLayout`] readers pull the source by the same id to resolve their
158+
/// compact trees.
153159
///
154160
/// Used by:
155161
/// - The normal [`crate::VTable::new_reader`] dispatch on `ArrayTreeLayout` (production path).
@@ -273,8 +279,8 @@ impl VTable for ArrayTree {
273279
/// the cached map.
274280
///
275281
/// Published by [`ArrayTreeLayout::derive_reader_ctx`] into the [`LayoutReaderContext`]
276-
/// passed to descendants; pulled by [`ArrayTreeFlatLayout`]'s reader via
277-
/// `ctx.get::<ArrayTreesSource>()`.
282+
/// passed to descendants under [`ARRAY_TREES_SOURCE_ID`]; pulled by
283+
/// [`ArrayTreeFlatLayout`]'s reader by the same id.
278284
pub struct ArrayTreesSource {
279285
reader: LayoutReaderRef,
280286
/// Session used to create execution contexts when canonicalizing the consolidated array

0 commit comments

Comments
 (0)