Skip to content

Commit fd1c9dc

Browse files
committed
docs: adding test schedule plugin example
1 parent d0fad98 commit fd1c9dc

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

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

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11

2-
The `influxdb3 test schedule_plugin` command tests a schedule plugin.
3-
Use this command to verify plugin behavior without creating a trigger.
2+
The `influxdb3 test schedule_plugin` command tests a schedule plugin. Use this command to verify plugin behavior without creating a trigger.
43

54
## Usage
65

@@ -11,7 +10,7 @@ influxdb3 test schedule_plugin [OPTIONS] --database <DATABASE_NAME> <FILENAME>
1110
```
1211
## Arguments
1312

14-
- **FileName**: Path to the local plugin file (usually ends in `.py`)
13+
- **PLUGIN_NAME**: Path to the plugin file on the server. Use the full relative path, such as `<plugin-dir>/<plugin-file-name>.py`.
1514

1615
## Options
1716

@@ -40,9 +39,12 @@ In the examples below, replace the following:
4039

4140
- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: Your target database
4241
- {{% code-placeholder-key %}}`AUTH_TOKEN`{{% /code-placeholder-key %}}: Your authentication token
43-
- {{% code-placeholder-key %}}`PLUGIN_FILENAME`{{% /code-placeholder-key %}}: Plugin filename (with path)
42+
- {{% code-placeholder-key %}}`PLUGIN_DIR`{{% /code-placeholder-key %}}:
43+
Plugin directory name
44+
- {{% code-placeholder-key %}}`PLUGIN_NAME`{{% /code-placeholder-key %}}:
45+
Plugin file name
4446

45-
{{% code-placeholders "DATABASE_NAME|AUTH_TOKEN|PLUGIN_FILENAME" %}}
47+
{{% code-placeholders "(DATABASE|PLUGIN)_(NAME|DIR)|AUTH_TOKEN" %}}
4648

4749
### Test a schedule plugin
4850

@@ -52,7 +54,7 @@ In the examples below, replace the following:
5254
influxdb3 test schedule_plugin \
5355
--database DATABASE_NAME \
5456
--token AUTH_TOKEN \
55-
PLUGIN_FILENAME.py
57+
PLUGIN_DIR/PLUGIN_NAME.py
5658
```
57-
{{% /code-placeholders %}}
5859

60+
{{% /code-placeholders %}}

0 commit comments

Comments
 (0)