Skip to content

Commit 5c2eef4

Browse files
committed
adapt metadata format of codecs and sharding
1 parent 766c22e commit 5c2eef4

File tree

3 files changed

+7
-15
lines changed

3 files changed

+7
-15
lines changed

docs/v3/array-storage-transformers/sharding/v1.0.rst

Lines changed: 5 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -94,22 +94,14 @@ Sharding can be configured per array in the :ref:`array-metadata` as follows:
9494
{
9595
storage_transformers: [
9696
{
97-
"extension": "sharding",
98-
"type": "indexed",
97+
"name": "sharding",
9998
"configuration": {
100-
"chunks_per_shard": [
101-
2,
102-
2
103-
]
99+
"chunks_per_shard": [2, 2]
104100
}
101+
}
105102
]
106103
}
107104
108-
``type``
109-
110-
Specifies a `Binary shard format`_. In this version, the only binary format
111-
is the ``indexed`` format.
112-
113105
``chunks_per_shard``
114106

115107
An array of integers providing the number of chunks that are combined in a
@@ -157,8 +149,8 @@ separator (e.g. "data/root/foo/baz/c3/9"). Chunk grid positions ``[96, 19]``,
157149
Binary shard format
158150
-------------------
159151

160-
The only binary format is the ``indexed`` format, as specified by the ``type``
161-
configuration key. Other binary formats might be added in future versions.
152+
The only binary format at the moment is an indexed binary format as described
153+
below. Other binary formats might be added in future versions.
162154

163155
In the indexed binary format, chunks are written successively in a shard, where
164156
unused space between them is allowed, followed by an index referencing them. The

docs/v3/codecs/blosc/v1.0.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ default block size::
9292

9393
{
9494
"codecs": [{
95-
"type": "blosc",
95+
"name": "blosc",
9696
"configuration": {
9797
"cname": "lz4",
9898
"clevel": 1,

docs/v3/codecs/gzip/v1.0.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ the Gzip codec configured with a compression level of 1::
6868

6969
{
7070
"codecs": [{
71-
"type": "gzip",
71+
"name": "gzip",
7272
"configuration": {
7373
"level": 1
7474
}

0 commit comments

Comments
 (0)