Skip to content

Async API

The remote_store.aio namespace is the async counterpart of the core API. Its layout mirrors the synchronous reference: a Store, a Backend protocol, backend implementations, and extensions — each the async twin of its sync sibling, plus the adapters that bridge the two worlds.

For usage patterns (streaming, FastAPI integration, the thread-pool bridge), see the Async Store Guide.

Sync ↔ async map

Synchronous (remote_store) Asynchronous (remote_store.aio)
Store AsyncStore
Backend AsyncBackend
MemoryBackend AsyncMemoryBackend
AzureBackend AsyncAzureBackend
— GraphBackend (async-only)
ext.write aio.ext.write

Core

Class Description
AsyncStore Async counterpart to Store with coroutine methods for all operations
AsyncBackend Abstract base class for native async backends

Backends

Class Description
AsyncMemoryBackend In-memory async backend for testing
AsyncAzureBackend Native async Azure Blob Storage and ADLS Gen2
GraphBackend Microsoft Graph backend (OneDrive, SharePoint, Teams files)

Graph is async-only

GraphBackend has no synchronous twin. It appears here, not in the synchronous Backends section. To drive it from sync code, wrap it with AsyncBackendSyncAdapter.

Adapters & types

Symbol Description
SyncBackendAdapter Wraps any synchronous backend for async use via thread-pool executor
AsyncBackendSyncAdapter Wraps any AsyncBackend as a synchronous Backend via a private event loop
AsyncWritableContent Type alias: bytes or AsyncIterator[bytes]

Utilities

Symbol Description
GraphAuth MSAL token provider (client-credentials / device-code) for Graph
GraphUtils Resolve a Graph drive_id from OneDrive / SharePoint / Teams targets

Extensions

Module Description
aio.ext.write Async write helpers with guaranteed client-side content hashing

See also