vortex-layout 0.68.0

Vortex layouts provide a way to perform lazy push-down scans over abstract storage
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180

// SPDX-License-Identifier: Apache-2.0
// SPDX-FileCopyrightText: Copyright the Vortex contributors

use std::any::Any;
use std::sync::Arc;

use vortex_array::dtype::DType;
use vortex_error::VortexResult;
use vortex_error::vortex_bail;
use vortex_error::vortex_err;
use vortex_session::VortexSession;
use vortex_session::registry::ReadContext;

use crate::Layout;
use crate::LayoutChildType;
use crate::LayoutChildren;
use crate::LayoutEncoding;
use crate::LayoutEncodingId;
use crate::LayoutEncodingRef;
use crate::LayoutReaderRef;
use crate::LayoutRef;
use crate::segments::SegmentId;
use crate::segments::SegmentSource;

/// Placeholder layout encoding used when deserializing an unknown layout encoding ID.
#[derive(Clone, Debug)]
pub(crate) struct ForeignLayoutEncoding {
    id: LayoutEncodingId,
}

impl ForeignLayoutEncoding {
    pub(crate) fn new(id: LayoutEncodingId) -> Self {
        Self { id }
    }
}

impl LayoutEncoding for ForeignLayoutEncoding {
    fn as_any(&self) -> &dyn Any {
        self
    }

    fn id(&self) -> LayoutEncodingId {
        self.id.clone()
    }

    fn build(
        &self,
        dtype: &DType,
        row_count: u64,
        metadata: &[u8],
        segment_ids: Vec<SegmentId>,
        children: &dyn LayoutChildren,
        _ctx: &ReadContext,
    ) -> VortexResult<LayoutRef> {
        let child_layouts = (0..children.nchildren())
            .map(|idx| children.child(idx, dtype))
            .collect::<VortexResult<Vec<_>>>()?;

        Ok(new_foreign_layout(
            self.id.clone(),
            dtype.clone(),
            row_count,
            metadata.to_vec(),
            segment_ids,
            child_layouts,
        ))
    }
}

/// Placeholder layout used when deserializing an unknown layout encoding ID.
#[derive(Clone, Debug)]
pub(crate) struct ForeignLayout {
    encoding: LayoutEncodingRef,
    dtype: DType,
    row_count: u64,
    metadata: Vec<u8>,
    segment_ids: Vec<SegmentId>,
    children: Vec<LayoutRef>,
}

impl ForeignLayout {
    pub(crate) fn new(
        encoding_id: LayoutEncodingId,
        dtype: DType,
        row_count: u64,
        metadata: Vec<u8>,
        segment_ids: Vec<SegmentId>,
        children: Vec<LayoutRef>,
    ) -> Self {
        let encoding =
            LayoutEncodingRef::new_arc(Arc::new(ForeignLayoutEncoding::new(encoding_id)));

        Self {
            encoding,
            dtype,
            row_count,
            metadata,
            segment_ids,
            children,
        }
    }
}

pub(crate) fn new_foreign_layout(
    encoding_id: LayoutEncodingId,
    dtype: DType,
    row_count: u64,
    metadata: Vec<u8>,
    segment_ids: Vec<SegmentId>,
    children: Vec<LayoutRef>,
) -> LayoutRef {
    Arc::new(ForeignLayout::new(
        encoding_id,
        dtype,
        row_count,
        metadata,
        segment_ids,
        children,
    ))
}

impl Layout for ForeignLayout {
    fn as_any(&self) -> &dyn Any {
        self
    }

    fn as_any_arc(self: Arc<Self>) -> Arc<dyn Any + Send + Sync> {
        self
    }

    fn to_layout(&self) -> LayoutRef {
        Arc::new(self.clone())
    }

    fn encoding(&self) -> LayoutEncodingRef {
        self.encoding.clone()
    }

    fn row_count(&self) -> u64 {
        self.row_count
    }

    fn dtype(&self) -> &DType {
        &self.dtype
    }

    fn nchildren(&self) -> usize {
        self.children.len()
    }

    fn child(&self, idx: usize) -> VortexResult<LayoutRef> {
        self.children.get(idx).cloned().ok_or_else(|| {
            vortex_err!("Child index out of bounds: {} of {}", idx, self.nchildren())
        })
    }

    fn child_type(&self, idx: usize) -> LayoutChildType {
        LayoutChildType::Auxiliary(format!("[{idx}]").into())
    }

    fn metadata(&self) -> Vec<u8> {
        self.metadata.clone()
    }

    fn segment_ids(&self) -> Vec<SegmentId> {
        self.segment_ids.clone()
    }

    fn new_reader(
        &self,
        _name: Arc<str>,
        _segment_source: Arc<dyn SegmentSource>,
        _session: &VortexSession,
    ) -> VortexResult<LayoutReaderRef> {
        vortex_bail!(
            "Cannot read unknown layout encoding '{}'",
            self.encoding.id()
        )
    }
}