bayesline.api.equity.AsyncUploaderApi.get_data

bayesline.api.equity.AsyncUploaderApi.get_data#

abstract async AsyncUploaderApi.get_data(columns: list[str] | None = None, *, unique: bool = False, version: int | datetime | None = None) LazyFrame#

Gets the committed data at the given version.

Parameters#

columns: list[str] | None, optional

The columns to get. If None will get all columns.

unique: bool, optional

If True will return a unique set of rows. If False will return all rows.

version: int | dt.datetime | None, optional

The version of the underlying data, latest if not given. By definition version 0 is the empty dataframe with correct schema.

Raises#

KeyError

If the given version does not exist.

Returns#

pl.LazyFrame:

The committed data at the given version.