ordeq_polars

PolarsEagerCSV dataclass

Bases: IO[DataFrame]

IO for loading and saving CSV using Polars.

Example:

>>> from ordeq_polars import PolarsEagerCSV
>>> from pathlib import Path
>>> csv = PolarsEagerCSV(
...     path=Path("to.csv")
... ).with_load_options(
...     has_header=True
... )

PolarsEagerExcel dataclass

Bases: IO[DataFrame]

IO for loading and saving Excel using Polars.

Example:

>>> from ordeq_polars import PolarsEagerExcel
>>> from pathlib import Path
>>> xlsx = PolarsEagerExcel(
...     path=Path("to.xlsx")
... ).with_load_options(
...     has_header=True
... )

PolarsEagerIceberg dataclass

Bases: Output[DataFrame]

IO for saving Iceberg tables eagerly using Polars.

Example:

>>> from ordeq_polars import PolarsEagerIceberg
>>> iceberg = PolarsEagerIceberg(
...     path="file:/path/to/iceberg-table/metadata.json",
... )

save(df, mode='append')

Write a DataFrame to an Iceberg table.

Parameters:

Name	Type	Description	Default
df	DataFrame	The DataFrame to write	required
mode	Literal['append', 'overwrite']	The write mode ("append" or "overwrite")	'append'

PolarsEagerJSON dataclass

Bases: IO[DataFrame]

IO to load from and save to JSON data using Polars.

Example usage:

>>> from pathlib import Path
>>> from ordeq_polars import PolarsEagerJSON
>>> my_json = PolarsEagerJSON(path=Path("path/to.json"))

PolarsEagerNdJSON dataclass

Bases: IO[DataFrame]

IO to load from and save to newline-delimited JSON data using Polars.

Example usage:

>>> from pathlib import Path
>>> from ordeq_polars import PolarsEagerNdJSON
>>> my_nd_json = PolarsEagerNdJSON(path=Path("path/to.ndjson"))

PolarsEagerParquet dataclass

Bases: IO[DataFrame]

IO for loading and saving Parquet using Polars.

Example:

>>> from ordeq_polars import PolarsEagerParquet
>>> from pathlib import Path
>>> parquet = PolarsEagerParquet(
...     path=Path("to.parquet")
... ).with_load_options(
...     n_rows=1_000
... )

PolarsLazyCSV dataclass

Bases: IO[LazyFrame]

IO for loading and saving CSV lazily using Polars.

Example:

>>> from ordeq_polars import PolarsLazyCSV
>>> from pathlib import Path
>>> csv = PolarsLazyCSV(
...     path=Path("to.csv")
... ).with_load_options(
...     has_header=True
... )

PolarsLazyIceberg dataclass

Bases: IO[LazyFrame]

IO for loading Iceberg tables lazily using Polars.

Example:

>>> from ordeq_polars import PolarsLazyIceberg
>>> iceberg = PolarsLazyIceberg(
...     path="file:/path/to/iceberg-table/metadata.json",
... )

load(**load_options)

Load an Iceberg table.

Parameters:

Name	Type	Description	Default
**load_options	Any	Additional options passed to pl.read_iceberg.	{}

Returns:

Type	Description
LazyFrame	LazyFrame containing the Iceberg table data

PolarsLazyNdJSON dataclass

Bases: IO[LazyFrame]

IO to load lazily from newline-delimited JSON data using Polars.

Example usage:

>>> from pathlib import Path
>>> from ordeq_polars import PolarsLazyNdJSON
>>> my_nd_json = PolarsLazyNdJSON(path=Path("path/to.ndjson"))

PolarsLazyParquet dataclass

Bases: IO[LazyFrame]

IO for loading and saving Parquet lazily using Polars.

Example:

>>> from ordeq_polars import PolarsLazyParquet
>>> from pathlib import Path
>>> parquet = PolarsLazyParquet(
...     path=Path("to.parquet")
... ).with_load_options(
...     n_rows=1_000
... )