Skip to main content
Version: 1.5.0

SnowflakeDestination

class
class SnowflakeDestination(
connection_parameters: dict,
destination_table: List[str] | str,
if_table_exists: Literal['append', 'replace'] = 'append',
stage: str | None = None,
**kwargs,
)

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 SnowflakeDestination with the configuration desired to store the data.

Properties

property
destination_tablelist[str]

Get the destination table(s) where the data will be stored.

Returns: str | list[str]: The destination table(s).

property
if_table_existsLiteral['append', 'replace']

Returns the value of the if_table_exists property. This property determines what to do if the table already exists.

Methods

method
chunk
def chunk(working_dir: str, *results: LazyFrame | None) -> List[None | str]

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
stream
def stream(working_dir: str, *results: List[LazyFrame | None] | LazyFrame | NoneType)

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

method
write
def write(files)

This method is used to write the files to the database. It is called from the stream method, and it is not intended to be called directly.