Title: Add custom struct tags to params structs · Issue #2039 · sqlc-dev/sqlc · GitHub
Open Graph Title: Add custom struct tags to params structs · Issue #2039 · sqlc-dev/sqlc
X Title: Add custom struct tags to params structs · Issue #2039 · sqlc-dev/sqlc
Description: What do you want to change? Hello, first of all thank you for the brilliant library. As already mentioned in Issue #534, the feature of custom struct tags was implemented with PR #1569. However, I noticed that the custom struct tags are ...
Open Graph Description: What do you want to change? Hello, first of all thank you for the brilliant library. As already mentioned in Issue #534, the feature of custom struct tags was implemented with PR #1569. However, I ...
X Description: What do you want to change? Hello, first of all thank you for the brilliant library. As already mentioned in Issue #534, the feature of custom struct tags was implemented with PR #1569. However, I ...
Opengraph URL: https://github.com/sqlc-dev/sqlc/issues/2039
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Add custom struct tags to params structs ","articleBody":"### What do you want to change?\n\nHello,\r\nfirst of all thank you for the brilliant library.\r\n\r\nAs already mentioned in Issue #534, the feature of custom struct tags was implemented with PR #1569.\r\nHowever, I noticed that the custom struct tags are only added to the database table structs. But not to the their corresponding parameter structs.\r\n\r\nIn my opinion, this would also be quite helpful and should not cause more problems than the struct tags of the database types, or tables, at least in terms of compatibility.\r\n\r\nCurrently I am facing the problem to validate user payloads of a REST API in GoLang. \r\nFor this I use among others the libraries: sqlc, gofiber, go-playground/validator/v10.\r\n\r\nI noticed the whole thing after I wanted to validate payload data to create a user.\r\nSome project snippets for reference:\r\n\r\n```yaml\r\nversion: \"2\"\r\n\r\nsql:\r\n - engine: \"postgresql\"\r\n queries: \"db/sqlc/\"\r\n schema: \"db/migrations/\"\r\n gen:\r\n go:\r\n package: \"db\"\r\n out: \"internal/db\"\r\n emit_json_tags: true\r\n emit_empty_slices: true\r\n emit_db_tags: true\r\n overrides:\r\n - column: users.first_name\r\n go_struct_tag: 'validate:\"required\"'\r\n - column: users.flast_name\r\n go_struct_tag: 'validate:\"required\"'\r\n - column: users.email\r\n go_struct_tag: 'validate:\"required,email\"'\r\n - column: users.organizational_unit\r\n go_struct_tag: 'validate:\"required\"'\r\n - column: users.name\r\n go_struct_tag: 'validate:\"required\"'\r\n```\r\n\r\n```sql\r\n// db.go\r\n// Code generated by sqlc. DO NOT EDIT.\r\n// versions:\r\n// sqlc v1.16.0\r\ntype User struct {\r\n\tID int32 `db:\"id\" json:\"id\"`\r\n\tFirstName string `db:\"first_name\" json:\"first_name\" validate:\"required\"`\r\n\tLastName string `db:\"last_name\" json:\"last_name\"`\r\n\tOrganizationalUnit string `db:\"organizational_unit\" json:\"organizational_unit\" validate:\"required\"`\r\n\tName string `db:\"name\" json:\"name\" validate:\"required\"`\r\n\tEmail string `db:\"email\" json:\"email\" validate:\"required,email\"`\r\n\tCreatedAt time.Time `db:\"created_at\" json:\"created_at\"`\r\n\tChangedAt time.Time `db:\"changed_at\" json:\"changed_at\"`\r\n}\r\n```\r\n\r\n```sql\r\n// query.sql.go\r\n// Code generated by sqlc. DO NOT EDIT.\r\n// versions:\r\n// sqlc v1.16.0\r\n// source: query.sql\r\ntype UpdateUserParams struct {\r\n\tID int32 `db:\"id\" json:\"id\"`\r\n\tFirstName string `db:\"first_name\" json:\"first_name\"`\r\n\tLastName string `db:\"last_name\" json:\"last_name\"`\r\n\tOrganizationalUnit string `db:\"organizational_unit\" json:\"organizational_unit\"`\r\n\tName string `db:\"name\" json:\"name\"`\r\n\tEmail string `db:\"email\" json:\"email\"`\r\n}\r\n```\r\n\r\n```go\r\nimport (\r\n \"github.com/gofiber/fiber/v2\"\r\n \"github.com/go-playground/validator/v10\"\r\n \"example.org/internal/database\"\r\n \"example.org/internal/db\" // sqlc generated package\r\n)\r\n\r\nvar (\r\n validate = validator.New()\r\n)\r\n\r\nfunc ValidateStruct(model interface{}) []*ErrorResponse {\r\n\r\n\tvar errors []*ErrorResponse\r\n\terr := validate.Struct(model)\r\n\tif err != nil {\r\n\t\tfor _, err := range err.(validator.ValidationErrors) {\r\n\t\t\tvar element ErrorResponse\r\n\t\t\telement.FailedField = err.StructNamespace()\r\n\t\t\telement.Tag = err.Tag()\r\n\t\t\telement.Value = err.Param()\r\n\t\t\terrors = append(errors, &element)\r\n\t\t}\r\n\t}\r\n\treturn errors\r\n}\r\n\r\nfunc CreateUser(c *fiber.Ctx) error {\r\n\t// user struct contains struct tags for \"github.com/go-playground/validator/v10\" defined in sqlc.yaml\r\n\tuserPayload := &db.User{}\r\n\r\n\terr := c.BodyParser(&userPayload)\r\n\tif err != nil {\r\n\t\treturn MessageBadRequest(c, \"failure while binding payload data to structured data\")\r\n\t}\r\n\r\n\terrors := ValidateStruct(*userPayload)\r\n\tif errors != nil {\r\n\t\treturn MessageBadRequest(c, errors)\r\n\t}\r\n\r\n\tqueries := database.GetQueries()\r\n\tctx, cancel := database.NewContext()\r\n\r\n\tdefer cancel()\r\n\r\n\t// CreateUserParams is missing custom struct tags for \"github.com/go-playground/validator/v10\" defined in sqlc.yaml\r\n\tinsertedUser, err := queries.CreateUser(ctx, db.CreateUserParams{\r\n\t\t// ...\r\n\t})\r\n\tif err != nil {\r\n\t\treturn err\r\n\t}\r\n\r\n\treturn MessageOK(c, insertedUser)\r\n}\r\n\r\n```\r\n \n\n### What database engines need to be changed?\n\nPostgreSQL, MySQL\n\n### What programming language backends need to be changed?\n\nGo, Python, Kotlin","author":{"url":"https://github.com/timrabl","@type":"Person","name":"timrabl"},"datePublished":"2023-01-27T20:32:27Z","url":"https://github.com/sqlc-dev/sqlc/issues/2039"}
| 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:de15a5eb-ded1-a710-4f17-efcfa90d9693 |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | B590:2E7A8:3FDA9:53EF6:6B01805E |
| html-safe-nonce | 73f15ad1becdeb5bee5cce369d8db9df2962c0e8ba2399936c33f9615322f442 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJCNTkwOjJFN0E4OjNGREE5OjUzRUY2OjZCMDE4MDVFIiwidmlzaXRvcl9pZCI6IjQ3MTcxMTA2NTY4Mzc0NTE4NzAiLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ== |
| visitor-hmac | f58a60b51fb97016ca2c6613c88b9c05206b84a669596430b38ce3095d6f1451 |
| hovercard-subject-tag | issue:1560396755 |
| 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/2039/issue_layout |
| twitter:image | https://opengraph.githubassets.com/0f29f5185a5d3167e3fafbb6febc2fb8c498223537c438ee11886bdff63886eb/sqlc-dev/sqlc/issues/2039 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/0f29f5185a5d3167e3fafbb6febc2fb8c498223537c438ee11886bdff63886eb/sqlc-dev/sqlc/issues/2039 |
| og:image:alt | What do you want to change? Hello, first of all thank you for the brilliant library. As already mentioned in Issue #534, the feature of custom struct tags was implemented with PR #1569. However, I ... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | timrabl |
| 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