Repository navigation
refactor(storages)!: rename storage clients to storage backends - #2362
Merged
Merged
Conversation
BREAKING CHANGE: `crawlee.storage_clients` is now `crawlee.storage_backends`, the `*Client` storage classes are now `*Backend`, and `storage_client` arguments and service locator methods use `storage_backend`. Log messages that named the storage client now name the storage backend, and the unsupported-arguments warning of dataset backends ends with the backend class name.
Codecov Report❌ Patch coverage is Additional details and impacted files@@ Coverage Diff @@
## v2 #2362 +/- ##
=====================================
Coverage ? 94.28%
=====================================
Files ? 187
Lines ? 13823
Branches ? 0
=====================================
Hits ? 13033
Misses ? 790
Partials ? 0
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
vdusek
marked this pull request as ready for review
October 29, 2026 08:44
Mantisus
approved these changes
Oct 29, 2026
Mantisus
left a comment
Collaborator
There was a problem hiding this comment.
Few nits. Otherwise LGTM
# Conflicts: # docs/upgrading/upgrading_to_v2.md # src/crawlee/storages/_request_queue.py # tests/unit/crawlers/_basic/test_basic_crawler.py
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Renames the pluggable storage layer from "storage clients" to "storage backends". Crawlee had a top-level storage client, a client per storage type, and the Apify API client on top, which made the role of each one hard to tell apart.
crawlee.storage_clientsis nowcrawlee.storage_backends.StorageClient,DatasetClient,KeyValueStoreClient,RequestQueueClientand the Memory, FileSystem, Sql and Redis implementations are now*Backend.storage_clientarguments (BasicCrawler,ServiceLocator,Dataset.open, ...) are nowstorage_backend, andservice_locator.get_storage_client/set_storage_clientare nowget_storage_backend/set_storage_backend.create_*_clientandget_storage_client_cache_keyonStorageBackendare renamed to match, and theDataset,KeyValueStoreandRequestQueueconstructors takebackend./docs/guides/storage-backends, andupgrading_to_v2.mdlists all the renames.It's a hard break with no aliases in v2. The deprecated aliases go into the last v1 minor. The Apify SDK subclasses the base and file-system backends, so it needs a matching rename when it moves to crawlee v2.
The log message about the implicit default backend and the unsupported-arguments warning of dataset backends have new wording.
Closes: #1592
✍️ Drafted by Claude Code