Kerchunk¶
virtualizarr.parsers.KerchunkJSONParser ¶
Create a ManifestStore from a Kerchunk JSON references file.
Parameters:
-
group(str | None, default:None) –The group within the Kerchunk JSON to be used as the Zarr root group for the ManifestStore.
-
fs_root(str | None, default:None) –The qualifier to be used for Kerchunk chunk references containing relative paths.
-
skip_variables(Iterable[str] | None, default:None) –Variables in the Kerchunk JSON that will be ignored when creating the ManifestStore.
__call__ ¶
__call__(url: str, registry: ObjectStoreRegistry) -> ManifestStore
Parse the metadata and byte offsets from a given Kerchunk JSON to produce a VirtualiZarr ManifestStore.
Parameters:
-
url(str) –The URL of the input Kerchunk JSON (e.g., "s3://bucket/kerchunk.json").
-
registry(ObjectStoreRegistry) –An ObjectStoreRegistry for resolving urls and reading data.
Returns:
-
ManifestStore–A ManifestStore that provides a Zarr representation of the parsed Kerchunk JSON.
virtualizarr.parsers.KerchunkParquetParser ¶
Create a ManifestStore from a Kerchunk Parquet references directory.
Parameters:
-
group(str | None, default:None) –The group within the input Kerchunk Parquet references to be used as the Zarr root group for the ManifestStore.
-
fs_root(str | None, default:None) –The qualifier to be used for chunk references containing relative paths.
-
skip_variables(Iterable[str] | None, default:None) –Variables in the Kerchunk Parquet references that will be ignored when creating the ManifestStore.
-
reader_options(dict | None, default:None) –Configuration options used internally for the fsspec backend.
__call__ ¶
__call__(url: str, registry: ObjectStoreRegistry) -> ManifestStore
Parse the metadata and byte offsets from a given Kerchunk Parquet directory to produce a VirtualiZarr ManifestStore.
Parameters:
-
url(str) –The URL of the input parquet directory (e.g., "s3://bucket/my-kerchunk-references.parq").
-
registry(ObjectStoreRegistry) –An ObjectStoreRegistry for resolving urls and reading data.
Returns:
-
ManifestStore–A ManifestStore which provides a Zarr representation based on the parsed Kerchunk Parquet directory.