json: way to omit fields

[kevinburke1]

I have emit_json_tags set to true but it would be nice to have some way to omit specific tags. In particular, I would not like to expose auto_id, the serial incrementing integer field

[kyleconroy]

Hmm, the configuration format is currently not set up to allow this type of fine-grained configuration. Any idea on how we could change it?

[kevinburke1]

I mean probably the answer is just "don't use the same struct for JSON serialization that you use for the database."

[kevinburke1]

(having thought about this for a few days)

[mightyguava]

I have also arrived at the same conclusion no less than 3 times in the past, after starting out with JSON on my (hand-written) database models and fighting the inflexibility 😂

[kyleconroy]

@kevinburkemeter Going to mark this as wontfix.

[dimuls]

Maybe we can use comments for this:

create table myuser (
  id bigserial primary key,
  login text not null,
  password_hash bytea not null -- json:"-"
);

For id and login standard id and login json tags should be generated, for password_hash it should be -.
Need some way to hide sensitive fields in REST API. Now one should use wrapping structs with json:"-" specified for that type of fields.

[eazylaykzy]

@kyleconroy I was wondering if this will be given consideration, moreover with the comment from @dimuls .

[kwinso]

Was this implemented?

[lucaskbr]

open pr for the feature -> #3117

[lozanov95]

I was looking for this and found the following config:

sql:
  - engine: "postgresql"
    queries: "queries"
    schema: "migrations"
    gen:
      go:
        package: "data"
        out: "internal/data"
        sql_package: "pgx/v5"
        emit_json_tags: true
        overrides:
          - column: users.password_hash # prevent exporting the struct tag
            go_struct_tag: json:"-"