CreateArchiveJobInput
Input for creating an archive job
nameString!Human-readable name for the job. Required.
descriptionStringOptional free-text note about what the job archives. Max 1000 characters.
slugString!URL-safe identifier matching [a-z0-9][a-z0-9-]*, unique per tenant, and used as the {slug} token of the key template.
TypeID (prefix sbk) of the storage backend to write to. Must already exist for the tenant.
cronExpressionString!Standard 5-field cron expression for the schedule. Rejected if it does not parse.
timezoneStringIANA timezone the cron expression is evaluated in (e.g. "Europe/Berlin"). Omit for UTC.
What to do when a tick fires while the previous run is still going. Defaults to SKIP.
scriptString!Lua source producing the rows to archive. Required and must be non-empty.
keyTemplateStringStorage key template; supports {slug}, {yyyy}, {mm}, {dd}, {yyyy-MM-dd}, {timestamp}, {executionId}. Defaults to {slug}/dt={yyyy-MM-dd}/run-{timestamp}.parquet.
Encoding of the archived output. Defaults to PARQUET.
isEnabledBooleanWhether the cron schedule starts out active. Defaults to true.
View exact SDL
"""Input for creating an archive job"""
input CreateArchiveJobInput {
"""Human-readable name for the job. Required."""
name: String!
"""
Optional free-text note about what the job archives. Max 1000 characters.
"""
description: String
"""
URL-safe identifier matching `[a-z0-9][a-z0-9-]*`, unique per tenant, and used as the `{slug}` token of the key template.
"""
slug: String!
"""
TypeID (prefix `sbk`) of the storage backend to write to. Must already exist for the tenant.
"""
storageBackendId: StorageBackendID!
"""
Standard 5-field cron expression for the schedule. Rejected if it does not parse.
"""
cronExpression: String!
"""
IANA timezone the cron expression is evaluated in (e.g. "Europe/Berlin"). Omit for UTC.
"""
timezone: String
"""
What to do when a tick fires while the previous run is still going. Defaults to SKIP.
"""
overlapPolicy: OverlapPolicy
"""
Lua source producing the rows to archive. Required and must be non-empty.
"""
script: String!
"""
Storage key template; supports `{slug}`, `{yyyy}`, `{mm}`, `{dd}`, `{yyyy-MM-dd}`, `{timestamp}`, `{executionId}`. Defaults to `{slug}/dt={yyyy-MM-dd}/run-{timestamp}.parquet`.
"""
keyTemplate: String
"""Encoding of the archived output. Defaults to PARQUET."""
outputFormat: ArchiveOutputFormat
"""Whether the cron schedule starts out active. Defaults to true."""
isEnabled: Boolean
}One stable address across all schema views. Follow a field’s type to explore connections between domains.