vortex-array 0.59.4

Vortex in memory columnar data format
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

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

use std::any::Any;

use arrow_array::ArrayRef as ArrowArrayRef;
use arrow_schema::DataType;
use vortex_error::VortexResult;
use vortex_error::vortex_ensure;

use crate::Array;
use crate::LEGACY_SESSION;
use crate::VortexSessionExecute;
use crate::arrow::ArrowArrayExecutor;
use crate::compute::Options;

/// Convert a Vortex array to an Arrow array with the encoding's preferred `DataType`.
///
/// For example, a `VarBinArray` will be converted to an Arrow `VarBin` array, instead of the
/// canonical `VarBinViewArray`.
///
/// Warning: do not use this to convert a Vortex [`crate::stream::ArrayStream`] since each array
/// may have a different preferred Arrow type. Use [`to_arrow`] instead.
#[deprecated(note = "Use ArrowArrayExecutor::execute_arrow instead")]
#[expect(deprecated)]
pub fn to_arrow_preferred(array: &dyn Array) -> VortexResult<ArrowArrayRef> {
    to_arrow_opts(array, &ToArrowOptions { arrow_type: None })
}

/// Convert a Vortex array to an Arrow array of the given type.
#[deprecated(note = "Use ArrowArrayExecutor::execute_arrow instead")]
pub fn to_arrow(array: &dyn Array, arrow_type: &DataType) -> VortexResult<ArrowArrayRef> {
    let mut ctx = LEGACY_SESSION.create_execution_ctx();
    array.to_array().execute_arrow(Some(arrow_type), &mut ctx)
}

#[deprecated(note = "Use ArrowArrayExecutor::execute_arrow instead")]
#[expect(deprecated)]
pub fn to_arrow_opts(array: &dyn Array, options: &ToArrowOptions) -> VortexResult<ArrowArrayRef> {
    let data_type = if let Some(data_type) = &options.arrow_type {
        data_type.clone()
    } else {
        array.dtype().to_arrow_dtype()?
    };
    let arrow = to_arrow(array, &data_type)?;

    vortex_ensure!(
        &data_type == arrow.data_type(),
        "to arrow returned array with data_type {}, expected {}",
        arrow.data_type(),
        data_type
    );

    Ok(arrow)
}

pub struct ToArrowOptions {
    /// The Arrow data type to convert to, if specified.
    pub arrow_type: Option<DataType>,
}

impl Options for ToArrowOptions {
    fn as_any(&self) -> &dyn Any {
        self
    }
}