transforms.api.LightweightInput

class transforms.api.LightweightInput(alias, rid, branch=None)

The input object passed into ContainerTransform objects at runtime.

Its aim is to mimic a subset of the transforms.api.TransformInput API, while providing access to the underlying foundry.transforms.Dataset.

property alias

The alias of the dataset this parameter is associated with.

arrow()

A PyArrow table containing the full view of the dataset.

property branch

The branch of the dataset this parameter is associated with.

dataframe()

A pandas DataFrame containing the full view of the dataset.

property end_transaction_rid

The ending transaction of the input dataset.

• Type: str ↗

filesystem()

Access the filesystem in read-only mode.

Construct a FoundryDataSidecarFileSystem object for accessing the dataset’s files directly.

pandas()

A pandas DataFrame containing the full view of the dataset.

path()

Download the dataset’s underlying files and return a path to them.

polars(lazy=False)

A Polars DataFrame or LazyFrame containing the full view of the dataset.

• Parameters: lazy (bool ↗ , optional) – Whether to return a LazyFrame or DataFrame. Defaults to False.

property rid

The unique resource identifier of the dataset this parameter is associated with.

property start_transaction_rid

the starting transaction of the input dataset.

• Type: str ↗