Skip to content

Backends

API reference for all storage backend classes. Each backend implements the Backend protocol. For usage guides, see Backends.

Class Description
LocalBackend Local filesystem storage
MemoryBackend In-process storage for testing
S3Backend Amazon S3 and S3-compatible services
S3PyArrowBackend S3 via PyArrow C++ for higher throughput
AzureBackend Azure Blob Storage and ADLS Gen2
SFTPBackend SSH/SFTP server storage via paramiko
ReadOnlyHttpBackend Read-only access to HTTP/HTTPS URLs
SQLBlobBackend SQL database blob storage via SQLAlchemy
SQLQueryBackend Read-only SQL query materialization via SQLAlchemy + PyArrow

Async-native backends

These backends run natively on the event loop under AsyncStore; they live in remote_store.aio.backends. Any synchronous backend above also works under AsyncStore via the thread-pool SyncBackendAdapter.

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) — async-only

See also