Skip to content

Commit 75d5e49

Browse files
authored
add a note about non-transforming transformers (e.g. caches)
1 parent ba834f3 commit 75d5e49

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

docs/protocol/core/v3.0.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1576,7 +1576,9 @@ Storage transformers
15761576
A Zarr storage transformer allows to change the zarr-compatible data before storing it.
15771577
The stored transformed data is restored to its original state whenever data is requested
15781578
by the Array. Storage transformers can be configured per array via the
1579-
``storage_transformers`` name in the `array metadata`_.
1579+
``storage_transformers`` name in the `array metadata`_. Storage transformers which do
1580+
not change the storage layout (e.g. for caching) may be specified at runtime without
1581+
adding them to the array metadata.
15801582

15811583
A storage transformer serves the same `Abstract store interface`_ as the store_.
15821584
However, it should not persistently store any information necessary to restore the original data,
@@ -1585,7 +1587,7 @@ From the perspective of an Array or a previous stage transformer both store and
15851587
protocol and can be interchanged regarding the protocol. The behaviour can still be different,
15861588
e.g. requests may be cached or the form of the underlying data can change.
15871589

1588-
Storage Transformers may be stacked to combine different functionalities:
1590+
Storage transformers may be stacked to combine different functionalities:
15891591

15901592
.. mermaid::
15911593

0 commit comments

Comments
 (0)