LocalFileDestination

classView source ↗

class LocalFileDestination(path: str | list[str], format: str | FileFormat = None)

Bases: DestinationPlugin

Categories: destination

Abstract class for output plugins.

Methods: trigger_output(working_dir, *args, **kwargs) Trigger the exporting of the data. This function will receive the resulting data from the dataset function and must store it in the desired location.

Initializes the LocalFileDestination with the given path; and optionally a format.

Parameters

parameter

pathstr | list[str]

The path where the files must be stored. It can be a single path or a list of paths.

parameter

formatstr | FileFormat, optional

The format of the file. If not provided, it will be inferred from the file extension of the data. Can be either a string with the format or a FileFormat object. Currently supported formats are 'csv', 'parquet', 'ndjson' and 'jsonl'.

Raises

OutputConfigurationError FormatConfigurationError

Properties

property

allow_fragmentsbool

Whether to allow fragments in the output.

property

formatFileFormat

The format of the file or files. If not provided, it will be inferred from the file extension in the path.

property

pathstr | list[str]

The path or paths to store the files.

class

View source ↗

SupportedFormats

class SupportedFormats(*args, **kwds)

Bases: Enum

Enum for the supported formats for the LocalFileDestination.

attribute

avro

attribute

csv

attribute

ndjson

attribute

parquet

Methods

method

View source ↗

chunk

def chunk(working_dir: str, *results)

Trigger the exporting of the data to local parquet chunks. This method will receive the resulting data from the user function and must store it in the local system as parquet files, using the working_dir. Note: This method should not materialize the data, it should only store it in the local system.

Parameters:

parameter

working_dirstr

The folder where any files generated must be stored (this refers to temporary files that will be deleted after the execution of the plugin, not the final destination of the data)

parameter

results

The data to be exported. It is a list of polars LazyFrames or None.

Returns:

A list of the intermediate files created

method

View source ↗

stream

def stream(working_dir: str, *results)

Trigger the exporting of the data. This method will receive the resulting data from the user function and must store it in the desired location. Note: this method might materialize the data provided in a single chunk generated by the chunk function if invoked, so chunks should be of an appropriate size.

Parameters:

parameter

working_dirstr

The folder where any intermediate files generated must be stored (this refers to temporary files that will be deleted after the execution of the plugin, not the final destination of the data)

parameter

results

The data to be exported. It is a list of polars LazyFrames or None.

Returns:

None