Typegen is not respecting unique table constraint

Open
#612 3 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Stale
Tech stack
postgresql, typescript
Domain
databases

Research direction

Reproduce the schema with customers, addresses, and orders, then run npx supabase gen types typescript --local > types/supabase.ts and inspect the generated relationship types. Trace the type-generation entry point used by that command and verify that the unique addresses.customer_id relationship is emitted as an object while orders remains an array.

Written by the indexing model from the issue text.

Description

Describe the bug
I have three tables. One main table customers and two linked tables addresses and orders. They both are linked to the customers table's id column, but the addresses table has a unique constraint on customer_id relation column. The problem is that the generated types assumes that both table relations are one to many.

To Reproduce
Steps to reproduce the behavior:

  1. Start a new project and create three tables. Reference one main table from the two others, one with a unique constraint and one without.
  2. Generate types using npx supabase gen types typescript --local > types/supabase.ts
  3. Use const supabase = createClient<Database>() and query const { data } = supabase .from("customers") .select("*, orders (id), addresses (id)").single()
  4. see that the type of data.orders and data.addresses are both an array of objects.

Expected behavior
The types to respect the unique constraint and be an object and not an array of objects.

Desktop

  • OS: Mac OS 13.4.1
  • Version of CLI: v1.93.0
  • Version of supabase-js: v2.33.2
  • Version of Node.js: v16.14.2
Dominant language
TypeScript
Stars
1.2k
Forks
223
PR merge metrics
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from supabase/postgres-meta

All issues in supabase/postgres-meta

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.