document enterprise configuration options

enterprise3-config-options
Scott Anderson 2025-01-11 20:50:33 -07:00
parent 46a845c121
commit 30ed12dd1b
2 changed files with 1116 additions and 163 deletions

View File

@ -18,7 +18,7 @@ The `influxdb3 create plugin` command creates a new processing engine plugin.
```bash ```bash
influxdb3 create plugin [OPTIONS] \ influxdb3 create plugin [OPTIONS] \
--database <DATABASE_NAME> \ --database <DATABASE_NAME> \
--code-filename <CODE_FILE> \ --filename <PLUGIN_FILENAME> \
--entry-point <FUNCTION_NAME> \ --entry-point <FUNCTION_NAME> \
<PLUGIN_NAME> <PLUGIN_NAME>
``` ```
@ -29,15 +29,15 @@ influxdb3 create plugin [OPTIONS] \
## Options ## Options
| Option | | Description | | Option | | Description |
| :----- | :---------------- | :--------------------------------------------------------------------------------------- | | :----- | :-------------- | :--------------------------------------------------------------------------------------- |
| `-H` | `--host` | Host URL of the running {{< product-name >}} server (default is `http://127.0.0.1:8181`) | | `-H` | `--host` | Host URL of the running {{< product-name >}} server (default is `http://127.0.0.1:8181`) |
| `-d` | `--database` | _({{< req >}})_ Name of the database to operate on | | `-d` | `--database` | _({{< req >}})_ Name of the database to operate on |
| | `--token` | Authentication token | | | `--token` | Authentication token |
| | `--code-filename` | _({{< req >}})_ Python file containing the plugin code | | | `--filename` | _({{< req >}})_ Name of the plugin Python file in the plugin directory |
| | `--entry-point` | _({{< req >}})_ Entry point function name for the plugin | | | `--entry-point` | _({{< req >}})_ Entry point function name for the plugin |
| | `--plugin-type` | Type of trigger the plugin processes (default is `wal_rows`) | | | `--plugin-type` | Type of trigger the plugin processes (default is `wal_rows`) |
| `-h` | `--help` | Print help information | | `-h` | `--help` | Print help information |
### Option environment variables ### Option environment variables

File diff suppressed because it is too large Load Diff