Skip to content

docs: fix storage transformers reference #388

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
andrewcb22 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: fix storage transformers reference #388

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/v3/core/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -339,10 +339,8 @@ The following figure illustrates the first part of the terminology:
Upon retrieval, the original keys and bytes are restored within the
transformer. Any number of storage transformers can be registered and
stacked. In contrast to codecs, storage transformers can act on the
complete array, rather than individual chunks. See the
`storage transformers details`_ below.

.. _`storage transformers details`: #storage-transformers-1
complete array, rather than individual chunks. See
:ref:`storage transformers details <storage-transformers-details>` below.

The following figure illustrates the codec, store and storage transformer
terminology for a use case of reading from an array:
Expand Down Expand Up @@ -1459,14 +1457,16 @@ Let "+" be the string concatenation operator.
For listable stores, ``list_dir(parent(P))`` can be an alternative.


.. _storage-transformers-details:

Storage transformers
====================

A Zarr storage transformer modifies a request to read or write data before passing
that request to the following transformer or store.
The stored transformed data is restored to its original state whenever data is requested
by the Array. Storage transformers can be configured per array via the
`storage_transformers <storage_transformers_>`_ name in the `array metadata`_. Storage transformers which do
:ref:`storage_transformers <array-metadata-storage-transformers>` name in the `array metadata`_. Storage transformers which do
not change the storage layout (e.g. for caching) may be specified at runtime without
adding them to the array metadata.

Expand Down