Documentation

kapacitor define-template

The kapacitor define-template command creates or updates a template. A template is defined using a TICKscript that contains the data processing pipeline of the template.

Updating a template reloads all associated tasks.

Usage

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

Arguments

  • template-id: Unique identifier for the template

Flags

FlagDescription
-tickTICKscript filepath
-typeTemplate type (stream or batch)

Examples

Create a new template for stream tasks

When creating a new template, you must provide a template ID, TICKscript, and template type.

kapacitor define-template my-template \
  -tick /path/to/TICKscript.tick \
  -type stream

Create a new template for batch tasks

When creating a new template, you must provide a template ID, TICKscript, and template type.

kapacitor define-template my-template \
  -tick /path/to/TICKscript.tick \
  -type batch

Update a template’s TICKscript

kapacitor define-template existing-template \
  -tick /path/to/new_TICKscript.tick 

Update a template’s type

kapacitor define-template existing-template -type batch

Was this page helpful?

Thank you for your feedback!


Introducing InfluxDB Clustered

A highly available InfluxDB 3.0 cluster on your own infrastructure.

InfluxDB Clustered is a highly available InfluxDB 3.0 cluster built for high write and query workloads on your own infrastructure.

InfluxDB Clustered is currently in limited availability and is only available to a limited group of InfluxData customers. If interested in being part of the limited access group, please contact the InfluxData Sales team.

Learn more
Contact InfluxData Sales

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:

State of the InfluxDB Cloud Serverless documentation

InfluxDB Cloud Serverless documentation is a work in progress.

The new documentation for InfluxDB Cloud Serverless is a work in progress. We are adding new information and content almost daily. Thank you for your patience!

If there is specific information you’re looking for, please submit a documentation issue.