Skip to content

Commit 6a5aeb3

Browse files
committed
fix: Processing engine description.
1 parent d8d1d09 commit 6a5aeb3

File tree

1 file changed

+9
-15
lines changed

1 file changed

+9
-15
lines changed

content/shared/v3-core-plugins/_index.md

Lines changed: 9 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,7 @@ To enable the Processing engine, start the {{% product-name %}} server with the
4242
influxdb3 serve --node-id node0 --object-store [OBJECT STORE TYPE] --plugin-dir /path/to/plugins
4343
```
4444

45-
46-
47-
## The Shared API
45+
## Shared API
4846

4947
All plugin types provide the InfluxDB 3 _shared API_ for interacting with the database.
5048
The shared API provides access to the following:
@@ -399,21 +397,17 @@ def process_request(influxdb3_local, query_parameters, request_headers, request_
399397

400398
#### On Request trigger configuration
401399

402-
**On Request** plugins are defined using the `request:<endpoint>` trigger-spec.
403-
404-
For example, the following command creates an `/api/v3/engine/my_plugin` endpoint that runs a `<plugin-directory>/examples/my-on-request.py` plugin:
400+
On Request plugins are defined using the `request:<endpoint>` trigger-spec.
401+
For example, the following `influxdb3` CLI command creates an `/api/v3/engine/my-plugin` HTTP endpoint
402+
to execute the `<plugin-directory>/examples/my-on-request.py` plugin:
405403

406404
```bash
407405
influxdb3 create trigger \
408-
--trigger-spec "request:my_plugin" \
406+
--trigger-spec "request:my-plugin" \
409407
--plugin-filename "examples/my-on-request.py" \
410408
--database mydb my-plugin
411409

412-
Because all On Request plugins share the same root URL, trigger specs must be unique across all plugins configured for a server, regardless of which database they are associated with.
413-
414-
```shell
415-
influxdb3 create trigger \
416-
--trigger-spec "request:hello-world" \
417-
--plugin-filename "hello/hello_world.py" \
418-
--database mydb hello-world
419-
```
410+
Because all On Request plugins for a server share the same `<host>/api/v3/engine/` base URL ,
411+
the trigger-spec
412+
you define must be unique across all plugins configured for a server,
413+
regardless of which database they are associated with.

0 commit comments

Comments
 (0)