Skip to content

Commit 51d77aa

Browse files
committed
document sharded read config options in user-guide/config.rst
1 parent 134c7c9 commit 51d77aa

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

docs/user-guide/config.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,10 @@ Configuration options include the following:
3333
- Async and threading options, e.g. ``async.concurrency`` and ``threading.max_workers``
3434
- Selections of implementations of codecs, codec pipelines and buffers
3535
- Enabling GPU support with ``zarr.config.enable_gpu()``. See :ref:`user-guide-gpu` for more.
36+
- Tuning reads from sharded zarrs. When reading less than a complete shard, reads to nearby chunks
37+
within the same shard will be combined into a single request if they are less than
38+
``sharding.read.coalesce_max_gap_bytes`` apart and the combined request size is less than
39+
``sharding.read.coalesce_max_bytes``.
3640

3741
For selecting custom implementations of codecs, pipelines, buffers and ndbuffers,
3842
first register the implementations in the registry and then select them in the config.

0 commit comments

Comments
 (0)