v1.19.0

Released 2023-07-06 · View on GitHub

Release notes

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

Pointers overrides skip imports in generated query files (#2240)
CASE-ELSE clause is not properly parsed when a value is constant (#2238)
Fix toSnakeCase to handle input in CamelCase format (#2245)
Add location info to sqlite ast (#2298)
Add override tags to result struct (#1867) (#1887)
Override types of aliased columns and named parameters (#1884)
Resolve duplicate fields generated when inheriting multiple tables (#2089)
Check column references in ORDER BY (#1411) (#1915)
MySQL slice shadowing database/sql import (#2332)
Don't defer rows.Close() if pgx.BatchResults.Query() failed (#2362)
Fix type overrides not working with sqlc.slice (#2351)
Type overrides on columns for parameters inside an IN clause (#2352)
Broken interaction between query_parameter_limit and pq.Array() (#2383)
(codegen/golang) Bring :execlastid in line with the rest (#2378)

Documentation

Update changelog.md with some minor edits (#2235)
Add F# community plugin (#2295)
Add a ReadTheDocs config file (#2327)
Update query_parameter_limit documentation (#2374)
Add launch announcement banner

Features

PostgreSQL capture correct line and column numbers for parse error (#2289)
Add supporting COMMENT ON VIEW (#2249)
To allow spaces between function name and arguments of functions to be rewritten (#2250)
Add support for pgx/v5 emit_pointers_for_null_types flag (#2269)
(mysql) Support unsigned integers (#1746)
Allow use of table and column aliases for table functions returning unknown types (#2156)
Support "LIMIT ?" in UPDATE and DELETE for MySQL (#2365)
(internal/codegen/golang) Omit unused structs from output (#2369)
Improve default names for BETWEEN ? AND ? to have prefixes from_ and to_ (#2366)
(cmd/sqlc) Add the vet subcommand (#2344)
(sqlite) Add support for UPDATE/DELETE with a LIMIT clause (#2384)
Add support for BETWEEN sqlc.arg(min) AND sqlc.arg(max) (#2373)
(cmd/vet) Prepare queries against a database (#2387)
(cmd/vet) Prepare queries for MySQL (#2388)
(cmd/vet) Prepare SQLite queries (#2389)
(cmd/vet) Simplify environment variable substiution (#2393)
(cmd/vet) Add built-in db-prepare rule
Add compiler support for NOTIFY and LISTEN (PostgreSQL) (#2363)