q-Php x d dl mZ d dlmZmZmZ d dlmZ d dlm Z d dl
m Z er d dl m
Z
d dlmZ dddd ddZdS ) ) annotations)
TYPE_CHECKINGAnyLiteral)issue_unstable_warning)wrap_ldf)IcebergDataset)Table) LazyFrameN) snapshot_idstorage_optionsreader_overridesource str | Tabler
int | Noner
dict[str, Any] | Noner %Literal['native', 'pyiceberg'] | Nonereturnr c ddl m} |d}t | t | ||| }t | | S )al
Lazily read from an Apache Iceberg table.
Parameters
----------
source
A PyIceberg table, or a direct path to the metadata.
Note: For Local filesystem, absolute and relative paths are supported but
for the supported object storages - GCS, Azure and S3 full URI must be provided.
snapshot_id
The snapshot ID to scan from.
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 `__.
reader_override
Overrides the reader used to read the data.
Warning: This parameter is considered unstable, and is subject to change.
Note that this parameter should not be necessary outside of testing, as
polars will by default automatically select the best reader.
Available options:
* native: Uses polars native reader. This allows for more optimizations to
improve performance.
* pyiceberg: Uses PyIceberg, which may support more features.
Returns
-------
LazyFrame
Examples
--------
Creates a scan for an Iceberg table from local filesystem, or object store.
>>> table_path = "file:/path/to/iceberg-table/metadata.json"
>>> pl.scan_iceberg(table_path).collect() # doctest: +SKIP
Creates a scan for an Iceberg table from S3.
See a list of supported storage options for S3 `here
`__.
>>> table_path = "s3://bucket/path/to/iceberg-table/metadata.json"
>>> storage_options = {
... "s3.region": "eu-central-1",
... "s3.access-key-id": "THE_AWS_ACCESS_KEY_ID",
... "s3.secret-access-key": "THE_AWS_SECRET_ACCESS_KEY",
... }
>>> pl.scan_iceberg(
... table_path, storage_options=storage_options
... ).collect() # doctest: +SKIP
Creates a scan for an Iceberg table from Azure.
Supported options for Azure are available `here
`__.
Following type of table paths are supported:
* az:////metadata.json
* adl:////metadata.json
* abfs[s]:////metadata.json
>>> table_path = "az://container/path/to/iceberg-table/metadata.json"
>>> storage_options = {
... "adlfs.account-name": "AZURE_STORAGE_ACCOUNT_NAME",
... "adlfs.account-key": "AZURE_STORAGE_ACCOUNT_KEY",
... }
>>> pl.scan_iceberg(
... table_path, storage_options=storage_options
... ).collect() # doctest: +SKIP
Creates a scan for an Iceberg table from Google Cloud Storage.
Supported options for GCS are available `here
`__.
>>> table_path = "s3://bucket/path/to/iceberg-table/metadata.json"
>>> storage_options = {
... "gcs.project-id": "my-gcp-project",
... "gcs.oauth.token": "ya29.dr.AfM...",
... }
>>> pl.scan_iceberg(
... table_path, storage_options=storage_options
... ).collect() # doctest: +SKIP
Creates a scan for an Iceberg table with additional options.
In the below example, `without_files` option is used which loads the table without
file tracking information.
>>> table_path = "/path/to/iceberg-table/metadata.json"
>>> storage_options = {"py-io-impl": "pyiceberg.io.fsspec.FsspecFileIO"}
>>> pl.scan_iceberg(
... table_path, storage_options=storage_options
... ).collect() # doctest: +SKIP
Creates a scan for an Iceberg table using a specific snapshot ID.
>>> table_path = "/path/to/iceberg-table/metadata.json"
>>> snapshot_id = 7051579356916758811
>>> pl.scan_iceberg(table_path, snapshot_id=snapshot_id).collect() # doctest: +SKIP
r ) PyLazyFrameNzKthe `reader_override` parameter of `scan_iceberg()` is considered unstable.)r iceberg_storage_propertiesr )
polars.polarsr r r r new_from_dataset_object)r r r
r r msgdatasets [/var/www/html/test/jupyter/venv/lib/python3.11/site-packages/polars/io/iceberg/functions.py scan_icebergr sn ^ *)))))"[ s### #2' G K77@@ A AA )
r r r r r
r r r r r )
__future__r typingr r r polars._utils.unstabler polars._utils.wrapr polars.io.iceberg.datasetr pyiceberg.tabler
polars.lazyframe.framer r r r r' s " " " " " " . . . . . . . . . . 9 9 9 9 9 9 ' ' ' ' ' ' 4 4 4 4 4 4 1%%%%%%000000 #-1=A |B |B |B |B |B |B |B |Br