Title: Feature: Nullability Type Hints · Issue #4340 · sqlc-dev/sqlc · GitHub
Open Graph Title: Feature: Nullability Type Hints · Issue #4340 · sqlc-dev/sqlc
X Title: Feature: Nullability Type Hints · Issue #4340 · sqlc-dev/sqlc
Description: What do you want to change? Nullability Type Hints Queries such as the following fail if calling a function which can return a null value. select foo::text from bar(); Workaround One workaround, for Postgres at least, is to create a doma...
Open Graph Description: What do you want to change? Nullability Type Hints Queries such as the following fail if calling a function which can return a null value. select foo::text from bar(); Workaround One workaround, fo...
X Description: What do you want to change? Nullability Type Hints Queries such as the following fail if calling a function which can return a null value. select foo::text from bar(); Workaround One workaround, fo...
Opengraph URL: https://github.com/sqlc-dev/sqlc/issues/4340
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Feature: Nullability Type Hints","articleBody":"### What do you want to change?\n\n# Nullability Type Hints\n\nQueries such as the following fail if calling a function which can return a null value.\n```\nselect foo::text from bar();\n```\n\n## Workaround\n\nOne workaround, for Postgres at least, is to create a domain type in the database.\n\n```\ncreate domain text_nullable AS text;\n```\n\nAnd then add an override for this type in the `sqlc` config.\n\n```\noverrides:\n - db_type: text_nullable\n go_type:\n type: string\n pointer: true\n```\n\nThen this works:\n```\nselect foo::text_nullable from bar();\n```\n\n\n## Nullability Hints - Potential Proposals\n\nI wonder if there's a reasonable way to modify `sqlc` to pass in a nullability hint within a query?\n\nA couple of ideas...\n\nCreate a new sqlc macro.\n```\nselect sql.nullable(foo::text) as foo from bar();\n```\n\nAdd comment based hinting.\n```\nselect\n foo::text -- sqlc:nullable\nfrom bar();\n```\n\nCreate an option which recognises specific suffixes (This would conflict if these names do exist in the database).\n```\nselect foo::text_nullable from call_a_function();\n```\n\nQuestion mark syntax. Harder to implement, but this may be nicer to read. Would probably require a change to\n`pg_query_go`. Though it may be possible to extract the question marks using a simple scanner pass before passing to `pg_query_go`.\n\n```\nselect foo::text? as foo from call_a_function();\n```\n\nAnother option is putting detailed type and parameter information in the header comment. i.e. the `@param` proposal.\nPersonally, I think I actually prefer type casts and hints in the queries.\n\nhttps://github.com/sqlc-dev/sqlc/issues/2800\n\n\n## Related Issues\n\nMany of these can be fixed by better nullability inference, but adding nullability hints, could solve these in the\nmeantime.\n\nhttps://github.com/sqlc-dev/sqlc/issues/4121\nhttps://github.com/sqlc-dev/sqlc/issues/3274\nhttps://github.com/sqlc-dev/sqlc/issues/4336\nhttps://github.com/sqlc-dev/sqlc/issues/2284\nhttps://github.com/sqlc-dev/sqlc/issues/4262\nhttps://github.com/sqlc-dev/sqlc/issues/2800\n\n\n## Implementation Notes\n\nIn a nutshell, I'm looking for a way to strip something out of the query, in a way which doesn't affect the database,\n and then pass it through to `compiler.Column.NotNull`. See: `sqlc/internal/compiler/to_column.go`.\n\n```\nfunc toColumn(n *ast.TypeName) *Column {\n\tif n == nil {\n\t\tpanic(\"can't build column for nil type name\")\n\t}\n\ttyp, err := ParseTypeName(n)\n\tif err != nil {\n\t\tpanic(\"toColumn: \" + err.Error())\n\t}\n\tarrayDims := arrayDims(n)\n\treturn &Column{\n\t\tType: typ,\n\t\tDataType: strings.TrimPrefix(astutils.Join(n.Names, \".\"), \".\"),\n\t\tNotNull: true, // XXX: How do we know if this should be null?\n\t\tIsArray: arrayDims > 0,\n\t\tArrayDims: arrayDims,\n\t}\n}\n```\n\nHappy to have a crack at this, if others think it has value.\n\n\n### What database engines need to be changed?\n\n_No response_\n\n### What programming language backends need to be changed?\n\n_No response_","author":{"url":"https://github.com/greg-blackcurrent","@type":"Person","name":"greg-blackcurrent"},"datePublished":"2026-03-14T04:32:03Z","url":"https://github.com/sqlc-dev/sqlc/issues/4340"}
| react-profiling | 0 |
| react-import-map | react,react-dom,react-dom/client,react-dom/profiling,react-is,react/compiler-runtime,react/jsx-dev-runtime,react/jsx-runtime,scheduler@b8488ee2c322 |
| route-pattern | /_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format) |
| route-controller | voltron_issues_fragments |
| route-action | issue_layout |
| fetch-nonce | v2:a0d317b7-803c-6c56-bb53-030f174acef6 |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | EBB2:2652DC:265759B:30DA446:6B018058 |
| html-safe-nonce | 7cc7df0bf2fc52f53eb0f12b9fd1a6d2b992137f7bd927ed767e2749fc1e640f |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJFQkIyOjI2NTJEQzoyNjU3NTlCOjMwREE0NDY6NkIwMTgwNTgiLCJ2aXNpdG9yX2lkIjoiMjM3MTc2MjQ5MTE5MDUwOTY1NiIsInJlZ2lvbl9lZGdlIjoiaWFkIiwicmVnaW9uX3JlbmRlciI6ImlhZCJ9 |
| visitor-hmac | 34d94aafbf98a6b76b38a1ad1c6e063c9102d17b3e8004665b09a9526f9163be |
| hovercard-subject-tag | issue:4074646577 |
| github-keyboard-shortcuts | repository,issues,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/sqlc-dev/sqlc/4340/issue_layout |
| twitter:image | https://opengraph.githubassets.com/050f8845923d830cf0c879ef95dc93f3eb2b074d30d253d4d39b1ecc0b90654d/sqlc-dev/sqlc/issues/4340 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/050f8845923d830cf0c879ef95dc93f3eb2b074d30d253d4d39b1ecc0b90654d/sqlc-dev/sqlc/issues/4340 |
| og:image:alt | What do you want to change? Nullability Type Hints Queries such as the following fail if calling a function which can return a null value. select foo::text from bar(); Workaround One workaround, fo... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | greg-blackcurrent |
| hostname | github.com |
| expected-hostname | github.com |
| None | cc5dfdd32f62ebd3223cab3af3aa2b268d3605218237326a48a99d1efd89495c |
| turbo-cache-control | no-preview |
| go-import | github.com/sqlc-dev/sqlc git https://github.com/sqlc-dev/sqlc.git |
| octolytics-dimension-user_id | 136738596 |
| octolytics-dimension-user_login | sqlc-dev |
| octolytics-dimension-repository_id | 193160679 |
| octolytics-dimension-repository_nwo | sqlc-dev/sqlc |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 193160679 |
| octolytics-dimension-repository_network_root_nwo | sqlc-dev/sqlc |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | 8c77c9e8439031ad54c75a250694842892f693e1 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
| react-app-name | issues |
Links:
Viewport: width=device-width