Expand description
Vortex TUI library for interactively browsing and inspecting Vortex files.
This crate provides both a CLI tool (vx) and a library API for working with Vortex files.
Users can bring their own VortexSession to enable custom encodings and extensions.
§Example
ⓘ
use vortex::session::VortexSession;
use vortex::io::session::RuntimeSessionExt;
use vortex_tui::browse;
#[tokio::main]
async fn main() -> anyhow::Result<()> {
let session = VortexSession::default().with_tokio();
browse::exec_tui(&session, "my_file.vortex").await?;
Ok(())
}Modules§
- browse
- Interactive TUI browser for Vortex files.
- convert
- Convert Parquet files to Vortex format.
- datafusion_
helper - Shared DataFusion query execution utilities for both CLI and TUI.
- inspect
- Inspect Vortex file metadata and structure.
- query
- Execute SQL queries against Vortex files using DataFusion.
- segment_
tree - Shared segment tree collection logic used by both the TUI browse view and the CLI segments command.
- segments
- Display segment information for Vortex files.
- tree
- Print tree views of Vortex files.
Functions§
- launch
- Main entrypoint for
vxthat launches aVortexSession. - launch_
from - Launch
vxwith explicit command-line arguments.