Skip to content

Commit 2f48010

Browse files
committed
fix doc
1 parent a6a4bdb commit 2f48010

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

docs/guides/engine-plugins.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,9 @@ version: "2"
4343
engines:
4444
- name: external-db
4545
process:
46-
cmd: sqlc-engine-external-db
46+
# Executable and optional arguments (e.g. --dont-open-wildcard-star).
47+
# First token is the command; the rest are passed to the plugin before the RPC method name.
48+
cmd: sqlc-engine-external-db --dont-open-wildcard-star
4749
env:
4850
- EXTERNAL_DB_DSN
4951

@@ -61,7 +63,7 @@ sql:
6163
| Field | Description |
6264
|-------|-------------|
6365
| `name` | Engine name used in `sql[].engine` |
64-
| `process.cmd` | Command to run (PATH or absolute path) |
66+
| `process.cmd` | Command to run: executable path and optional arguments (e.g. `sqlc-engine-external-db --dont-open-wildcard-star`). First token is the executable; remaining tokens are passed as arguments before the RPC method. |
6567
| `env` | Environment variable names passed to the plugin |
6668

6769
Each engine must define either `process` (with `cmd`) or `wasm` (with `url` and `sha256`). See [Configuration reference](../reference/config.md) for the full `engines` schema.

0 commit comments

Comments
 (0)