Skip to content

Zarr Extension (Python) API Reference

sedonadb-zarr reads Zarr groups into the SedonaDB raster type. Install it alongside SedonaDB, register the extension on your connection, and read a group through its format spec:

import sedona.db
import sedonadb_zarr

sd = sedona.db.connect()
sd.register(sedonadb_zarr.ZarrExtension())
sd.read("file:///path/to/foo.zarr").show()

For an end-to-end walkthrough, see Working with Zarr and NDArray data in SedonaDB.

sedonadb_zarr.ZarrExtension

SedonaDB Zarr extension entrypoint

This interface enables registration of Zarr components with a Python SedonaContext.

Examples:

>>> from sedonadb_zarr import ZarrExtension
>>> sd = sedona.db.connect()
>>> sd.register(ZarrExtension())

sedonadb_zarr.Zarr

Bases: ExternalFormatSpec

ExternalFormatSpec for Zarr groups.

This is registered automatically when registering the module with a SedonaContext. Use with sd.read(uri, format=Zarr()) or format="zarr" after registering the extension:

sd.read("file:///path/to/foo.zarr", format="zarr")

Parameters:

  • options (Optional[Mapping[str, Any]], default: None ) –

    Supported options include - arrays (list[str]) — explicit subset of group arrays to read.

with_options

with_options(options: Mapping[str, Any]) -> Zarr