Add v3 consolidated metadata support to withConsolidated#383
Merged
Conversation
🦋 Changeset detectedLatest commit: d3b3a7f The changes in this PR will be included in the next version bump. This PR includes changesets to release 2 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
`withConsolidated` previously only supported Zarr v2 `.zmetadata`. This
adds support for v3 consolidated metadata (inline
`consolidated_metadata` in the root `zarr.json`), which is implemented
in zarr-python but not yet accepted into the Zarr v3 spec.
A new `format` option controls which format(s) to try. It accepts a
single format string or an array to try in order. When omitted, auto-
detection uses the existing version counter heuristic from `open`.
```ts
await withConsolidated(store); // auto-detect
await withConsolidated(store, { format: "v2" }); // v2 only
await withConsolidated(store, { format: "v3" }); // v3 only
await withConsolidated(store, { format: ["v3", "v2"] }); // try v3, fall back to v2
```
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
withConsolidatedpreviously only supported Zarr v2.zmetadata. This adds support for v3 consolidated metadata (inlineconsolidated_metadatain the rootzarr.json), which is implemented in zarr-python but not yet accepted into the Zarr v3 spec.A new
formatoption controls which format(s) to try. It accepts a single format string or an array to try in order. When omitted, auto- detection uses the existing version counter heuristic fromopen.