Configuration file (version 1)¶
sqlc tool is configured via a
sqlc.json file. This file must be
in the directory where the
sqlc command is run.
version: "1" packages: - name: "db" path: "internal/db" queries: "./sql/query/" schema: "./sql/schema/" engine: "postgresql" emit_prepared_queries: true emit_interface: false emit_exact_table_names: false emit_empty_slices: false emit_json_tags: true json_tags_case_style: "camel"
Each package document has the following keys:
The package name to use for the generated code. Defaults to
Output directory for generated code
Directory of SQL queries or path to single SQL file; or a list of paths
Directory of SQL migrations or path to single SQL file; or a list of paths
mysql. Defaults to
postgresql. MySQL support is experimental
If true, add DB tags to generated structs. Defaults to
If true, include support for prepared queries. Defaults to
If true, output a
Querierinterface in the generated package. Defaults to
If true, struct names will mirror table names. Otherwise, sqlc attempts to singularize plural table names. Defaults to
If true, slices returned by
:manyqueries will be empty instead of
nil. Defaults to
If true, add JSON tags to generated structs. Defaults to
snakefor snake_case or
noneto use the column name in the DB. Defaults to
The default mapping of PostgreSQL types to Go types only uses packages outside the standard library when it must.
For example, the
uuid PostgreSQL type is mapped to
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
version: "1" packages: [...] overrides: - go_type: "github.com/gofrs/uuid.UUID" db_type: "uuid"
Each override document has the following keys:
The PostgreSQL type to override. Find the full list of supported types in postgresql_type.go.
A fully qualified name to a Go type to use in the generated code.
If true, use this type when a column is nullable. Defaults to
Per-Column Type Overrides¶
Sometimes you would like to override the Go type used in model or query generation for a specific field of a table and not on a type basis as described in the previous section.
This may be configured by specifying the
column property in the override definition.
should be of the form
table.column buy you may be even more specify by specifying
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:
version: "1" packages: - overrides: [...]
Renaming Struct Fields¶
Struct field names are generated from column names using a simple algorithm: split the column name on underscores and capitalize the first letter of each part.
account -> Account spotify_url -> SpotifyUrl app_id -> AppID
If you’re not happy with a field’s generated name, use the
to pick a new name. The keys are column names and the values are the struct
field name to use.
version: "1" packages: [...] rename: spotify_url: "SpotifyURL"