Skip to content

Commit

Permalink
See pewresearch/pewresearch-org@7e4680b from refs/heads/release/5.0
Browse files Browse the repository at this point in the history
  • Loading branch information
prcdevgitbot committed Feb 6, 2024
1 parent eda9970 commit 7334e40
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions includes/action-scheduler/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,29 @@

Action Scheduler is a scalable, traceable job queue for background processing large queues of tasks in WordPress. It is designed for use cases where scheduling or offloading large numbers of tasks, actions, or processes is required.

### CLI:

PRC Platform ships with a fork of crstauf's action-scheduler-cli, to make it easier to manage scheduled actions from the command line. The CLI is a wrapper around the Action Scheduler API, and provides a number of commands to manage scheduled actions.

#### Commands:

|Command|Description|
|:--|:--|
|`ascli action cancel`|Cancels an existing scheduled action.|
|`ascli action create`|Creates a new scheduled action.|
|`ascli action delete`|Deletes scheduled action(s).|
|`ascli action generate`|Generates some scheduled actions.|
|`ascli action get`|Get details about a scheduled action.|
|`ascli action list`|Gets a list of scheduled actions.|
|`ascli action next`|Get the next scheduled action.|
|`ascli action run`|Run existing scheduled action.|
|`ascli system data-store`|Get current data store.|
|`ascli system runner`|Get current runner.|
|`ascli system runner disable`|Disable runner.|
|`ascli system runner enable`|Enable runner.|
|`ascli system status`|- List of actions according to status<br />- Active version<br />- Active data store class<br />- Active runner class|
|`ascli system version`|Lists active version(s).|

### Schedules:

PRC Platform comes with full support for Action Scheduler including some pre-built schedules for common tasks:
Expand Down

0 comments on commit 7334e40

Please sign in to comment.