Skip to content

Dataframe reader

Module to define behaviour to read from dataframes.

DataFrameReader

Bases: Reader

Class to read data from a dataframe.

Source code in mkdocs/lakehouse_engine/packages/io/readers/dataframe_reader.py
class DataFrameReader(Reader):
    """Class to read data from a dataframe."""

    def __init__(self, input_spec: InputSpec):
        """Construct DataFrameReader instances.

        Args:
            input_spec: input specification.
        """
        super().__init__(input_spec)

    def read(self) -> DataFrame:
        """Read data from a dataframe.

        Returns:
            A dataframe containing the data from a dataframe previously
            computed.
        """
        return self._input_spec.df_name

__init__(input_spec)

Construct DataFrameReader instances.

Parameters:

Name Type Description Default
input_spec InputSpec

input specification.

required
Source code in mkdocs/lakehouse_engine/packages/io/readers/dataframe_reader.py
def __init__(self, input_spec: InputSpec):
    """Construct DataFrameReader instances.

    Args:
        input_spec: input specification.
    """
    super().__init__(input_spec)

read()

Read data from a dataframe.

Returns:

Type Description
DataFrame

A dataframe containing the data from a dataframe previously

DataFrame

computed.

Source code in mkdocs/lakehouse_engine/packages/io/readers/dataframe_reader.py
def read(self) -> DataFrame:
    """Read data from a dataframe.

    Returns:
        A dataframe containing the data from a dataframe previously
        computed.
    """
    return self._input_spec.df_name