sqlc.embed that overrides struct field name #3745

Activity

1. marko995

   added

   enhancementNew feature or requestNew feature or request

   on Dec 13, 2024
2. marko995

   changed the title [-]sqlc.embed that override struct name[/-] [+]sqlc.embed that overrides struct field name[/+] on Dec 13, 2024
3. dosubot

   added

   📚 mysql

   📚 postgresql

   📚 sqlite

   on Dec 13, 2024
4. zerefel commented on Jan 12, 2025

   

   zerefel

   on Jan 12, 2025

   Last edited by zerefel

   More actions

   A workaround is mentioned in #3177 - use DB Views. Though it's mostly useful if you redefine your own models and embed the types e.g.

   CREATE VIEW home_teams AS SELECT * FROM teams;

   type HomeTeam Team
      // or repository.Team if you're not redefining your own models and you rely on sqlc-generated models

   I find this is a satisfactory solution for a small project.
5. kwoodhouse93 commented on Feb 25, 2025

   

   kwoodhouse93

   on Feb 25, 2025

   Last edited by kwoodhouse93

   More actions

   I agree this workaround is probably manageable for a small project. However, for a larger one with a complex schema, it quickly becomes quite undesirable to add a view every time this crops up. For example, I'm working with a lot of tables that reference each other multiple times, or even that reference themselves, so it quickly becomes important to differentiate between multiple relations of the same type.

   I'd agree with @marko995 that the most desirable option here would be a second, optional argument for setting the name of the embed in the generated struct. Alternatively, I expected AS <name> to work as it does for non-embedded fields, but in practice, this actually breaks the generated query (at least using v1.28.0 with postgres & Golang).

   ---

   For example:

   SELECT
     sqlc.embed(accounts),
     orders.id
   FROM orders
   LEFT JOIN accounts ON orders.account_id = accounts.id
   

   Generates:

   SELECT
     accounts.id, accounts.email,
     orders.id
   FROM orders
   LEFT JOIN accounts ON orders.account_id = accounts.id
   

   The struct would be:

   type ... struct {
     Accounts Accounts
     OrderID string
   }
   

   ---

   If using as, though, say our SQLC query is:

   SELECT
     sqlc.embed(accounts) as order_accounts,
     orders.id
   FROM orders
   LEFT JOIN accounts ON orders.account_id = accounts.id
   

   Generates:

   SELECT
     accounts.accounts, accounts.accounts as order_accounts,
     orders.id
   FROM orders
   LEFT JOIN accounts ON orders.account_id = accounts.id
   

   The struct is still:

   type ... struct {
     Accounts Accounts
     OrderID string
   }
   

   So the generated SQL is not a valid query, which makes me think there's a bug here, regardless of the proposed enhancement. sqlc.embed is a huge value-add for working with JOINs. Being able to remove this limitation would make it even more valuable.

   👍React with 👍11Reacted by Matthew Pull, Dusan, Vicente Surraco, WillAbides, Kamil Kozioł, Ravener, Hilmar Wiegand, Daniel Muller, Danko Petrovic, Hamza Hraiche and 1 more