Merge remote-tracking branch 'upstream/master' into kotlin

Author: mightyguava

.github/workflows/equinox.yml

@@ -21,7 +21,7 @@ jobs:
       env:
         EQUINOX_API_TOKEN: ${{ secrets.EQUINOX_API_TOKEN }}
         EQUINOX_SIGNING_KEY: ${{ secrets.EQUINOX_SIGNING_KEY }}
-      run: equinox release --channel devel --version=$GITHUB_SHA --draft --platforms=darwin_amd64 --app=app_i4iCp1SuYfZ --token=$EQUINOX_API_TOKEN ./cmd/sqlc
+      run: go run scripts/release.go -draft devel darwin_amd64
 
   linux:
     name: Build on Linux
@@ -39,6 +39,6 @@ jobs:
       env:
         EQUINOX_API_TOKEN: ${{ secrets.EQUINOX_API_TOKEN }}
         EQUINOX_SIGNING_KEY: ${{ secrets.EQUINOX_SIGNING_KEY }}
-      run: ./equinox release --channel devel --version=$GITHUB_SHA --platforms=linux_amd64 --app=app_i4iCp1SuYfZ --token=$EQUINOX_API_TOKEN ./cmd/sqlc
+      run: go run scripts/release.go devel linux_amd64
 
 

README.md

@@ -1,13 +1,3 @@
-> 🚨
->
-> sqlc is **new** and under rapid development.
->
-> The code it generates is correct and safe for production use, but there is
-> currently no guarantee of stability or backwards-compatibility of the command
-> line interface, configuration file format or generated code.
->
-> 🚨
-
 # sqlc: A SQL Compiler
 
 > And lo, the Great One looked down upon the people and proclaimed:
@@ -232,6 +222,7 @@ Your favorite PostgreSQL / Go features are supported:
   - [Query annotations](./docs/annotations.md)
   - [Transactions](./docs/transactions.md)
   - [Prepared queries](./docs/prepared_query.md)
+  - [Named parameters](./docs/named_parameters.md)
   - [SELECT](./docs/query_one.md)
   - [NULL](./docs/null.md)
   - [COUNT](./docs/query_count.md)
@@ -265,7 +256,7 @@ Available Commands:
   compile     Statically check SQL for syntax and type errors
   generate    Generate Go code from SQL
   help        Help about any command
-  init        Create an empty sqlc.json settings file
+  init        Create an empty sqlc.yaml settings file
   version     Print the sqlc version number
 
 Flags:
@@ -276,24 +267,19 @@ Use "sqlc [command] --help" for more information about a command.
 
 ## Settings
 
-The `sqlc` tool is configured via a `sqlc.json` file. This file must be
+The `sqlc` tool is configured via a `sqlc.yaml` file. This file must be
 in the directory where the `sqlc` command is run.
 
-```json
-{
-  "version": "1",
-  "packages": [
-    {
-      "name": "db",
-      "emit_json_tags": true,
-      "emit_prepared_queries": false,
-      "emit_interface": true,
-      "path": "internal/db",
-      "queries": "./sql/query/",
-      "schema": "./sql/schema/"
-    }
-  ]
-}
+```yaml
+version: "1"
+packages:
+  - name: "db",
+    emit_json_tags: true
+    emit_prepared_queries: false
+    emit_interface: true
+    path: "internal/db"
+    queries: "./sql/query/"
+    schema: "./sql/schema/"
 ```
 
 Each package document has the following keys:
@@ -324,17 +310,12 @@ If a different Go package for UUIDs is required, specify the package in the
 `overrides` array. In this case, I'm going to use the `github.com/gofrs/uuid`
 instead.
 
-```
-{
-  "version": "1",
-  "packages": [...],
-  "overrides": [
-      {
-          "go_type": "github.com/gofrs/uuid.UUID",
-          "db_type": "uuid"
-      }
-  ]
-}
+```yaml
+version: "1"
+packages: [...]
+overrides:
+  - go_type: "github.com/gofrs/uuid.UUID"
+    db_type: "uuid"
 ```
 
 Each override document has the following keys:
@@ -354,36 +335,24 @@ This may be configured by specifying the `column` property in the override defin
 should be of the form `table.column` buy you may be even more specify by specifying `schema.table.column`
 or `catalog.schema.table.column`.
 
-```
-{
-  "version": "1",
-  "packages": [...],
-  "overrides": [
-    {
-      "column": "authors.id",
-      "go_type": "github.com/segmentio/ksuid.KSUID"
-    }
-  ]
-}
+```yaml
+version: "1"
+packages: [...]
+overrides:
+  - column: "authors.id"
+    go_type: "github.com/segmentio/ksuid.KSUID"
 ```
 
 ### Package Level Overrides
 
 Overrides can be configured globally, as demonstrated in the previous sections, or they can be configured on a per-package which
 scopes the override behavior to just a single package:
 
+```yaml
+version: "1"
+packages: 
+  - overrides: [...]
 ```
-{
-  "version": "1",
-  "packages": [
-    {
-      ...
-      "overrides": [...]
-    }
-  ],
-}
-```
-
 
 ### Renaming Struct Fields
 
@@ -401,14 +370,11 @@ If you're not happy with a field's generated name, use the `rename` dictionary
 to pick a new name. The keys are column names and the values are the struct
 field name to use.
 
