Skip to content

Commit 547af69

Browse files
committed
docs: document Crawlee storage clients and rename storages page
1 parent 17e48ae commit 547af69

4 files changed

Lines changed: 6 additions & 6 deletions

File tree

docs/01_introduction/quick-start.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ To learn more about the features of the Apify SDK and how to use them, check out
8585

8686
- [Actor lifecycle](../concepts/actor-lifecycle)
8787
- [Actor input](../concepts/actor-input)
88-
- [Working with storages](../concepts/storages)
88+
- [Storages](../concepts/storages)
8989
- [Storage clients](../concepts/storage-clients)
9090
- [Actor events & state persistence](../concepts/actor-events)
9191
- [Proxy management](../concepts/proxy-management)

docs/02_concepts/03_storages.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
id: storages
3-
title: Working with storages
3+
title: Storages
44
description: Use datasets, key-value stores, and request queues to persist Actor data.
55
---
66

docs/02_concepts/12_storage_clients.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,10 @@ The `apify.storage_clients` module provides the following clients:
3030
- <ApiLink to="class/FileSystemStorageClient">`FileSystemStorageClient`</ApiLink> — persists data to the local filesystem. Used as the default local client.
3131
- <ApiLink to="class/MemoryStorageClient">`MemoryStorageClient`</ApiLink> — keeps everything in memory only; nothing is persisted. Useful for tests and short-lived runs.
3232

33+
All of these implement Crawlee's <ApiLink to="class/StorageClient">`StorageClient`</ApiLink> interface, so any of them can be used as a sub-client of `SmartApifyStorageClient` — see [customizing the storage client](#customizing-the-storage-client) below.
34+
35+
Crawlee additionally ships storage clients backed by a self-hosted database — a [`RedisStorageClient`](https://crawlee.dev/python/api/class/RedisStorageClient) and a [`SqlStorageClient`](https://crawlee.dev/python/api/class/SqlStorageClient). The Apify SDK does not re-export these, because they each require an extra dependency that the SDK does not install. To use one, install the matching Crawlee extra (for example `pip install 'crawlee[redis]'` or `crawlee[sql-postgres]` / `crawlee[sql-sqlite]`), import the client from `crawlee.storage_clients`, and pass it as a sub-client of `SmartApifyStorageClient`. See the [Crawlee storage clients guide](https://crawlee.dev/python/docs/guides/storage-clients) for details.
36+
3337
## Single vs. shared request queue
3438

3539
`ApifyStorageClient` supports two ways of accessing the Apify request queue, selected via its `request_queue_access` argument:

website/docusaurus.config.js

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -259,10 +259,6 @@ module.exports = {
259259
url: 'https://crawlee.dev/python/api/class/FileSystemStorageClient',
260260
group: 'Storage clients',
261261
},
262-
{
263-
url: 'https://crawlee.dev/python/api/class/SqlStorageClient',
264-
group: 'Storage clients',
265-
},
266262
// Request loaders
267263
{
268264
url: 'https://crawlee.dev/python/api/class/RequestLoader',

0 commit comments

Comments
 (0)