influxdb3 create trigger

The influxdb3 create trigger command creates a new trigger for the processing engine.

Usage

influxdb3 create trigger [OPTIONS] \
  --database <DATABASE_NAME> \
  --token <AUTH_TOKEN> \
  --plugin-filename <PLUGIN_FILENAME> \
  --trigger-spec <TRIGGER_SPECIFICATION> \
  <TRIGGER_NAME>

Arguments

• TRIGGER_NAME: A name for the new trigger.

Options

If you want to use a plugin from the Plugin Library repo, use the url path with gh: specified as the prefix. For example, to use the System Metrics plugin, the plugin filename is gh:examples/schedule/system_metrics/system_metrics.py.

Option environment variables

You can use the following environment variables to set command options:

Examples

The following examples show how to use the influxdb3 create trigger command to create triggers in different scenarios.

• DATABASE_NAME: Database name
• AUTH_TOKEN: Authentication token
• PLUGIN_FILENAME: Python plugin filename
• TRIGGER_NAME: Name of the trigger to create
• TABLE_NAME: Name of the table to trigger on

Create a trigger for a specific table

Create a trigger that processes data from a specific table.

influxdb3 create trigger \
  --database 
DATABASE_NAME
 \
  --token 
AUTH_TOKEN
 \
  --plugin-filename PLUGIN_FILENAME \
  --trigger-spec table:
TABLE_NAME
 \
  
TRIGGER_NAME

Create a trigger for all tables

Create a trigger that applies to all tables in the specified database.

influxdb3 create trigger \
  --database 
DATABASE_NAME
 \
  --token 
AUTH_TOKEN
 \
  --plugin-filename <PLUGIN_FILENAME> \
  --trigger-spec all_tables \
  
TRIGGER_NAME

This is useful when you want a trigger to apply to any table in the database, regardless of name.

Create a disabled trigger

Create a trigger in a disabled state.

influxdb3 create trigger \
  --disabled \
  --database 
DATABASE_NAME
 \
  --token 
AUTH_TOKEN
 \
  --plugin-filename <PLUGIN_FILENAME> \
  --trigger-spec table:
TABLE_NAME
 \
  
TRIGGER_NAME

Creating a trigger in a disabled state prevents it from running immediately. You can enable it later when you’re ready to activate it.