Skip to content

Jobs

Jobs are long-running server-side operations that Chronicle executes asynchronously. Common examples include observer replays, index rebuilds, and partition recovery operations. Chronicle tracks each job’s progress, individual steps, and final status. Jobs may be stopped, resumed, and inspected while they are running or after they complete.

Lists all jobs in the specified event store and namespace, including both running and completed jobs.

Terminal window
cratis chronicle jobs list
FlagDescription
-e, --event-store <NAME>Event store to inspect. Defaults to default.
-n, --namespace <NAME>Namespace to inspect. Defaults to Default.

List all jobs:

Terminal window
cratis chronicle jobs list

List jobs in plain format:

Terminal window
cratis chronicle jobs list --output plain

Get job IDs for scripting:

Terminal window
cratis chronicle jobs list -q

Shows full details for a single job, including all steps, their individual progress, and any error information.

Terminal window
cratis chronicle jobs get <JOB_ID>
ArgumentDescription
JOB_IDThe GUID of the job. Use jobs list -q to retrieve job IDs.
FlagDescription
-e, --event-store <NAME>Event store to inspect. Defaults to default.
-n, --namespace <NAME>Namespace to inspect. Defaults to Default.

Show job details:

Terminal window
cratis chronicle jobs get a1b2c3d4-e5f6-7890-abcd-ef1234567890

Get the full job document as JSON:

Terminal window
cratis chronicle jobs get a1b2c3d4-e5f6-7890-abcd-ef1234567890 -o json

Resumes a stopped or failed job, allowing it to continue from where it left off.

Terminal window
cratis chronicle jobs resume <JOB_ID>
ArgumentDescription
JOB_IDThe GUID of the job to resume.
FlagDescription
-e, --event-store <NAME>Event store. Defaults to default.
-n, --namespace <NAME>Namespace. Defaults to Default.

Resume a stopped job:

Terminal window
cratis chronicle jobs resume a1b2c3d4-e5f6-7890-abcd-ef1234567890

Stops a running job. The job’s progress is preserved and the job can be resumed later.

Terminal window
cratis chronicle jobs stop <JOB_ID>
ArgumentDescription
JOB_IDThe GUID of the job to stop.
FlagDescription
-e, --event-store <NAME>Event store. Defaults to default.
-n, --namespace <NAME>Namespace. Defaults to Default.

Stop a running job:

Terminal window
cratis chronicle jobs stop a1b2c3d4-e5f6-7890-abcd-ef1234567890

Check the job status after stopping:

Terminal window
cratis chronicle jobs get a1b2c3d4-e5f6-7890-abcd-ef1234567890 -o json