Resource
archive_job
A scheduled, Lua-driven archive job: it runs a script on a cron schedule and writes the resulting rows to a storage backend under a rendered key.
Configuration
nameString!RequiredHuman-readable name for the job. Required.
descriptionStringOptionalOptional free-text note about what the job archives. Max 1000 characters.
slugString!RequiredURL-safe identifier matching [a-z0-9][a-z0-9-]*, unique per tenant, and used as the {slug} token of the key template.
storageBackendIdStorageBackendID!RequiredTypeID (prefix sbk) of the storage backend to write to. Must already exist for the tenant.
References storage_backend
cronExpressionString!RequiredStandard 5-field cron expression for the schedule. Rejected if it does not parse.
timezoneStringOptionalIANA timezone the cron expression is evaluated in (e.g. "Europe/Berlin"). Omit for UTC.
overlapPolicyOverlapPolicy!OptionalWhat to do when a tick fires while the previous run is still going. Defaults to SKIP.
Allowed values
ALLOW — Allow overlapping CRON executions
SKIP — Skip if previous execution still running
CANCEL — Cancel previous and start new
scriptString!RequiredLua source producing the rows to archive. Required and must be non-empty.
keyTemplateString!OptionalStorage key template; supports {slug}, {yyyy}, {mm}, {dd}, {yyyy-MM-dd}, {timestamp}, {executionId}. Defaults to {slug}/dt={yyyy-MM-dd}/run-{timestamp}.parquet.
outputFormatArchiveOutputFormat!OptionalEncoding of the archived output. Defaults to PARQUET.
Allowed values
PARQUET — Apache Parquet — typed, columnar, DuckDB-friendly. Default.
CSV — RFC 4180 CSV with UTF-8 BOM. For Excel / Power BI. Schema must be scalars only.
isEnabledBoolean!OptionalWhether the cron schedule starts out active. Defaults to true.
Read-only values
Show values
idArchiveJobID!Read onlyTypeID of this archive job, prefix arj (e.g. "arj_01K…").
computed by the platform
tenantIdTenantID!Read onlyTypeID of the owning tenant, prefix ten. All lookups are scoped to it.
computed by the platform
createdAtString!Read onlyISO8601 timestamp of when the job was created.
computed by the platform
updatedAtString!Read onlyISO8601 timestamp of the last change to the job's definition. Equals createdAt if never edited.
computed by the platform
Lifecycle
The CLI can create this resource. The platform assigns its id.
When replacement is needed, the existing resource is removed before its replacement is created.