You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/guides/engine-plugins.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,11 +4,11 @@ Engine plugins let you use sqlc with databases that are not built-in. You can ad
4
4
5
5
## Why use an engine plugin?
6
6
7
-
- Use sqlc with a database that doesn’t have native support.
7
+
- Use sqlc with a database that doesn't have native support.
8
8
- Reuse an existing SQL parser or dialect in a separate binary.
9
9
- Keep engine-specific logic outside the sqlc core.
10
10
11
-
Data returned by the engine plugin (SQL text, parameters, columns) is passed through to [codegen plugins](../guides/plugins.md) without an extra compiler/AST step. The plugin is the single place that defines how queries are interpreted for that engine.
11
+
Data returned by the engine plugin (SQL text, parameters, columns) is passed through to [codegen plugins](plugins.md) without an extra compiler/AST step. The plugin is the single place that defines how queries are interpreted for that engine.
12
12
13
13
**Limitation:**`sqlc vet` does not support plugin engines. Use vet only with built-in engines (postgresql, mysql, sqlite).
- If the plugin builds, it matches this version of the engine API.
32
-
- If the API changes in a breaking way, the plugin stops compiling until it’s updated.
32
+
- If the API changes in a breaking way, the plugin stops compiling until it's updated.
33
33
34
34
No version handshake is required; the proto schema defines the contract.
35
35
@@ -156,7 +156,7 @@ A minimal engine that parses SQLite-style SQL and expands `*` using a schema is
156
156
157
157
## Architecture
158
158
159
-
For each `sql[]` block, `sqlc generate` branches on the configured engine: built-in (postgresql, mysql, sqlite) use the compiler and catalog; any engine listed under `engines:` in sqlc.yaml uses the plugin path (no compiler, schema + queries go to the plugin’s Parse RPC, then output goes to codegen).
159
+
For each `sql[]` block, `sqlc generate` branches on the configured engine: built-in (postgresql, mysql, sqlite) use the compiler and catalog; any engine listed under `engines:` in sqlc.yaml uses the plugin path (no compiler, schema + queries go to the plugin's Parse RPC, then output goes to codegen).
0 commit comments