Documentation

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>
  • Copy
  • Fill window

Arguments

  • TRIGGER_NAME: A name for the new trigger.

Options

OptionDescription
-H--hostHost URL of the running InfluxDB 3 Enterprise server (default is http://127.0.0.1:8181)
-d--database(Required) Name of the database to operate on
--token(Required) Authentication token
--plugin-filename(Required) Name of the file, stored in the server’s plugin-dir, that contains the Python plugin code to run
--trigger-specTrigger specification–for example table:<TABLE_NAME> or all_tables
--disabledCreate the trigger in disabled state
--tls-caPath to a custom TLS certificate authority (for testing or self-signed certificates)
-h--helpPrint help information
--help-allPrint detailed help information

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:

Environment VariableOption
INFLUXDB3_HOST_URL--host
INFLUXDB3_DATABASE_NAME--database
INFLUXDB3_AUTH_TOKEN--token

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
  • Copy
  • Fill window

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
  • Copy
  • Fill window

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
  • Copy
  • Fill window

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


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.

Read more

Now Generally Available

InfluxDB 3 Core and Enterprise

Start fast. Scale faster.

Get the Updates

InfluxDB 3 Core is an open source, high-speed, recent-data engine that collects and processes data in real-time and persists it to local disk or object storage. InfluxDB 3 Enterprise builds on Core’s foundation, adding high availability, read replicas, enhanced security, and data compaction for faster queries and optimized storage. A free tier of InfluxDB 3 Enterprise is available for non-commercial at-home or hobbyist use.

For more information, check out: