Skip to main content

Crate timeseries_table_format

Crate timeseries_table_format 

Source
Expand description

§timeseries-table-format

Append-only time-series table format with gap/overlap tracking.

This crate is the canonical library for the table engine and optional integrations.

§Features

  • datafusion (default): Enables DataFusion integration for SQL queries

§Quick start

Open an existing table (async; returns a Future):

use timeseries_table_format::{TableLocation, TimeSeriesTable};

let location = TableLocation::local("./my_table");
let _open = TimeSeriesTable::open(location);

Or import the stable, supported surface via the prelude:

use timeseries_table_format::prelude::*;

Re-exports§

pub use metadata::logical_schema::LogicalDataType;
pub use metadata::logical_schema::LogicalField;
pub use metadata::logical_schema::LogicalSchema;
pub use metadata::table_metadata::IndexKind;
pub use metadata::table_metadata::IndexSpec;
pub use metadata::table_metadata::IndexSpecError;
pub use metadata::table_metadata::IndexValue;
pub use metadata::table_metadata::IndexValueError;
pub use metadata::table_metadata::ParseTimeBucketError;
pub use metadata::table_metadata::TableMeta;
pub use metadata::table_metadata::TimeBucket;
pub use metadata::table_metadata::validate_index_range;
pub use storage::TableLocation;
pub use table::OptimizeReport;
pub use table::TableError;
pub use table::TimeSeriesTable;
pub use datafusion::TsTableProvider;

Modules§

coverage
In-memory coverage and gap analysis over the 64-bit bucket domain.
datafusion
DataFusion integration for timeseries-table-format.
formats
Format-specific helpers.
metadata
Metadata layer.
prelude
Convenience prelude with the stable, supported surface. Convenience prelude.
storage
Filesystem layout and path utilities.
table
High-level time-series table abstraction.
transaction_log
Append-only metadata log and table state.