sqlc icon indicating copy to clipboard operation
sqlc copied to clipboard

Update postgresql_type.go - check notNull and emitPointersForNull before SQLDriver

Open theAnuragMishra opened this issue 10 months ago • 11 comments

this fixes the issue where despite having emit_pointers_for_null_types set to true, the generate models don't use pointers for timestamp field.

theAnuragMishra avatar Feb 12 '25 18:02 theAnuragMishra

Linked to issue #3837

I can see there is a lot of tests there fails, the question should then be if the new output is the desired or not? Is it to big of a breaking change? should it be behind a new flag?

benjaco avatar Feb 14 '25 18:02 benjaco

@theAnuragMishra maybe you could update the tests so it's easier to see the impact of this change? It needs to be updated anyway for it to get merged

benjaco avatar Feb 17 '25 07:02 benjaco

is there a way i can commandeer this? Seems author might be tied up?

acartine avatar Apr 07 '25 15:04 acartine

@acartine I think you'd be more than welcome to give it a go in a new PR

benjaco avatar Apr 08 '25 18:04 benjaco

@acartine I think you'd be more than welcome to give it a go in a new PR

ok i'll give it a shit. i'm on gmt+1 but hopefully it won't take too long

acartine avatar Apr 09 '25 12:04 acartine

really proud of my typo above, first class

acartine avatar Apr 10 '25 06:04 acartine

@benjaco from looking at the code more closely it appears there is an unclear configuration hierarchy

if you look at the first few types in

https://github.com/sqlc-dev/sqlc/blob/047d587dd7ec9ccd04c8a9930c2a599b607ac18f/internal/codegen/golang/postgresql_type.go#L44-L139

the go types and emit-pointers-on-null supercede pgxv5

then for numerics/dates/times/uuid etc. that hierarchy is flipped.

this leads to a confusing devx because sometimes you get the go types / pointers and sometimes you get the pgtypes, which are more cumbersome to work with. the latter reason is probably why we try to use go types for nonnulls regardless of whether or not it is pgxv5 for the literal types.

i would think we need to draw some kind of line in the sand here and say there are two modes

  1. strict pgtypes (no null config, since pgtypes support null)
  2. go types with either pointers for null or sql.null. I would think just pointers because if you want values just use mode 1. keep it simple

is there a discord/slack for broader discussion about this?

acartine avatar Apr 10 '25 08:04 acartine

@acartine Issnt that what "emit_pointers_for_null_types" is suppose to configure?

Docs

  • emit_pointers_for_null_types:
    • If true, generated types for nullable columns are emitted as pointers (ie. *string) instead of database/sql null types (ie. NullString). Currently only supported for PostgreSQL if sql_package is pgx/v4 or pgx/v5, and for SQLite. Defaults to false.

So if emit_pointers_for_null_types is set to true, then the emitPointersForNull check should always come before the database type check in the typegen code.

There is no broader discussion, its all in the issue #3837 and in the pr's linked around that issue

benjaco avatar Apr 10 '25 08:04 benjaco

i think there is a bit more clarification need. would you prefer i do it on that issue instead of this one?

in that issue you use the text/varchar example. And that's fine if that is the expected behavior.

however it should be noted that that style means that that the pgtype is used only if the type is nullable and !emitPointersForNull. It will never be used if the type is notNull.

that is a reasonably big change that will break any code that upgrades and does not use emitPointersForNull.

but if that's how you want me to implement it i'm happy to do it that way.

while we are at it, i can't seem to find a command to update the expected outputs, should I assume then that it is manual and not auto generated?

acartine avatar Apr 10 '25 08:04 acartine

@acartine lets move the discussion to the issue but to sum up short - i dont know the mindset balancing breaking changes and configs, we need some attention from Kyle maybe, but a summery of the different solutions would properly help him here - and i dont know the internal tooling of this project, I'm a first time contributer as well

benjaco avatar Apr 10 '25 15:04 benjaco

agree. emitPointersForNull must be checks first before pgx checks

or using this workaround: https://github.com/sqlc-dev/sqlc/issues/3837#issuecomment-2892512973

erlangparasu avatar May 20 '25 21:05 erlangparasu