polars.LazyFrame.sink_iceberg#

LazyFrame.sink_iceberg( target: str | pyiceberg.table.Table, *, mode: Literal['append', 'overwrite'], catalog: pyiceberg.catalog.Catalog | polars.io.iceberg.IcebergCatalogConfig | None = None, storage_options: StorageOptionsDict | None = None, ) → DataFrame[source]#

Sink a LazyFrame to an Iceberg table.

Warning

This functionality is currently considered unstable. It may be changed at any point without it being considered a breaking change.

Parameters:

target

A PyIceberg Table object, or a ‘namespace.table_name’ identifier string.

mode{‘append’, ‘overwrite’}

How to handle existing data.

If ‘append’, will add new data.
If ‘overwrite’, will replace table with new data.

catalog

PyIceberg catalog to load the table from if the provided target was a table identifier.

storage_options

Extra options for the storage backends supported by pyiceberg. For cloud storages, this may include configurations for authentication etc.

More info is available here.

Returns:

DataFrame: Contains the new metadata path.