-
Notifications
You must be signed in to change notification settings - Fork 778
Adds documentation for $ dapr scheduler
#4909
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.
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
base: v1.16
Are you sure you want to change the base?
Changes from all commits
d6bf973
5512bf2
5830c0b
ffc952a
4ca9f73
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -187,6 +187,66 @@ To use protobuf serialization for actor reminders on self-hosted, use the follow | |
| --max-api-level=20 | ||
| ``` | ||
|
|
||
| ## Managing reminders with the CLI | ||
JoshVanL marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| Actor reminders are persisted in the Scheduler. | ||
| You can manage them with the dapr scheduler CLI commands. | ||
|
|
||
| #### List actor reminders | ||
|
|
||
| ```bash | ||
| dapr scheduler list --filter actor | ||
| NAME BEGIN COUNT LAST TRIGGER | ||
| actor/MyActorType/actorid1/test1 -3.89s 1 2025-10-03T16:58:55Z | ||
| actor/MyActorType/actorid2/test2 -3.89s 1 2025-10-03T16:58:55Z | ||
| ``` | ||
|
|
||
| Get reminder details | ||
|
|
||
| ```bash | ||
| dapr scheduler get actor/MyActorType/actorid1/test1 -o yaml | ||
| ``` | ||
|
|
||
| #### Delete reminders | ||
|
|
||
| Delete a single reminder: | ||
|
|
||
| ```bash | ||
| dapr scheduler delete actor/MyActorType/actorid1/test1 | ||
| ``` | ||
|
|
||
| Delete all reminders for a given actor type: | ||
|
|
||
| ```bash | ||
| dapr scheduler delete-all actor/MyActorType | ||
| ``` | ||
|
|
||
| Delete all reminders for a specific actor instance: | ||
|
|
||
| ```bash | ||
| dapr scheduler delete-all actor/MyActorType/actorid1 | ||
| ``` | ||
|
|
||
| #### Backup and restore reminders | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. if we have all docs from the There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I hear you, however I think I prefer to still have this here too |
||
|
|
||
| Export all reminders: | ||
|
|
||
| ```bash | ||
| dapr scheduler export -o reminders-backup.bin | ||
| ``` | ||
|
|
||
| Restore from a backup file: | ||
|
|
||
| ```bash | ||
| dapr scheduler import -f reminders-backup.bin | ||
| ``` | ||
|
|
||
| #### Summary | ||
|
|
||
| - Reminders are stored in the Dapr Scheduler, not in the app. | ||
| - Create reminders via the Actors API | ||
| - Manage existing reminders (list, get, delete, backup/restore) using the `dapr scheduler` CLI. | ||
|
|
||
| ## Next steps | ||
|
|
||
| {{< button text="Configure actor runtime behavior >>" page="actors-runtime-config.md" >}} | ||
|
|
||
Uh oh!
There was an error while loading. Please reload this page.