API Reference
Search documentation
karat

+

K

User Documentation ↗
Transformstransforms-pythontransforms.apiTransformInput

transforms.api.TransformInput

class transforms.api.TransformInput(rid, branch, txrange, dfreader, fsbuilder, batch_incremental_config=None)

The input object passed into Transform objects at runtime.

property batch_incremental_configuration

The configuration for an incremental input that will be read in batches.

  • Type: BatchIncrementalConfiguration

property branch

The branch of the dataset.

property column_descriptions

The column descriptions of the dataset.

  • Type: Dict[str, str]

property column_typeclasses

The column typeclasses of the dataset.

  • Type: Dict[str, str]

dataframe()

Return a pyspark.sql.DataFrame ↗ containing the full view of the dataset.

property end_transaction_rid

The ending transaction of the input dataset.

filesystem()

Construct a FileSystem object for reading from FoundryFS.

pandas()

pandas.DataFrame ↗: A pandas dataframe containing the full view of the dataset.

property path

The Compass path of the dataset.

property rid

The resource identifier of the dataset.

property start_transaction_rid

The starting transaction of the input dataset.