API Reference

polars_hist_db

Top-level package.

Configuration Management

Objects to access the configuration structure instantiated from YAML.

  • polars_hist_db.config

Core Operations

The core module contains the operations that interface between polars and the database. It provides:

  • Database operations (DbOps)
  • Table operations and management (TableOps, DeltaTableOps)
  • Dataframe operations (DataframeOps)
  • Audit of data inputs functionality (AuditOps)
  • Table configuration operations (TableConfigOps)

Some helpers for:

  • Constructing time-based hints at query time
  • Database engine creation utilities

Dataset Management

The dataset module is used to execute the scrape.

  • polars_hist_db.dataset

Data Loading

The loaders provide advanced utilities for processing files. It includes:

  • DSV (Delimiter-Separated Values) file loading with type support
  • Fast file search capabilities
  • ZIP file processing tools for converting zipped CSVs to Parquet format

Type Helpers

This module contains some helpers to map between SQL Types, SQLAlchemy Types, and Polars Types.

  • polars_hist_db.types