Skip to content

Commit 7800a42

Browse files
committed
move md doc
1 parent 0f81f5d commit 7800a42

File tree

3 files changed

+7
-7
lines changed

3 files changed

+7
-7
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Additional languages can be added via [plugins](https://docs.sqlc.dev/en/latest/
3535
- MySQL
3636
- SQLite
3737

38-
Additional database engines can be added via [engine plugins](https://docs.sqlc.dev/en/latest/howto/engine-plugins.html).
38+
Additional database engines can be added via [engine plugins](https://docs.sqlc.dev/en/latest/guides/engine-plugins.html).
3939

4040
## Sponsors
4141

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ Engine plugins let you use sqlc with databases that are not built-in. You can ad
44

55
## Why use an engine plugin?
66

7-
- Use sqlc with a database that doesnt have native support.
7+
- Use sqlc with a database that doesn't have native support.
88
- Reuse an existing SQL parser or dialect in a separate binary.
99
- Keep engine-specific logic outside the sqlc core.
1010

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.
1212

1313
**Limitation:** `sqlc vet` does not support plugin engines. Use vet only with built-in engines (postgresql, mysql, sqlite).
1414

@@ -29,7 +29,7 @@ import "github.com/sqlc-dev/sqlc/pkg/engine"
2929
```
3030

3131
- 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 its updated.
32+
- If the API changes in a breaking way, the plugin stops compiling until it's updated.
3333

3434
No version handshake is required; the proto schema defines the contract.
3535

@@ -156,7 +156,7 @@ A minimal engine that parses SQLite-style SQL and expands `*` using a schema is
156156

157157
## Architecture
158158

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 plugins 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).
160160

161161
```
162162
┌─────────────────────────────────────────────────────────────────┐
@@ -174,6 +174,6 @@ For each `sql[]` block, `sqlc generate` branches on the configured engine: built
174174

175175
## See also
176176

177-
- [Codegen plugins](../guides/plugins.md) — Custom code generators that consume engine output.
177+
- [Codegen plugins](plugins.md) — Custom code generators that consume engine output.
178178
- [Configuration reference](../reference/config.md)
179179
- Proto schema: `protos/engine/engine.proto`

docs/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,6 @@ code ever again.
6666
howto/embedding.md
6767
howto/overrides.md
6868
howto/rename.md
69-
howto/engine-plugins.md
7069

7170
.. toctree::
7271
:maxdepth: 3
@@ -97,5 +96,6 @@ code ever again.
9796
howto/ci-cd.md
9897
guides/using-go-and-pgx.rst
9998
guides/plugins.md
99+
guides/engine-plugins.md
100100
guides/development.md
101101
guides/privacy.md

0 commit comments

Comments
 (0)