-```json
-{
-  "version": "1",
-  "packages": [...],
-  "rename": {
-    "spotify_url": "SpotifyURL"
-  }
-}
+```yaml
+version: "1"
+packages: [...]
+rename:
+  spotify_url: "SpotifyURL"
 ```
 
 ## Downloads
@@ -420,7 +386,8 @@ Each commit is deployed to the [`devel` channel on Equinox](https://dl.equinox.i
 ## Other Databases and Languages
 
 sqlc currently only supports PostgreSQL / Go. MySQL support has been merged,
-but it's marked as experimental. SQLite and TypeScript support are planned.
+but it's marked as experimental. SQLite, TypeScript, and Kotlin support are
+planned.
 
 | Language     | PostgreSQL       | MySQL            | SQLite           |
 | ------------ |:----------------:|:----------------:|:----------------:|
@@ -429,6 +396,21 @@ but it's marked as experimental. SQLite and TypeScript support are planned.
 
 If you'd like to add another database or language, we'd welcome a contribution.
 
+## Sponsors
+
+sqlc development is funded by our generous sponsors.
+
+- Companies
+  - [Meter](https://meter.com)
+  - [ngrok](https://ngrok.com)
+- Individuals
+  - [CyberAx](https://github.com/Cyberax)
+
+If you use sqlc at your company, please consider [becoming a
+sponsor](https://github.com/sponsors/kyleconroy) today.
+
+Sponsors receive priority support via the sqlc Slack organization.
+
 ## Acknowledgements
 
 sqlc was inspired by [PugSQL](https://pugsql.org/) and

docs/migrations.md

@@ -5,6 +5,7 @@ sqlc will ignore rollback statements when parsing migration SQL files. The follo
 - [goose](https://github.com/pressly/goose)
 - [sql-migrate](https://github.com/rubenv/sql-migrate)
 - [tern](https://github.com/jackc/tern)
+- [golang-migrate](https://github.com/golang-migrate/migrate)
 
 ## goose
 
@@ -67,4 +68,32 @@ type Comment struct {
 	ID     int32 
 	Text   string 
 }
-```
+```
+
+## golang-migrate
+
+In `20060102.up.sql`:
+
+```sql
+CREATE TABLE post (
+    id    int NOT NULL,
+    title text,
+    body  text,
+    PRIMARY KEY(id)
+);
+```
+
+In `20060102.down.sql`:
+```sql
+DROP TABLE post;
+```
+
+```go
+package db
+
+type Post struct {
+	ID    int
+	Title sql.NullString
+	Body  sql.NullString
+}
+```

docs/named_parameters.md

@@ -0,0 +1,58 @@
+# Named parameters
+
+sqlc tried to generate good names for positional parameters, but sometimes it
+lacks enough context. The following SQL generates parameters with less than
+ideal names:
+
+```sql
+-- name: UpsertAuthorName :one
+UPDATE author
+SET
+  name = CASE WHEN $1::bool
+    THEN $2::text
+    ELSE name
+    END
+RETURNING *;
+```
+
+```go
+type UpdateAuthorNameParams struct {
+  Column1         bool           `json:""`
+  Column2_2       string         `json:"_2"`
+}
+```
+
+In these cases, named parameters give you the control over field names on the
+Params struct.
+
+```sql
+-- name: UpsertAuthorName :one
+UPDATE author
+SET
+  name = CASE WHEN sqlc.arg(set_name)::bool
+    THEN sqlc.arg(name)::text
+    ELSE name
+    END
+RETURNING *;
+```
+
+```go
+type UpdateAuthorNameParams struct {
+  SetName         bool           `json:"set_name"`
+  Name            string         `json:"name"`
+}
+```
+
+If the `sqlc.arg()` syntax is too verbose for your taste, you can use the `@`
+operator as a shortcut.
+
+```sql
+-- name: UpsertAuthorName :one
+UPDATE author
+SET
+  name = CASE WHEN @set_name::bool
+    THEN @name::text
+    ELSE name
+    END
+RETURNING *;
+```

go.mod

@@ -13,5 +13,6 @@ require (
 	golang.org/x/sys v0.0.0-20191220220014-0732a990476f // indirect
 	google.golang.org/genproto v0.0.0-20191223191004-3caeed10a8bf // indirect
 	google.golang.org/grpc v1.26.0 // indirect
+	gopkg.in/yaml.v3 v3.0.0-20200121175148-a6ecf24a6d71
 	vitess.io/vitess v0.0.0-20200119095853-bd8205ebca4a
 )

go.sum

@@ -515,6 +515,8 @@ gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
 gopkg.in/yaml.v2 v2.2.4/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
 gopkg.in/yaml.v2 v2.2.7 h1:VUgggvou5XRW9mHwD/yXxIYSMtY0zoKQf/v226p2nyo=
 gopkg.in/yaml.v2 v2.2.7/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
+gopkg.in/yaml.v3 v3.0.0-20200121175148-a6ecf24a6d71 h1:Xe2gvTZUJpsvOWUnvmL/tmhVBZUmHSvLbMjRj6NUUKo=
+gopkg.in/yaml.v3 v3.0.0-20200121175148-a6ecf24a6d71/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
 honnef.co/go/tools v0.0.0-20190102054323-c2f93a96b099/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4=
 honnef.co/go/tools v0.0.0-20190106161140-3f1c8253044a/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4=
 honnef.co/go/tools v0.0.0-20190418001031-e561f6794a2a/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4=