Documentation

kapacitor define

The kapacitor define command creates or updates a task. A task is defined via a TICKscript that defines the data processing pipeline of the task.

When an existing task is updated, the task will be reloaded unless the -no-reload flag is included in the command.

Usage

kapacitor define [<task-id>] [flags]

Arguments

  • task-id: Unique identifier for the task

Flags

FlagDescriptionInput
-dbrpDatabase and retention policy to query (can be specified multiple times)"db"."rp" (double quotes are optional unless identifiers contain whitespace or special characters)
-filePath to a YAML or JSON template task fileFilepath
-no-reloadDo not reload the task even when enabled
-templateTemplate ID to use to create the taskTemplate ID
-tickPath to the TICKscript to use to create the taskFilepath
-typeTask typestream or batch
-varsPath to a JSON variables file when using a templateFilepath

Examples

Create a new task from a TICKscript

kapacitor define my_task \
  -dbrp mydb.myrp \
  -tick /path/to/TICKscript.tick \
  -type stream

Create a new task from a template

kapacitor define my_task \
  -dbrp mydb.myrp \
  -template alert_template \
  -vars /path/to/vars.json \  
  -type batch

Update the TICKscript of a task

kapacitor define existing_task \
  -tick /path/to/new_TICKscript.tick

Update a task without reloading the task

kapacitor define existing_task \
  -tick /path/to/new_TICKscript.tick \
  -no-reload

Update a task to query multiple DBRP combinations

If a task queries multiple database and retention policy (DBRP) combinations, to add more, you must include all existing DBRPs. Any existing DBRPs omitted from the command when updating a task are removed from the task.

kapacitor define existing_task \
  -dbrp mydb.myrp \
  -dbrp otherdb.default \
  -dbrp telegraf.autogen

Was this page helpful?

Thank you for your feedback!


The future of Flux

Flux is going into maintenance mode. You can continue using it as you currently are without any changes to your code.

Flux is going into maintenance mode and will not be supported in InfluxDB 3.0. This was a decision based on the broad demand for SQL and the continued growth and adoption of InfluxQL. We are continuing to support Flux for users in 1.x and 2.x so you can continue using it with no changes to your code. If you are interested in transitioning to InfluxDB 3.0 and want to future-proof your code, we suggest using InfluxQL.

For information about the future of Flux, see the following: