Skip to content

Commit 78486df

Browse files
docs: Update changelog.md with some minor edits (#2235)
1 parent 5475990 commit 78486df

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

docs/reference/changelog.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,11 @@ work on Windows.
1818
To bridge that gap, we're announcing remote code generation, currently in
1919
private alpha. To join the private alpha, [sign up for the waitlist](https://docs.google.com/forms/d/e/1FAIpQLScDWrGtTgZWKt3mdlF5R2XCX6tL1pMkB4yuZx5yq684tTNN1Q/viewform?usp=sf_link).
2020

21-
To configure remote generation, configure a `cloud` block in `sqlc.json`.
21+
Remote code generation works like local code generation, except the heavy
22+
lifting is performed in a consistent cloud environment. WASM-based plugins are
23+
supported in the remote environment, but process-based plugins are not.
24+
25+
To configure remote generation, add a `cloud` block in `sqlc.json`.
2226

2327
```json
2428
{
@@ -31,15 +35,15 @@ To configure remote generation, configure a `cloud` block in `sqlc.json`.
3135
}
3236
```
3337

34-
You'll also need to the `SQLC_AUTH_TOKEN` environment variable.
38+
You'll also need to set the `SQLC_AUTH_TOKEN` environment variable.
3539

3640
```bash
3741
export SQLC_AUTH_TOKEN=<token>
3842
```
3943

40-
When the cloud configuration exists, `sqlc generate` will default to remote
41-
generation. If you'd like to generate code locally, pass the `--no-remote`
42-
option.
44+
When the `cloud` configuration block exists, `sqlc generate` will default to remote
45+
code generation. If you'd like to generate code locally without removing the `cloud`
46+
block from your config, pass the `--no-remote` option.
4347

4448

4549
```bash
@@ -53,7 +57,7 @@ Remote generation is off by default and requires an opt-in to use.
5357
_Developed by [@nickjackson](https://github.com/nickjackson)_
5458

5559
Embedding allows you to reuse existing model structs in more queries, resulting
56-
in less manual serilization work. First, imagine we have the following schema
60+
in less manual serialization work. First, imagine we have the following schema
5761
with students and test scores.
5862

5963

@@ -134,7 +138,7 @@ WHERE age IN (sqlc.slice("ages"))
134138
```
135139

136140
```go
137-
func (q *Queries) SelectStudents(ctx context.Context, arges []int32) ([]Student, error) {
141+
func (q *Queries) SelectStudents(ctx context.Context, ages []int32) ([]Student, error) {
138142
```
139143
140144
This feature is only supported in MySQL and cannot be used with prepared

0 commit comments

Comments
 (0)