Documentation

influxdb3 test schedule_plugin

The influxdb3 test schedule_plugin command tests a schedule plugin. Use this command to verify plugin behavior without creating a trigger.

Usage

influxdb3 test schedule_plugin [OPTIONS] --database <DATABASE_NAME> <FILENAME>
  • Copy
  • Fill window

Arguments

  • FILENAME: Path to the plugin file. Use the absolute path or the path relative to the current working directory, such as <plugin-dir>/<plugin-file-name>.py.

Options

OptionFlagDescription
-H--hostURL of the running InfluxDB 3 Core server
(default: http://127.0.0.1:8181)
-d--database(Required) Name of the database you want to test the plugin against
--token(Required) Authentication token
--input-argumentsJSON map of key/value pairs to pass as plugin input arguments (for example, '{"key":"val"}')
--scheduleCron schedule to simulate when testing the plugin
(default: * * * * *)
--cache-nameOptional cache name to associate with the test
--tls-caPath to a custom TLS certificate authority for self-signed certs
-h--helpShow basic help information
--help-allShow all available help options

Option environment variables

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

Environment VariableCorresponding Option
INFLUXDB3_HOST_URL--host
INFLUXDB3_DATABASE_NAME--database
INFLUXDB3_AUTH_TOKEN--token
INFLUXDB3_TLS_CA--tls-ca

Examples

In the examples below, replace the following:

  • DATABASE_NAME: Your target database
  • AUTH_TOKEN: Your authentication token
  • PLUGIN_DIR: the path to the plugin directory you provided when starting the server
  • FILENAME: Plugin file name

Test a schedule plugin

influxdb3 test schedule_plugin \
  --database 
DATABASE
_NAME \
--token
AUTH_TOKEN
\
PLUGIN_DIR
/
FILENAME
.py
  • Copy
  • Fill window

Test with input arguments and a custom cron schedule

You can pass input arguments to your plugin as key-value pairs and specify a custom cron schedule (using Quartz cron syntax with six fields):

influxdb3 test schedule_plugin \
  --host http://localhost:8182 \
  --database 
DATABASE
_NAME \
--token
AUTH_TOKEN
\
--input-arguments threshold=10,unit=seconds \ --schedule "0 0 * * * ?" \
PLUGIN_DIR
/
FILENAME
.py
  • Copy
  • Fill window
  • Pass plugin parameters using --input-arguments as comma-separated key=value pairs.
  • Use --schedule to set the plugin’s execution time with a Quartz cron expression. For example, “0 0 * * * ?” runs the plugin at the start of every hour.

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

New in InfluxDB 3.2

Key enhancements in InfluxDB 3.2 and the InfluxDB 3 Explorer UI is now generally available.

See the Blog Post

InfluxDB 3.2 is now available for both Core and Enterprise, bringing the general availability of InfluxDB 3 Explorer, a new UI that simplifies how you query, explore, and visualize data. On top of that, InfluxDB 3.2 includes a wide range of performance improvements, feature updates, and bug fixes including automated data retention and more.

For more information, check out: