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>

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

Option environment variables

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

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

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

• 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.