diff --git a/docs/user-guide/async.rst b/docs/user-guide/async.rst new file mode 100644 index 0000000000..f241e98c15 --- /dev/null +++ b/docs/user-guide/async.rst @@ -0,0 +1,39 @@ +.. _user-guide-async: + +Asynchronous API +================ + +Zarr-Python 3 added a new asynchronous API for reading and writing data using +`asyncio `_. The asynchronous +API enables concurrent I/O and parallel processing using a managed thread pool. +When operating in an async context, it can be used to provide asynchronous +access to Zarr data. + +The usage of the async API mirrors the synchronous API:: + + >>> import asyncio + >>> import numpy as np + >>> import zarr.api.asynchronous as async_zarr + >>> + >>> # create a new group using the asynchronous API + >>> root = await async_zarr.create_group(attributes={'foo': 'bar'}) + >>> root + >>> # create an array using the AsyncGroup + >>> z = await root.create_array(name='foo', shape=(100, ), chunks=(5, ), dtype=np.uint32) + >>> z + >>> # set and get items + >>> await z.setitem((slice(None), ), np.arange(0, 100, dtype=z.dtype)) + >>> # set a single item + >>> await z.setitem((7,), -99) + >>> # set a range to a constant value using a slice + >>> await z.setitem(slice(0, 3), -1) + >>> # get a slice of the array + >>> await z.getitem((slice(0, 5), )) + >>> # gather multiple items concurrently + >>> await asyncio.gather(z.getitem(slice(0, 5)), z.getitem(slice(6, 10))) + +See the API docs for more details: + +* :mod:`zarr.api.asynchronous` +* :class:`zarr.AsyncArray` +* :class:`zarr.AsyncGroup` diff --git a/docs/user-guide/index.rst b/docs/user-guide/index.rst index a7bbd12453..cc88fe4f13 100644 --- a/docs/user-guide/index.rst +++ b/docs/user-guide/index.rst @@ -22,8 +22,5 @@ Advanced Topics performance consolidated_metadata - extending - - -.. Coming soon async + extending pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.

Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy