v1.19.0

[kyleconroy]

What's new

sqlc vet

sqlc vet runs queries through a set of lint rules.

Rules are defined in the sqlc configuration file. They consist of a name, message, and a Common Expression Language (CEL) expression. Expressions are evaluated using cel-go. If an expression evaluates to true, an error is reported using the given message.

While these examples are simplistic, they give you a flavor of the types of rules you can write.

version: 2
sql:
  - schema: "query.sql"
    queries: "query.sql"
    engine: "postgresql"
    gen:
      go:
        package: "authors"
        out: "db"
    rules:
      - no-pg
      - no-delete
      - only-one-param
      - no-exec
rules:
  - name: no-pg
    message: "invalid engine: postgresql"
    rule: |
      config.engine == "postgresql"
  - name: no-delete
    message: "don't use delete statements"
    rule: |
      query.sql.contains("DELETE")
  - name: only-one-param
    message: "too many parameters"
    rule: |
      query.params.size() > 1
  - name: no-exec
    message: "don't use exec"
    rule: |
      query.cmd == "exec"

Database connectivity

vet also marks the first time that sqlc can connect to a live, running database server. We'll expand this functionality over time, but for now it powers the sqlc/db-prepare built-in rule.

When a database is configured, the sqlc/db-prepare rule will attempt to prepare each of your queries against the connected database and report any failures.

version: 2
sql:
  - schema: "query.sql"
    queries: "query.sql"
    engine: "postgresql"
    gen:
      go:
        package: "authors"
        out: "db"
    database:
      uri: "postgresql://postgres:password@localhost:5432/postgres"
    rules:
      - sqlc/db-prepare

To see this in action, check out the authors example.

Please note that sqlc does not manage or migrate your database. Use your migration tool of choice to create the necessary database tables and objects before running sqlc vet.

Omit unused structs

Added a new configuration parameter omit_unused_structs which, when set to true, filters out table and enum structs that aren't used in queries for a given package.

Suggested CI/CD setup

With the addition of sqlc diff and sqlc vet, we encourage users to run sqlc in your CI/CD pipelines. See our suggested CI/CD setup for more information.

Simplified plugin development

The sqlc-gen-kotlin and sqlc-gen-python plugins have been updated use the upcoming WASI support in Go 1.21. Building these plugins no longer requires TinyGo.

What's Changed

