docs-v2

2.9 KiB

Raw Permalink Blame History

The influxdb3 show plugins command lists loaded Processing Engine plugins in your {{< product-name >}} server.

Usage

influxdb3 show plugins [OPTIONS]

Options

Option		Description
`-H`	`--host`	Host URL of the running {{< product-name >}} server (default is `http://127.0.0.1:8181`)
	`--token`	({{< req >}}) Authentication token
	`--format`	Output format (`pretty` (default), `json`, `jsonl`, `csv`, or `parquet`)
	`--output`	Path where to save output when using the `parquet` format
	`--tls-ca`	Path to a custom TLS certificate authority (for testing or self-signed certificates)
`-h`	`--help`	Print help information
	`--help-all`	Print detailed help information

Option environment variables

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

Environment Variable	Option
`INFLUXDB3_HOST_URL`	`--host`
`INFLUXDB3_AUTH_TOKEN`	`--token`

Output

The command returns information about loaded plugin files:

plugin_name: Name of a trigger using this plugin
file_name: Plugin filename
file_path: Full server path to the plugin file
size_bytes: File size in bytes
last_modified: Last modification timestamp (milliseconds since epoch)

!Note]
This command queries the `system.plugin_files` table in the `_internal` database.
For more advanced queries and filtering, see [Query system data](/influxdb3/version/admin/query-system-data/).

List all plugins

influxdb3 show plugins

List plugins in different output formats

You can specify the output format using the --format option:

# JSON format
influxdb3 show plugins --format json

# JSON Lines format
influxdb3 show plugins --format jsonl

# CSV format
influxdb3 show plugins --format csv

Output plugins to a Parquet file

Parquet is a binary format. Use the --output option to specify the file where you want to save the Parquet data.

influxdb3 show plugins \
  --format parquet \
  --output /Users/me/plugins.parquet

2.9 KiB Raw Permalink Blame History