polars.scan_lance#

polars.scan_lance(
source: str | lance.LanceDataset | lancedb.Table,
*,
version: int | str | None = None,
storage_options: StorageOptionsDict | None = None,
credential_provider: CredentialProviderFunction | Literal['auto'] | None = 'auto',
) → LazyFrame[source]#

Lazily read from a Lance dataset.

Warning

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

engine:In MemoryStreamingDistributed
Parameters:
source

Path to the lance dataset, or a LanceDataset object.

version

If specified, load a specific version of the Lance dataset. Else, loads the latest version. A version number (int) or a tag (str) can be provided.

storage_options

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

credential_provider

Provide a function that can be called to provide cloud storage credentials. The function is expected to return a dictionary of credential keys along with an optional credential expiry time.