Skip to main content

oxidelake_storage/
lib.rs

1//! Storage layer (docs/SPEC.md §2.4): Parquet writer and pruning configuration,
2//! Arrow IPC spill/cache files, and the object-store IO layer.
3//!
4//! There is no private file format (ADR-0014). Lake data is Parquet read
5//! through DataFusion, whose statistics, page-index and Bloom-filter pruning
6//! this crate configures and *proves* (see [`scan_pruning_metrics`]); spill and
7//! cache files are Arrow IPC with 64-byte-aligned buffers; all IO goes through
8//! [`object_store::ObjectStore`] — `LocalFileSystem` by default, the io_uring
9//! implementation behind the `io-uring` feature on Linux.
10//!
11//! Dependency direction: depends on `oxidelake-core` and `oxidelake-memory`.
12
13#[cfg(feature = "datagen")]
14pub mod datagen;
15pub mod errors;
16pub mod ipc;
17mod parquet_check;
18pub mod parquet_io;
19pub mod parquet_opts;
20pub mod scan_guard;
21pub mod session;
22pub mod store;
23
24#[cfg(all(feature = "io-uring", target_os = "linux"))]
25pub mod uring;
26
27#[cfg(feature = "datagen")]
28pub use datagen::{
29    CHUNK_ROWS, DemoOptions, DemoTable, SPECIAL_FLOAT_EVERY, SPECIAL_FLOATS, demo_batches,
30    demo_batches_with, demo_chunks, demo_chunks_with, demo_schema, demo_write_options,
31    write_demo_table, write_demo_table_with,
32};
33pub use errors::classify_error;
34pub use ipc::{read_ipc_file, write_ipc_file};
35pub use parquet_io::{ParquetFileWriter, write_parquet};
36pub use parquet_opts::{Compression, ParquetWriteOptions};
37pub use scan_guard::ParquetScanGuard;
38pub use session::{
39    GPU_BATCH_SIZE, PruningSummary, pruning_session, register_parquet_table, scan_pruning_metrics,
40    with_gpu_batch_size, with_pruning, with_pruning_disabled,
41};
42pub use store::{BoundedReadStore, default_object_store, register_local_store};
43
44#[cfg(all(feature = "io-uring", target_os = "linux"))]
45pub use uring::UringLocalFileSystem;