• Fixing Document Typo by @jyono in Fixing Document Typo #2236
• Update changelog.md with some minor edits by @andrewmbenton in Update changelog.md with some minor edits #2235
• fix: pointers overrides skip imports in generated query files by @ludusrusso in fix: pointers overrides skip imports in generated query files #2240
• fix: CASE-ELSE clause is not properly parsed when a value is constant by @nozaq in fix: CASE-ELSE clause is not properly parsed when a value is constant #2238
• remote: use user-id/password auth by @andrewmbenton in remote: use user-id/password auth #2262
• Feat: PostgreSQL capture correct line and column numbers for parse error by @StevenACoffman in Feat: PostgreSQL capture correct line and column numbers for parse error #2289
• build(deps): bump requests from 2.25.1 to 2.31.0 in /docs by @dependabot in build(deps): bump requests from 2.25.1 to 2.31.0 in /docs #2283
• build(deps): bump golang from 1.20.3 to 1.20.4 by @dependabot in build(deps): bump golang from 1.20.3 to 1.20.4 #2256
• build(deps): bump google.golang.org/grpc from 1.54.0 to 1.55.0 by @dependabot in build(deps): bump google.golang.org/grpc from 1.54.0 to 1.55.0 #2265
• build(deps): bump github.com/mattn/go-sqlite3 from 1.14.16 to 1.14.17 by @dependabot in build(deps): bump github.com/mattn/go-sqlite3 from 1.14.16 to 1.14.17 #2293
• build(deps): bump golang.org/x/sync from 0.1.0 to 0.2.0 by @dependabot in build(deps): bump golang.org/x/sync from 0.1.0 to 0.2.0 #2266
• docs: Add F# community plugin by @kyleconroy in docs: Add F# community plugin #2295
• Update bufbuild plugin references by @mfridman in Update bufbuild plugin references #2253
• engine/sqlite: Handle untyped sqlite columns without crashing by @andrewmbenton in engine/sqlite: Handle untyped sqlite columns without crashing #2281
• feat(sqlite) add support sqlc functions by @hakobera in feat(sqlite) add support sqlc functions #2274
• feat: add supporting COMMENT ON VIEW by @orisano in feat: add supporting COMMENT ON VIEW #2249
• feat: to allow spaces between function name and arguments of functions to be rewritten by @orisano in feat: to allow spaces between function name and arguments of functions to be rewritten #2250
• fix: fix toSnakeCase to handle input in camel case format by @orisano in fix: fix toSnakeCase to handle input in camel case format #2245
• feat: add support for pgx/v5 emit_pointers_for_null_types flag by @ludusrusso in feat: add support for pgx/v5 emit_pointers_for_null_types flag #2269
• fix(engine/sqlite): add location info to sqlite ast by @orisano in fix(engine/sqlite): add location info to sqlite ast #2298
• build(deps): bump golang from 1.20.4 to 1.20.5 by @dependabot in build(deps): bump golang from 1.20.4 to 1.20.5 #2301
• sqlite: fixed sqlite column type override by @mcdoker18 in sqlite: fixed sqlite column type override #1986
• Fix hyphen in go struct names by @kyleconroy in Fix hyphen in go struct names #2305
• codegen: Use catalog's default schema by @kyleconroy in codegen: Use catalog's default schema #2310
• codegen(go): Add tests for tables with dashes by @kyleconroy in codegen(go): Add tests for tables with dashes #2312
• Update BUG_REPORT.yml by @kyleconroy in Update BUG_REPORT.yml #2313
• fix citext resolution issues by @ryan-berger in fix citext resolution issues #1629
• fix: add override tags to result struct (go_struct_tag is missing for generated result row struct (or how to configure it) #1867) by @akutschera in fix: add override tags to result struct (#1867) #1887
• fix: Override types of aliased columns and named parameters by @haines in fix: Override types of aliased columns and named parameters #1884
• fix: resolve duplicate fields generated when inheriting multiple tables by @ethan-xiao in fix: resolve duplicate fields generated when inheriting multiple tables #2089
• postgres: Column merging for table inheritence by @kyleconroy in postgres: Column merging for table inheritence #2315
• codegen(go): Strip invalid characters from table and column names by @kyleconroy in codegen(go): Strip invalid characters from table and column names #2314
• feat(mysql): handle unsigned integers by @roccoblues in feat(mysql): handle unsigned integers #1746
• fix: check column references in ORDER BY (ORDER BY does not enforce column to exist #1411) by @akutschera in fix: check column references in ORDER BY (#1411) #1915
• Update using-go-and-pgx.rst by @teenjuna in Update using-go-and-pgx.rst #2318
• Support JSON tags for nullable enum structs by @mikemherron in Support JSON tags for nullable enum structs #2121
• build: Configure dependencies via devenv.sh by @kyleconroy in build: Configure dependencies via devenv.sh #2319
• feat: Allow use of table and column aliases for table functions returning unknown types by @haines in feat: Allow use of table and column aliases for table functions returning unknown types #2156
• build: Configure dependencies via devenv.sh by @kyleconroy in build: Configure dependencies via devenv.sh #2326
• docs: Add a ReadTheDocs config file by @kyleconroy in docs: Add a ReadTheDocs config file #2327
• build(deps): bump golang.org/x/sync from 0.2.0 to 0.3.0 by @dependabot in build(deps): bump golang.org/x/sync from 0.2.0 to 0.3.0 #2328
• build(deps): bump google.golang.org/grpc from 1.55.0 to 1.56.0 by @dependabot in build(deps): bump google.golang.org/grpc from 1.55.0 to 1.56.0 #2333
• fix(sqlite) fix EXISTS operator by @hakobera in fix(sqlite) fix EXISTS operator #2334
• improve init command to create v2/v1 yaml file by @dangquangdon in improve init command to create v2/v1 yaml file #2335
• Update changelog.md by @kyleconroy in Update changelog.md #2342
• fix: MySQL slice shadowing database/sql import by @LudovicDebost in fix: MySQL slice shadowing database/sql import #2332
• internal/config: support golang overrides for slices by @andrewmbenton in internal/config: support golang overrides for slices #2339
• cmd/sqlc: Show helpful output on missing subcommand by @kyleconroy in cmd/sqlc: Show helpful output on missing subcommand #2345
• Support for parsing REFRESH MATERIALIZED VIEW by @Jille in Support for parsing REFRESH MATERIALIZED VIEW #2347
• Add json_tags_id_camelcase configuration option by @jwc-clinnection in Add json_tags_id_camelcase configuration option #2325
• protos: Add missing field name by @kyleconroy in protos: Add missing field name #2354
• python: Use latest version of sqlc-gen-python by @kyleconroy in python: Use latest version of sqlc-gen-python #2355
• kotlin: Use latest version of sqlc-gen-kotlin by @kyleconroy in kotlin: Use latest version of sqlc-gen-kotlin #2356
• build(deps): bump google.golang.org/protobuf from 1.30.0 to 1.31.0 by @dependabot in build(deps): bump google.golang.org/protobuf from 1.30.0 to 1.31.0 #2370
• build(deps): bump actions/checkout from 2 to 3 by @dependabot in build(deps): bump actions/checkout from 2 to 3 #2357
• build: Run govulncheck on all builds by @kyleconroy in build: Run govulncheck on all builds #2372
• build(deps): bump google.golang.org/grpc from 1.56.0 to 1.56.1 by @dependabot in build(deps): bump google.golang.org/grpc from 1.56.0 to 1.56.1 #2358
• A few small staticcheck fixes by @Jille in A few small staticcheck fixes #2361
• Support "LIMIT ?" in UPDATE and DELETE for MySQL by @Jille in Support "LIMIT ?" in UPDATE and DELETE for MySQL #2365
• Add compiler support for NOTIFY and LISTEN (PostgreSQL) by @Jille in Add compiler support for NOTIFY and LISTEN (PostgreSQL) #2363
• Don't defer rows.Close() if pgx.BatchResults.Query() failed by @Jille in Don't defer rows.Close() if pgx.BatchResults.Query() failed  #2362
• Remove a bunch of dead code by @Jille in Remove a bunch of dead code #2360
• Fix type overrides not working with sqlc.slice by @Jille in Fix type overrides not working with sqlc.slice #2351
• docs: Update query_parameter_limit documentation by @kyleconroy in docs: Update query_parameter_limit documentation #2374
• internal/codegen/golang: omit unused structs from output by @andrewmbenton in internal/codegen/golang: omit unused structs from output #2369
• Fix type overrides on columns for parameters inside an IN clause by @Jille in Fix type overrides on columns for parameters inside an IN clause #2352
• Improve default names for BETWEEN ? AND ? to have prefixes from_ and to_ by @Jille in Improve default names for BETWEEN ? AND ? to have prefixes from_ and to_ #2366
• cmd/sqlc: Add the vet subcommand by @kyleconroy in cmd/sqlc: Add the vet subcommand #2344
• sqlite: Add support for UPDATE/DELETE with a LIMIT clause by @Jille in sqlite: Add support for UPDATE/DELETE with a LIMIT clause #2384
• Fix broken interaction between query_parameter_limit and pq.Array() by @Jille in Fix broken interaction between query_parameter_limit and pq.Array() #2383
• Add support for BETWEEN sqlc.arg(min) AND sqlc.arg(max) by @Jille in Add support for BETWEEN sqlc.arg(min) AND sqlc.arg(max) #2373
• scripts/regenerate should also update stderr.txt by @Jille in scripts/regenerate should also update stderr.txt #2379
• codegen/golang: Bring :execlastid in line with the rest by @Jille in codegen/golang: Bring :execlastid in line with the rest #2378
• feat(cmd/vet): Prepare queries against a database by @kyleconroy in feat(cmd/vet): Prepare queries against a database #2387
• feat(cmd/vet): Prepare queries for MySQL by @kyleconroy in feat(cmd/vet): Prepare queries for MySQL #2388
• feat(cmd/vet): Prepare SQLite queries by @kyleconroy in feat(cmd/vet): Prepare SQLite queries #2389
• feat(cmd/vet): Simplify environment variable substiution by @kyleconroy in feat(cmd/vet): Simplify environment variable substiution #2393
• feat(cmd/vet): Add built-in db-prepare rule by @kyleconroy in feat(cmd/vet): Add built-in db-prepare rule #2396
• docs: add a favicon by @andrewmbenton in docs: add a favicon #2397
• cmd/vet: Add --no-database option by @kyleconroy in cmd/vet: Add --no-database option #2405
• chore: remove refs to deprecated io/ioutil by @testwill in chore: remove refs to deprecated io/ioutil #2404
• config: Change database URL to URI by @kyleconroy in config: Change database URL to URI #2407
• docs: Add release notes for v1.19.0 by @kyleconroy in docs: Add release notes for v1.19.0 #2406
• docs: some v1.19.0 release copyediting by @andrewmbenton in docs: some v1.19.0 release copyediting #2409
• cmd/sqlc: Bump version to 1.19.0 by @kyleconroy in cmd/sqlc: Bump version to 1.19.0 #2408

New Contributors

• @jyono made their first contribution in Fixing Document Typo #2236
• @nozaq made their first contribution in fix: CASE-ELSE clause is not properly parsed when a value is constant #2238
• @StevenACoffman made their first contribution in Feat: PostgreSQL capture correct line and column numbers for parse error #2289
• @mfridman made their first contribution in Update bufbuild plugin references #2253
• @ethan-xiao made their first contribution in fix: resolve duplicate fields generated when inheriting multiple tables #2089
• @roccoblues made their first contribution in feat(mysql): handle unsigned integers #1746
• @teenjuna made their first contribution in Update using-go-and-pgx.rst #2318
• @dangquangdon made their first contribution in improve init command to create v2/v1 yaml file #2335
• @LudovicDebost made their first contribution in fix: MySQL slice shadowing database/sql import #2332
• @jwc-clinnection made their first contribution in Add json_tags_id_camelcase configuration option #2325
• @testwill made their first contribution in chore: remove refs to deprecated io/ioutil #2404

Full Changelog: v1.18.0...v1.19.0

---

This discussion was created from the release v1.19.0.