virtualizarr.accessor.VirtualiZarrDatasetAccessor.to_icechunk#

VirtualiZarrDatasetAccessor.to_icechunk(store: IcechunkStore, *, group: str | None = None, append_dim: str | None = None, last_updated_at: datetime | None = None) → None#

Write an xarray dataset to an Icechunk store.

Any variables backed by ManifestArray objects will be be written as virtual references. Any other variables will be loaded into memory before their binary chunk data is written into the store.

If append_dim is provided, the virtual dataset will be appended to the existing IcechunkStore along the append_dim dimension.

If last_updated_at is provided, it will be used as a checksum for any virtual chunks written to the store with this operation. At read time, if any of the virtual chunks have been updated since this provided datetime, an error will be raised. This protects against reading outdated virtual chunks that have been updated since the last read. When not provided, no check is performed. This value is stored in Icechunk with seconds precision, so be sure to take that into account when providing this value.

Parameters:

  • store – Store to write dataset into.

  • group – Path of the group to write the dataset into (default: the root group).

  • append_dim – Dimension along which to append the virtual dataset.

  • last_updated_at – Datetime to use as a checksum for any virtual chunks written to the store with this operation. When not provided, no check is performed.

Raises:

ValueError – If the store is read-only.

Examples

To ensure an error is raised if the files containing referenced virtual chunks are modified at any time from now on, pass the current time to last_updated_at.

>>> from datetime import datetime
>>> vds.virtualize.to_icechunk(
...     icechunkstore,
...     last_updated_at=datetime.now(),
... )