Skip to content

docs: clarify db_type override must use the canonical parser type name #4620

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
shaikn6 wants to merge 1 commit into
base: main
Choose a base branch
from
+9 −0
Open

docs: clarify db_type override must use the canonical parser type name #4620

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/howto/overrides.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,15 @@ Each element in the `overrides` list has the following keys:

- `db_type`:
- A database type to override. Find the full list of supported types in [postgresql_type.go](https://github.com/sqlc-dev/sqlc/blob/main/internal/codegen/golang/postgresql_type.go#L12) or [mysql_type.go](https://github.com/sqlc-dev/sqlc/blob/main/internal/codegen/golang/mysql_type.go#L12). Note that for Postgres you must use pg_catalog-prefixed names where available. `db_type` and `column` are mutually exclusive.

> [!WARNING]
> `db_type` is matched against the canonical type name the Postgres parser
> assigns to the column, not the type name from your schema. For example,
> a column declared `INTEGER` has the canonical type `pg_catalog.int4`, so
> `db_type: "integer"` will silently fail to match (no error, no
> override) and you must write `db_type: "pg_catalog.int4"` instead. When
> unsure of a column's canonical type, check the aliases handled in
> [postgresql_type.go](https://github.com/sqlc-dev/sqlc/blob/main/internal/codegen/golang/postgresql_type.go).
- `column`:
- A column name to override. The value should be of the form `table.column` but you can also specify `schema.table.column` or `catalog.schema.table.column`. `column` and `db_type` are mutually exclusive.
- `go_type`:
Expand Down