2.2 KiB
title | seotitle | description | menu | weight | v2.0/tags | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Task configuration options | InfluxDB task configuration options | Task options define specific information about a task such as its name, the schedule on which it runs, execution delays, and others. |
|
105 |
|
Task options define specific information about a task. They are set in a Flux script or in the InfluxDB user interface (UI). The following task options are available:
{{% note %}}
every
and cron
are mutually exclusive, but at least one is required.
{{% /note %}}
name
The name of the task. Required.
Data type: String
options task = {
name: "taskName",
// ...
}
every
The interval at which the task runs.
Data type: Duration
options task = {
// ...
every: 1h,
}
{{% note %}} In the InfluxDB UI, the Interval field sets this option. {{% /note %}}
cron
The cron expression that defines the schedule on which the task runs. Cron scheduling is based on system time.
Data type: String
options task = {
// ...
cron: "0 * * * *",
}
offset
Delays the execution of the task but preserves the original time range.
For example, if a task is to run on the hour, a 10m
offset will delay it to 10
minutes after the hour, but all time ranges defined in the task are relative to
the specified execution time.
A common use case is offsetting execution to account for data that may arrive late.
Data type: Duration
options task = {
// ...
offset: "0 * * * *",
}
concurrency
The number task of executions that can run concurrently. If the concurrency limit is reached, all subsequent executions are queued until other running task executions complete.
Data type: Integer
options task = {
// ...
concurrency: 2,
}
retry
The number of times to retry the task before it is considered as having failed.
Data type: Integer
options task = {
// ...
retry: 2,
}