Skip to content

docs: Add force_cloud argument documentation #415

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Feb 25, 2025
Merged

docs: Add force_cloud argument documentation #415

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
59dcf0c
Add force_cloud documentation.
Pijukatel Feb 25, 2025
7986bd4
Merge remote-tracking branch 'origin/master' into force-cloud-documen…
Pijukatel Feb 25, 2025
8d22241
Update docs/03_concepts/03_storages.mdx
Pijukatel Feb 25, 2025
0c94a58
Add example use case to docs
Pijukatel Feb 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/03_concepts/03_storages.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,10 @@ Each storage is then stored in its own folder, named after the storage, or calle

Each dataset item, key-value store record, or request in a request queue is then stored in its own file in the storage folder. Dataset items and request queue requests are always JSON files, and key-value store records can be any file type, based on its content type. For example, the Actor input is typically stored in `storage/key_value_stores/default/INPUT.json`.

## Local Actor run with non-local storage
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome! Could you also mention that the typical use is when you want to call another Actor and then access its default dataset/kvstore/rq?


When developing locally, opening any storage will by default use local storage. To change this behavior and to use non-local storage you have to use `force_cloud=True` argument in [`Actor.open_dataset`](../../reference/class/Actor#open_dataset), [`Actor.open_request_queue`](../../reference/class/Actor#open_request_queue) or [`Actor.open_key_value_store`](../../reference/class/Actor#open_key_value_store). Proper use of this argument allows you to work with both local and non-local storages.

### Local storage persistence

By default, the storage contents are persisted across multiple Actor runs. To clean up the Actor storages before the running the Actor, use the `--purge` flag of the [`apify run`](https://docs.apify.com/cli/docs/reference#apify-run) command of the Apify CLI.
Expand Down