110 lines
2.1 KiB
Markdown
110 lines
2.1 KiB
Markdown
---
|
|
title: Task configuration options
|
|
seotitle: InfluxDB task configuration options
|
|
description: >
|
|
Task options define specific information about a task such as its name,
|
|
the schedule on which it runs, execution delays, and others.
|
|
menu:
|
|
v2_0:
|
|
name: Task options
|
|
parent: Process data
|
|
weight: 5
|
|
---
|
|
|
|
Task options define specific information about the task and are specified in your
|
|
Flux script or in the InfluxDB user interface (UI).
|
|
The following task options are available:
|
|
|
|
- [name](#name)
|
|
- [every](#every)
|
|
- [cron](#cron)
|
|
- [offset](#offset)
|
|
- [concurrency](#concurrency)
|
|
- [retry](#retry)
|
|
|
|
{{% note %}}
|
|
`every` and `cron` are mutually exclusive, but at least one is required.
|
|
{{% /note %}}
|
|
|
|
## name
|
|
The name of the task. _**Required**_.
|
|
|
|
_**Data type:** String_
|
|
|
|
```js
|
|
options task = {
|
|
name: "taskName",
|
|
// ...
|
|
}
|
|
```
|
|
|
|
## every
|
|
The interval at which the task runs.
|
|
|
|
_**Data type:** Duration_
|
|
|
|
_**Note:** In the InfluxDB UI, the **Interval** field sets this option_.
|
|
|
|
```js
|
|
options task = {
|
|
// ...
|
|
every: 1h,
|
|
}
|
|
```
|
|
|
|
## cron
|
|
The [cron expression](https://en.wikipedia.org/wiki/Cron#Overview) that
|
|
defines the schedule on which the task runs.
|
|
Cron scheduling is based on system time.
|
|
|
|
_**Data type:** String_
|
|
|
|
```js
|
|
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_
|
|
|
|
```js
|
|
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_
|
|
|
|
```js
|
|
options task = {
|
|
// ...
|
|
concurrency: 2,
|
|
}
|
|
```
|
|
|
|
## retry
|
|
The number of times to retry the task before it is considered as having failed.
|
|
|
|
_**Data type:** Integer_
|
|
|
|
```js
|
|
options task = {
|
|
// ...
|
|
retry: 2,
|
|
}
|
|
```
|