Skip to content

Commit 2d380ea

Browse files
committed
docs: schedule_plugin test command docs with input args, cron syntax, and troubleshooting
1 parent 8f13594 commit 2d380ea

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

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

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,15 +65,20 @@ influxdb3 test schedule_plugin \
6565

6666
### Test with input arguments and a custom cron schedule
6767

68+
You can pass input arguments to your plugin as key-value pairs and specify a custom cron schedule (using Quartz cron syntax with six fields):
69+
6870
<!--pytest.mark.skip-->
6971

7072
```bash
7173
influxdb3 test schedule_plugin \
74+
--host http://localhost:8182 \
7275
--database DATABASE_NAME \
7376
--token AUTH_TOKEN \
74-
--input-arguments '{"threshold": "10", "unit": "seconds"}' \
75-
--schedule "0 * * * *" \
77+
--input-arguments threshold=10,unit=seconds \
78+
--schedule "0 0 * * * ?" \
7679
PLUGIN_DIR/FILENAME.py
7780
```
81+
- `--input-arguments` accepts comma-separated key=value pairs.
82+
- `--schedule` expects a Quartz cron expression; e.g., "0 0 * * * ?" runs at the top of every hour.
7883

7984
{{% /code-placeholders %}}

0 commit comments

Comments
 (0)