Skip to content

Commit 2d31bdf

Browse files
committed
docs(schedule_plugin): add option environment variables table
1 parent 2895396 commit 2d31bdf

File tree

2 files changed

+55
-1
lines changed

2 files changed

+55
-1
lines changed

assets/jsconfig.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@
33
"baseUrl": ".",
44
"paths": {
55
"*": [
6-
"*"
6+
"*",
7+
"../node_modules/*"
78
]
89
}
910
}

content/shared/influxdb3-cli/test/schedule_plugin.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,56 @@
22
The `influxdb3 test schedule_plugin` command tests a schedule plugin.
33
Use this command to verify plugin behavior without creating a trigger.
44

5+
## Usage
6+
7+
<!--pytest.mark.skip-->
8+
9+
```bash
10+
influxdb3 test schedule_plugin [OPTIONS] --database <DATABASE_NAME> <FILENAME>
11+
```
12+
## Arguments
13+
14+
- **FileName**: Path to the local plugin file (usually ends in `.py`)
15+
16+
## Options
17+
18+
| Option | Flag | Description |
19+
| :----- | :----------------- | :--------------------------------------------------------------------------------------- |
20+
| `-H` | `--host` | Host URL of the running {{< product-name >}} server (default: `http://127.0.0.1:8181`) |
21+
| `-d` | `--database` | _({{< req >}})_ Name of the database to operate on |
22+
| | `--token` | _({{< req >}})_ Authentication token |
23+
| | `--tls-ca` | Path to a custom TLS certificate authority (for testing or self-signed certificates) |
24+
| `-h` | `--help` | Print help information |
25+
| | `--help-all` | Print detailed help information |
26+
27+
### Option environment variables
28+
29+
You can use the following environment variables to set command options:
30+
31+
| Environment Variable | Corresponding Option |
32+
| :------------------------ | :------------------- |
33+
| `INFLUXDB3_HOST_URL` | `--host` |
34+
| `INFLUXDB3_DATABASE_NAME` | `--database` |
35+
| `INFLUXDB3_AUTH_TOKEN` | `--token` |
36+
37+
## Examples
38+
39+
In the examples below, replace the following:
40+
41+
- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: Your target database
42+
- {{% code-placeholder-key %}}`AUTH_TOKEN`{{% /code-placeholder-key %}}: Your authentication token
43+
- {{% code-placeholder-key %}}`PLUGIN_FILENAME`{{% /code-placeholder-key %}}: Plugin filename (with path)
44+
45+
{{% code-placeholders "DATABASE_NAME|AUTH_TOKEN|PLUGIN_FILENAME" %}}
46+
47+
## Test a schedule plugin
48+
49+
<!--pytest.mark.skip-->
50+
51+
```bash
52+
influxdb3 test schedule_plugin \
53+
--database DATABASE_NAME \
54+
--token AUTH_TOKEN \
55+
PLUGIN_FILENAME.py
56+
```
57+
{{% /code-placeholders %}}

0 commit comments

Comments
 (0)