Skip to content

Commit 61f1758

Browse files
authored
docs: Add 1.15 changelog (#1783)
* docs: Add 1.15 changelog Also add a first-pass at WASM codegen docs * docs: Fix typo
1 parent 98e2c76 commit 61f1758

File tree

2 files changed

+100
-12
lines changed

2 files changed

+100
-12
lines changed

docs/guides/plugins.md

+51-12
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,58 @@
11
# Authoring plugins
22

3+
To use plugins, you must be using [Version 2](../reference/config.html) of
4+
the configuration file. The top-level `plugins` array defines the available
5+
plugins.
6+
7+
## WASM plugins
8+
9+
> WASM plugins are fully sandboxed. Plugins do not have access to the network,
10+
> filesystem, or environment variables.
11+
12+
In the `codegen` section, the `out` field dictates what directory will contain
13+
the new files. The `plugin` key must reference a plugin defined in the
14+
top-level `plugins` map. The `options` are serialized to a string and passed on
15+
to the plugin itself.
16+
17+
18+
```json
19+
{
20+
"version": "2",
21+
"plugins": [
22+
{
23+
"name": "greeter",
24+
"wasm": {
25+
"url": "https://github.com/kyleconroy/sqlc-gen-greeter/releases/download/v0.1.0/sqlc-gen-greeter.wasm",
26+
"sha256": "afc486dac2068d741d7a4110146559d12a013fd0286f42a2fc7dcd802424ad07"
27+
}
28+
}
29+
],
30+
"sql": [
31+
{
32+
"schema": "schema.sql",
33+
"queries": "query.sql",
34+
"engine": "postgresql",
35+
"codegen": [
36+
{
37+
"out": "gen",
38+
"plugin": "greeter"
39+
}
40+
]
41+
}
42+
]
43+
}
44+
```
45+
46+
For a complete working example see the following files:
47+
- [sqlc-gen-greeter](https://github.com/kyleconroy/sqlc-gen-greeter)
48+
- A WASM plugin (written in Rust) that outputs a friendly message
49+
- [wasm_plugin_sqlc_gen_greeter](https://github.com/kyleconroy/sqlc/tree/main/internal/endtoend/testdata/wasm_plugin_sqlc_gen_greeter)
50+
- An example project showing how to use a WASM plugin
51+
352
## Process plugins
453

5-
To use process-based plugins, you must be using [Version
6-
2](../reference/config.html) of the configuration file. The top-level `plugins`
7-
array defines the available plugins and maps them to an executable on the system.
54+
> Process-based plugins offer minimal security. Only use plugins that you
55+
> trust. Better yet, only use plugins that you've written yourself.
856
957
In the `codegen` section, the `out` field dictates what directory will contain
1058
the new files. The `plugin` key must reference a plugin defined in the
@@ -47,12 +95,3 @@ For a complete working example see the following files:
4795
- A process-based plugin that serializes the CodeGenRequest to JSON
4896
- [process_plugin_sqlc_gen_json](https://github.com/kyleconroy/sqlc/tree/main/internal/endtoend/testdata/process_plugin_sqlc_gen_json)
4997
- An example project showing how to use a process-based plugin
50-
51-
### Security
52-
53-
Process-based plugins offer minimal security. Only use plugins that you trust.
54-
Better yet, only use plugins that you've written yourself.
55-
56-
## WASM plugins
57-
58-
*Coming soon!*

docs/reference/changelog.md

+49
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,55 @@
11
# Changelog
22
All notable changes to this project will be documented in this file.
33

4+
## [1.15.0](https://github.com/kyleconroy/sqlc/releases/tag/1.15.0)
5+
Released 2022-08-07
6+
7+
### Bug Fixes
8+
9+
- (mysql) Typo (#1700)
10+
- (postgresql) Add quotes for CamelCase columns (#1729)
11+
- Cannot parse SQLite upsert statement (#1732)
12+
- (sqlite) Regenerate test output for builtins (#1735)
13+
- (wasm) Version modules by wasmtime version (#1734)
14+
- Missing imports (#1637)
15+
- Missing slice import for querier (#1773)
16+
17+
### Documentation
18+
19+
- Add process-based plugin docs (#1669)
20+
- Add links to downloads.sqlc.dev (#1681)
21+
- Update transactions how to example (#1775)
22+
23+
### Features
24+
25+
- More SQL Syntax Support for SQLite (#1687)
26+
- (sqlite) Promote SQLite support to beta (#1699)
27+
- Codegen plugins, powered by WASM (#1684)
28+
- Set user-agent for plugin downloads (#1707)
29+
- Null enums types (#1485)
30+
- (sqlite) Support stdlib functions (#1712)
31+
- (sqlite) Add support for returning (#1741)
32+
33+
### Miscellaneous Tasks
34+
35+
- Add tests for quoting columns (#1733)
36+
- Remove catalog tests (#1762)
37+
38+
### Testing
39+
40+
- Add tests for fixing slice imports (#1736)
41+
- Add test cases for returning (#1737)
42+
43+
### Build
44+
45+
- Upgrade to Go 1.19 (#1780)
46+
- Upgrade to go-wasmtime 0.39.0 (#1781)
47+
48+
### Plugins
49+
50+
- (wasm) Change default cache location (#1709)
51+
- (wasm) Change the SHA-256 config key (#1710)
52+
453
## [1.14.0](https://github.com/kyleconroy/sqlc/releases/tag/1.14.0)
554
Released 2022-06-09
655

0 commit comments

Comments
 (0)