← API reference
CANONICAL TYPE REFERENCE

ArchiveExecutionStatus

Lifecycle of one archive run. PENDING = row inserted, job queued but not picked up; RUNNING = the worker is executing the script; SUCCEEDED = the script finished and (unless it produced zero rows) the output was uploaded; FAILED = the script or the upload threw, see errorMessage; SKIPPED = the scheduler declined to start this run because a previous run was still open and the job's overlap policy is SKIP; CANCELLED = an open run was superseded by a new scheduled run under the CANCEL overlap policy. SUCCEEDED, FAILED, SKIPPED and CANCELLED are terminal.

PENDING

The row has been inserted and the job queued, but no worker has picked it up yet.

RUNNING

A worker has claimed the run and is executing the tenant's archive script.

SUCCEEDED

The script finished and, unless it produced zero rows, its output was uploaded to the job's storage backend. Terminal, and the only status that persists a new checkpoint.

FAILED

The script or the upload threw; errorMessage carries the reason and the previous run's checkpoint is left in place. Terminal.

SKIPPED

The scheduler declined to start this run because a previous run was still open and the job's overlap policy is SKIP, so the script never ran. Terminal.

CANCELLED

An open run was superseded by a newly-due scheduled run under the CANCEL overlap policy. Terminal.

View exact SDL
"""
Lifecycle of one archive run. PENDING = row inserted, job queued but not picked up; RUNNING = the worker is executing the script; SUCCEEDED = the script finished and (unless it produced zero rows) the output was uploaded; FAILED = the script or the upload threw, see errorMessage; SKIPPED = the scheduler declined to start this run because a previous run was still open and the job's overlap policy is SKIP; CANCELLED = an open run was superseded by a new scheduled run under the CANCEL overlap policy. SUCCEEDED, FAILED, SKIPPED and CANCELLED are terminal.
"""
enum ArchiveExecutionStatus {
  """
  The row has been inserted and the job queued, but no worker has picked it up yet.
  """
  PENDING
  """
  A worker has claimed the run and is executing the tenant's archive script.
  """
  RUNNING
  """
  The script finished and, unless it produced zero rows, its output was uploaded to the job's storage backend. Terminal, and the only status that persists a new checkpoint.
  """
  SUCCEEDED
  """
  The script or the upload threw; errorMessage carries the reason and the previous run's checkpoint is left in place. Terminal.
  """
  FAILED
  """
  The scheduler declined to start this run because a previous run was still open and the job's overlap policy is SKIP, so the script never ran. Terminal.
  """
  SKIPPED
  """
  An open run was superseded by a newly-due scheduled run under the CANCEL overlap policy. Terminal.
  """
  CANCELLED
}

One stable address across all schema views. Follow a field’s type to explore connections between domains.