Skip to main content

Crate vortex_arrow

Crate vortex_arrow 

Source
Expand description

Apache Arrow interoperability for Vortex.

This crate owns every conversion between Vortex and Arrow: importing Arrow arrays, record batches, schemas, and fields into Vortex (FromArrowArray, FromArrowType, TryFromArrowType), and executing Vortex arrays into Arrow (ArrowSession::execute_arrow and the ArrowArrayExecutor convenience trait).

The ArrowSession session variable is created lazily on first use of ArrowSessionExt::arrow, so no explicit registration is required for plain conversions.

Re-exports§

pub use dtype::FromArrowType;
pub use dtype::ToArrowType;
pub use dtype::TryFromArrowType;

Modules§

bool
byte_view
dtype
Convert between Vortex vortex_array::dtype::DType and Apache Arrow arrow_schema::DataType.
null
primitive

Structs§

ArrowArrayStreamAdapter
An adapter for converting an ArrowArrayStreamReader into a Vortex ArrayStream.
ArrowSession
Session-scoped registry of Arrow extension plugins.
Datum
A wrapper around a generic Arrow array that can be used as a Datum in Arrow compute.

Enums§

ArrowExport
Outcome of a successful call to ArrowExportVTable::execute_arrow.
ArrowImport
Outcome of a successful call to ArrowImportVTable::from_arrow_array.

Traits§

ArrowArrayExecutorDeprecated
Trait for executing a Vortex array to produce an Arrow array.
ArrowExportVTable
Plugin layer for exporting a Vortex array to an Arrow extension type.
ArrowImportVTable
Plugin layer for importing an Arrow extension-typed array into a Vortex array.
ArrowSessionExt
Extension trait for accessing the ArrowSession on a Vortex session.
FromArrowArray
Construct a Vortex array from an Arrow array (or other Arrow container) of type A.
IntoArrowArrayDeprecated
IntoVortexArray
Zero-copy conversion of Arrow buffers into non-nullable Vortex arrays.
ToArrowDatum
Convert a Vortex Scalar into an Arrow Datum (a single-element Arrow array).

Functions§

from_arrow_array_with_lenDeprecated
Convert an Arrow array to an Array with a specific length. This is useful for compute functions that delegate to Arrow using Datum, which will return a scalar (length 1 Arrow array) if the input array is constant.
from_arrow_columnar
Convert an Arrow array to an Array with a specific length, using the provided ExecutionCtx.
initialize
Register vortex-arrow’s session extensions into session.
to_arrow_null_buffer
Converts a Validity to an Arrow NullBuffer, executing the validity array if needed.
to_null_buffer
Converts a mask to a null buffer.

Type Aliases§

ArrowExportVTableRef
ArrowImportVTableRef