influxdb3 create plugin
InfluxDB 3 Core is in Public Alpha
InfluxDB 3 Core is in public alpha and available for testing and feedback, but is not meant for production use. Both the product and this documentation are works in progress. We welcome and encourage your input about your experience with the alpha and invite you to join our public channels for updates and to share feedback.
The influxdb3 create plugin command creates a new processing engine plugin.
Usage
influxdb3 create plugin [OPTIONS] \
--database <DATABASE_NAME> \
--filename <PLUGIN_FILENAME> \
--entry-point <FUNCTION_NAME> \
<PLUGIN_NAME>
Arguments
- PLUGIN_NAME: The name of the plugin to create.
Options
| Option | Description | |
|---|---|---|
-H | --host | Host URL of the running InfluxDB 3 Core server (default is http://127.0.0.1:8181) |
-d | --database | (Required) Name of the database to operate on |
--token | Authentication token | |
--filename | (Required) Name of the plugin Python file in the plugin directory | |
--entry-point | (Required) Entry point function name for the plugin | |
--plugin-type | Type of trigger the plugin processes (default is wal_rows) | |
-h | --help | Print help information |
Option environment variables
You can use the following environment variables to set command options:
| Environment Variable | Option |
|---|---|
INFLUXDB3_HOST_URL | --host |
INFLUXDB3_DATABASE_NAME | --database |
INFLUXDB3_AUTH_TOKEN | --token |
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.