Skip to content

Commit b269dd3

Browse files
soedirgosoedirgo
authored
Merge pull request #628 from supabase/feat/relationships-is-one-to-one
feat(relationships): include `is_one_to_one`
2 parents 994808b + d087241 commit b269dd3

File tree

7 files changed

+87
-1
lines changed

7 files changed

+87
-1
lines changed

‎src/lib/PostgresMetaRelationships.ts‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,7 @@ export default class PostgresMetaRelationships {
9292
schema: vtkd.view_schema,
9393
relation: vtkd.view_name,
9494
columns: viewColumns,
95+
is_one_to_one: r.is_one_to_one,
9596
referenced_schema: r.referenced_schema,
9697
referenced_relation: r.referenced_relation,
9798
referenced_columns: r.referenced_columns,
@@ -104,6 +105,7 @@ export default class PostgresMetaRelationships {
104105
schema: r.schema,
105106
relation: r.relation,
106107
columns: r.columns,
108+
is_one_to_one: r.is_one_to_one,
107109
referenced_schema: tvkd.view_schema,
108110
referenced_relation: tvkd.view_name,
109111
referenced_columns: viewColumns,
@@ -119,6 +121,7 @@ export default class PostgresMetaRelationships {
119121
schema: vtkd.view_schema,
120122
relation: vtkd.view_name,
121123
columns: viewColumns,
124+
is_one_to_one: r.is_one_to_one,
122125
referenced_schema: tvkd.view_schema,
123126
referenced_relation: tvkd.view_name,
124127
referenced_columns: referencedViewColumns,

‎src/lib/sql/table_relationships.sql‎

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,31 @@
11
-- Adapted from
22
-- https://github.com/PostgREST/postgrest/blob/f9f0f79fa914ac00c11fbf7f4c558e14821e67e2/src/PostgREST/SchemaCache.hs#L722
3+
WITH
4+
pks_uniques_cols AS (
5+
SELECT
6+
connamespace,
7+
conrelid,
8+
jsonb_agg(column_info.cols) as cols
9+
FROM pg_constraint
10+
JOIN lateral (
11+
SELECT array_agg(cols.attname order by cols.attnum) as cols
12+
FROM ( select unnest(conkey) as col) _
13+
JOIN pg_attribute cols on cols.attrelid = conrelid and cols.attnum = col
14+
) column_info ON TRUE
15+
WHERE
16+
contype IN ('p', 'u') and
17+
connamespace::regnamespace::text <> 'pg_catalog'
18+
GROUP BY connamespace, conrelid
19+
)
320
SELECT
421
traint.conname AS foreign_key_name,
522
ns1.nspname AS schema,
623
tab.relname AS relation,
724
column_info.cols AS columns,
825
ns2.nspname AS referenced_schema,
926
other.relname AS referenced_relation,
10-
column_info.refs AS referenced_columns
27+
column_info.refs AS referenced_columns,
28+
(column_info.cols IN (SELECT * FROM jsonb_array_elements(pks_uqs.cols))) AS is_one_to_one
1129
FROM pg_constraint traint
1230
JOIN LATERAL (
1331
SELECT
@@ -21,4 +39,6 @@ JOIN pg_namespace ns1 ON ns1.oid = traint.connamespace
2139
JOIN pg_class tab ON tab.oid = traint.conrelid
2240
JOIN pg_class other ON other.oid = traint.confrelid
2341
JOIN pg_namespace ns2 ON ns2.oid = other.relnamespace
42+
LEFT JOIN pks_uniques_cols pks_uqs ON pks_uqs.connamespace = traint.connamespace AND pks_uqs.conrelid = traint.conrelid
2443
WHERE traint.contype = 'f'
44+
AND traint.conparentid = 0

‎src/lib/types.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -239,6 +239,7 @@ export const postgresRelationshipSchema = Type.Object({
239239
schema: Type.String(),
240240
relation: Type.String(),
241241
columns: Type.Array(Type.String()),
242+
is_one_to_one: Type.Boolean(),
242243
referenced_schema: Type.String(),
243244
referenced_relation: Type.String(),
244245
referenced_columns: Type.Array(Type.String()),

‎src/server/templates/typescript.ts‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -167,6 +167,7 @@ export interface Database {
167167
(relationship) => `{
168168
foreignKeyName: ${JSON.stringify(relationship.foreign_key_name)}
169169
columns: ${JSON.stringify(relationship.columns)}
170+
isOneToOne: ${relationship.is_one_to_one}
170171
referencedRelation: ${JSON.stringify(relationship.referenced_relation)}
171172
referencedColumns: ${JSON.stringify(relationship.referenced_columns)}
172173
}`
@@ -235,6 +236,7 @@ export interface Database {
235236
(relationship) => `{
236237
foreignKeyName: ${JSON.stringify(relationship.foreign_key_name)}
237238
columns: ${JSON.stringify(relationship.columns)}
239+
isOneToOne: ${relationship.is_one_to_one}
238240
referencedRelation: ${JSON.stringify(relationship.referenced_relation)}
239241
referencedColumns: ${JSON.stringify(relationship.referenced_columns)}
240242
}`

‎test/db/00-init.sql‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,3 +96,8 @@ $$;
9696

9797
create or replace function public.polymorphic_function(text) returns void language sql as '';
9898
create or replace function public.polymorphic_function(bool) returns void language sql as '';
99+
100+
create table user_details (
101+
user_id int8 references users(id) primary key,
102+
details text
103+
);

‎test/lib/tables.ts‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,15 @@ test('list', async () => {
121121
"target_table_name": "users",
122122
"target_table_schema": "public",
123123
},
124+
{
125+
"constraint_name": "user_details_user_id_fkey",
126+
"source_column_name": "user_id",
127+
"source_schema": "public",
128+
"source_table_name": "user_details",
129+
"target_column_name": "id",
130+
"target_table_name": "users",
131+
"target_table_schema": "public",
132+
},
124133
],
125134
"replica_identity": "DEFAULT",
126135
"rls_enabled": false,
@@ -176,6 +185,15 @@ test('list without columns', async () => {
176185
"target_table_name": "users",
177186
"target_table_schema": "public",
178187
},
188+
{
189+
"constraint_name": "user_details_user_id_fkey",
190+
"source_column_name": "user_id",
191+
"source_schema": "public",
192+
"source_table_name": "user_details",
193+
"target_column_name": "id",
194+
"target_table_name": "users",
195+
"target_table_schema": "public",
196+
},
179197
],
180198
"replica_identity": "DEFAULT",
181199
"rls_enabled": false,

‎test/server/typegen.ts‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,7 @@ test('typegen', async () => {
6161
{
6262
foreignKeyName: "memes_category_fkey"
6363
columns: ["category"]
64+
isOneToOne: false
6465
referencedRelation: "category"
6566
referencedColumns: ["id"]
6667
}
@@ -87,12 +88,44 @@ test('typegen', async () => {
8788
{
8889
foreignKeyName: "todos_user-id_fkey"
8990
columns: ["user-id"]
91+
isOneToOne: false
9092
referencedRelation: "users"
9193
referencedColumns: ["id"]
9294
},
9395
{
9496
foreignKeyName: "todos_user-id_fkey"
9597
columns: ["user-id"]
98+
isOneToOne: false
99+
referencedRelation: "users_view"
100+
referencedColumns: ["id"]
101+
}
102+
]
103+
}
104+
user_details: {
105+
Row: {
106+
details: string | null
107+
user_id: number
108+
}
109+
Insert: {
110+
details?: string | null
111+
user_id: number
112+
}
113+
Update: {
114+
details?: string | null
115+
user_id?: number
116+
}
117+
Relationships: [
118+
{
119+
foreignKeyName: "user_details_user_id_fkey"
120+
columns: ["user_id"]
121+
isOneToOne: true
122+
referencedRelation: "users"
123+
referencedColumns: ["id"]
124+
},
125+
{
126+
foreignKeyName: "user_details_user_id_fkey"
127+
columns: ["user_id"]
128+
isOneToOne: true
96129
referencedRelation: "users_view"
97130
referencedColumns: ["id"]
98131
}
@@ -149,12 +182,14 @@ test('typegen', async () => {
149182
{
150183
foreignKeyName: "todos_user-id_fkey"
151184
columns: ["user-id"]
185+
isOneToOne: false
152186
referencedRelation: "users"
153187
referencedColumns: ["id"]
154188
},
155189
{
156190
foreignKeyName: "todos_user-id_fkey"
157191
columns: ["user-id"]
192+
isOneToOne: false
158193
referencedRelation: "users_view"
159194
referencedColumns: ["id"]
160195
}
@@ -180,12 +215,14 @@ test('typegen', async () => {
180215
{
181216
foreignKeyName: "todos_user-id_fkey"
182217
columns: ["user-id"]
218+
isOneToOne: false
183219
referencedRelation: "users"
184220
referencedColumns: ["id"]
185221
},
186222
{
187223
foreignKeyName: "todos_user-id_fkey"
188224
columns: ["user-id"]
225+
isOneToOne: false
189226
referencedRelation: "users_view"
190227
referencedColumns: ["id"]
191228
}

0 commit comments

Comments
 (0)