Skip to content

Commit 1378510

Browse files
committed
docs: Document storage client export change in v4 upgrading guide
1 parent 85f6266 commit 1378510

1 file changed

Lines changed: 18 additions & 0 deletions

File tree

docs/04_upgrading/upgrading_to_v4.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,24 @@ run = await Actor.start('my-actor-id', wait_for_finish=60)
8585
run = await Actor.call('my-actor-id', wait=timedelta(seconds=60))
8686
```
8787

88+
## Storage client exports
89+
90+
In v3, `apify.storage_clients.FileSystemStorageClient` was an alias for the Apify-specific file-system client, which shadowed Crawlee's distinct class of the same name. In v4 the name refers to Crawlee's `FileSystemStorageClient` (the base client), and the Apify variant is exported under its own name, `ApifyFileSystemStorageClient`.
91+
92+
`ApifyFileSystemStorageClient` stays the default local client, so most Actors need no change. Update your imports only if you construct the local client explicitly and rely on its Apify behavior, such as preserving the Actor `INPUT` record on purge or local `PAY_PER_EVENT` charging.
93+
94+
```python
95+
# Before (v3)
96+
from apify.storage_clients import FileSystemStorageClient
97+
98+
storage_client = FileSystemStorageClient()
99+
100+
# After (v4)
101+
from apify.storage_clients import ApifyFileSystemStorageClient
102+
103+
storage_client = ApifyFileSystemStorageClient()
104+
```
105+
88106
## Built on apify-client v3
89107

90108
The SDK is now built on [`apify-client`](https://docs.apify.com/api/client/python) v3 and no longer depends on `apify-shared`. The sections below cover the user-visible consequences; see the client's [Upgrading to v3](https://docs.apify.com/api/client/python/docs/upgrading/upgrading-to-v3) guide for the full list of changes in the client itself.

0 commit comments

Comments
 (0)