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 | Flag | Description |
|---|---|---|
-H | --host | URL 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-arguments | JSON map of key/value pairs to pass as plugin input arguments (for example, '{"key":"val"}') | |
--schedule | Cron schedule to simulate when testing the plugin (default: * * * * *) | |
--cache-name | Optional cache name to associate with the test | |
--tls-ca | Path to a custom TLS certificate authority for self-signed certs | |
-h | --help | Show basic help information |
--help-all | Show all available help options |
Option environment variables
You can use the following environment variables to set command options:
| Environment Variable | Corresponding 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 databaseAUTH_TOKEN: Your authentication tokenPLUGIN_DIR: the path to the plugin directory you provided when starting the serverFILENAME: 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-argumentsas comma-separated key=value pairs. - Use
--scheduleto 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!
Support and feedback
Thank you for being part of our community! We welcome and encourage your feedback and bug reports for InfluxDB 3 Core and this documentation. To find support, use the following resources:
Customers with an annual or support contract can contact InfluxData Support. Customers using a trial license can email trial@influxdata.com for assistance.