Skip to content

Base interface

Bases: ABC

Representation of readable file format.

.. versionadded:: 0.9.0

check_if_supported(spark) abstractmethod

Check if Spark session does support this file format. |support_hooks|

.. versionadded:: 0.9.0

Raises:

  • RuntimeError

    If file format is not supported.

apply_to_reader(reader) abstractmethod

Apply provided format to :obj:pyspark.sql.DataFrameReader. |support_hooks|

.. versionadded:: 0.9.0

Returns:

  • obj:`pyspark.sql.DataFrameReader`

    DataFrameReader with options applied.

Bases: ABC

Representation of writable file format.

.. versionadded:: 0.9.0

check_if_supported(spark) abstractmethod

Check if Spark session does support this file format. |support_hooks|

.. versionadded:: 0.9.0

Raises:

  • RuntimeError

    If file format is not supported.

apply_to_writer(writer) abstractmethod

Apply provided format to :obj:pyspark.sql.DataFrameWriter. |support_hooks|

.. versionadded:: 0.9.0

Returns:

  • obj:`pyspark.sql.DataFrameWriter`

    DataFrameWriter with options applied.