Repository navigation
Commit 0b3bf13
committed
v2 spec: add optional dimension_separator (see zarr-developers#707)
Various implementations allow for defining the separator between the
dimension indexes when writing chunks:
* n5-zarr defines a `dimensionSeparator` parameter;
* zarr-python's NestedDirectoryStore does so by default
* and FSStore provides a `key_separator` parameter;
* tensorstore has a `key_encoding` parameter; and
* jzarr is looking to add the same functionality.
When writing an array, it is straight-forward to set this separator
and have arrays properly configured. Consumers of such arrays,
however, must either know *a priori* if their arrays use a
non-default separator or must loop through all possible chunks keys
searching for the right one.
By defining adding an optional metadata key to the .zarray, we:
* preserve the efficient configuration of arrays
* while keeping the v2 spec backwards compatible.
The primary downsides are that this will be the first optional metadata
value in the v2 spec and therefore we don't have a strong understanding
of how that will play out, and datasets which were previously written
with non-default separators will need updating in order to enable the
detection though that is no worse than the current situation.1 parent 17728e8 commit 0b3bf13
1 file changed
Lines changed: 9 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
78 | 78 | | |
79 | 79 | | |
80 | 80 | | |
| 81 | + | |
| 82 | + | |
| 83 | + | |
| 84 | + | |
| 85 | + | |
| 86 | + | |
| 87 | + | |
| 88 | + | |
| 89 | + | |
81 | 90 | | |
82 | 91 | | |
83 | 92 | | |
| |||
0 commit comments