✨ feat: enhance schema to adopt `constraints` data #1168

tnyo43 · 2025-04-06T03:47:22Z

Issue

resolve: Improve schame expression to adopt constraints data, such as primary key, unique, foreign key and check constraitns.

Why is this change needed?

The current db-structure schema drops the constraints data of tbls schema. Especially, check constraints of the schema can't be expressed with the current schema.
This PR will enhance the schema to adopt constraints data and prepare for implementing the UI using it.

What would you like reviewers to focus on?

implementation of the constraints schema
implementation of the tbls format parser with constraints

Testing Verification

add tests for the schema and parser

What was done

🤖 Generated by PR Agent at `8acfdbe`

Introduced support for database constraints in schema definitions.
- Added support for PRIMARY KEY, FOREIGN KEY, UNIQUE, and CHECK constraints.
- Enhanced schema parsing to include constraints for various database parsers.
Updated test cases to validate new constraint functionalities.
- Added tests for PRIMARY KEY, FOREIGN KEY, UNIQUE, and CHECK constraints.
- Verified error handling for duplicate constraints in overrides.
Enhanced override functionality to support adding constraints to existing tables.
Updated schema definitions to include constraints and their types.

Detailed Changes

Relevant files

Enhancement

8 files

parser.ts `Add constraints handling to Prisma schema parser`	+5/-2
parser.ts `Add constraints handling to Schema.rb parser`	+4/-2
converter.ts `Add constraints handling to PostgreSQL schema converter`	+6/-2
parser.ts `Add constraints handling to tbls schema parser`	+66/-7
dbStructure.ts `Define schema for constraints and integrate into table schema`	+63/-15
factories.ts `Update table factory to include constraints`	+3/-0
index.ts `Export constraints-related types and schemas`	+2/-1
overrideDbStructure.ts `Add support for overriding constraints in database structure`	+26/-3

Tests

2 files

index.test.ts `Add tests for constraints in tbls schema parser`	+169/-0
overrideDbStructure.test.ts `Add tests for overriding constraints in database structure`	+71/-0

Documentation

1 files

swift-keys-design.md `Add changeset for constraints enhancement`	+5/-0

Additional Notes

Need help?
Type /help how to ... in the comments thread for any questions about Qodo Merge usage.
Check out the documentation for more information.

changeset-bot · 2025-04-06T03:47:25Z

🦋 Changeset detected

Latest commit: f2f2abe

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 2 packages

Name	Type
@liam-hq/db-structure	Patch
@liam-hq/cli	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

vercel · 2025-04-06T03:47:26Z

@tnyo43 is attempting to deploy a commit to the ROUTE06 Core Team on Vercel.

A member of the Team first needs to authorize it.

tnyo43 · 2025-04-06T03:52:21Z

frontend/packages/db-structure/src/parser/prisma/parser.ts

@@ -95,6 +95,7 @@ async function parsePrismaSchema(schemaString: string): Promise<ProcessResult> {
      columns,
      comment: model.documentation ?? null,
      indices: {},
+      constraints: {},


This PR won't update the other format parsers other than tbls because I think it will make this change too large.

tnyo43 · 2025-04-06T03:57:38Z

frontend/packages/db-structure/src/schema/dbStructure.ts

-const cardinalitySchema = v.picklist(['ONE_TO_ONE', 'ONE_TO_MANY'])
-export type Cardinality = v.InferOutput<typeof cardinalitySchema>
-
-const foreignKeyConstraintSchema = v.picklist([


One of the new constraint schemas will be named as foreignKeyConstraintSchema, so it will rename this schema as foreignKeyConstraintReferenceOptionSchema (it's a little bit hard to find the diffs because this PR will change the order of declarations 😓 )

I refer to the MySQL document to to name the schema as ReferenceOption. https://dev.mysql.com/doc/refman/8.4/en/create-table-foreign-keys.html

LGTM 👍🏻

tnyo43 · 2025-04-06T04:09:30Z

frontend/packages/db-structure/src/schema/dbStructure.ts

+const primaryKeyConstraintSchema = v.object({
+  type: v.literal('PRIMARY KEY'),
+  name: constraintNameSchema,
+  columnNames: v.array(columnNameSchema),


You might not be considering adopting a composite key. If not, I'm planning to modify it like the follows and fix the related codes:

Suggested change

columnNames: v.array(columnNameSchema),

columnName: columnNameSchema,

We want to support composite keys because we want to accurately represent the state of our database.
However, I also feel that this is a feature that is not used very often. Please let me know if support would greatly complicate the implementation and experience.

qodo-merge-pro-for-open-source · 2025-04-06T04:10:12Z

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 3 🔵🔵🔵⚪⚪
🧪 PR contains tests
🔒 No security concerns identified
⚡ Recommended focus areas for review Constraint Validation The constraint parsing logic doesn't validate if the referenced tables and columns exist in the schema before creating foreign key constraints. This could lead to invalid references. if ( constraint.type === 'FOREIGN KEY' && constraint.columns?.length && // not unidefined and equal to or greater than 1 constraint.referenced_columns?.length === constraint.columns?.length && constraint.referenced_table ) { const { updateConstraint, deleteConstraint } = extractForeignKeyActions(constraint.def) constraints[constraint.name] = { type: 'FOREIGN KEY', name: constraint.name, columnNames: constraint.columns, targetTableName: constraint.referenced_table, targetColumnNames: constraint.referenced_columns, updateConstraint, deleteConstraint, } Type Consistency The ForeignKeyConstraintReferenceOption type is used in multiple places but defined only once. Ensure consistent naming and usage across the codebase. const foreignKeyConstraintReferenceOptionSchema = v.picklist([ 'CASCADE', 'RESTRICT', 'SET_NULL', 'SET_DEFAULT', 'NO_ACTION', ]) export type ForeignKeyConstraintReferenceOption = v.InferOutput< typeof foreignKeyConstraintReferenceOptionSchema >

the current `foreignKeyConstraintSchema` does not represents foreign key constraint itself but its reference option. I refer to the MySQL document to to name the schema as `ReferenceOption` ref: https://dev.mysql.com/doc/refman/8.4/en/create-table-foreign-keys.html

…ite key

tnyo43 · 2025-04-06T04:53:55Z

frontend/packages/db-structure/src/schema/overrideDbStructure.ts

- * 1. Apply overrides to existing tables (e.g., replacing comments)
- * 2. Add new columns to existing tables
- * 3. Add new relationships
- * 4. Process and merge table groups from both original structure and overrides
+ * 1. Apply overrides to existing tables
+ * 1.1. Replace comments
+ * 1.2. Add new columns
+ * 1.3. Add new constraints
+ * 2. Add new relationships
+ * 3. Process and merge table groups from both original structure and overrides


I arranged it a little because I think "adding new columns" step is a part of "applying overrides to existing tables". Does that align with your intention?

Sorry, we now have a policy of not unnecessarily adding more information to overrideDbStructure. Can you turn it off now?

ref: Simplify DB override structure to focus on essential features #1194

MH4GF

Thanks!! almost good, please check comments!

MH4GF · 2025-04-08T03:11:53Z

frontend/packages/db-structure/src/schema/dbStructure.ts

-const cardinalitySchema = v.picklist(['ONE_TO_ONE', 'ONE_TO_MANY'])
-export type Cardinality = v.InferOutput<typeof cardinalitySchema>
-
-const foreignKeyConstraintSchema = v.picklist([


LGTM 👍🏻

MH4GF · 2025-04-08T03:14:31Z

frontend/packages/db-structure/src/schema/dbStructure.ts

+const primaryKeyConstraintSchema = v.object({
+  type: v.literal('PRIMARY KEY'),
+  name: constraintNameSchema,
+  columnNames: v.array(columnNameSchema),


We want to support composite keys because we want to accurately represent the state of our database.
However, I also feel that this is a feature that is not used very often. Please let me know if support would greatly complicate the implementation and experience.

MH4GF · 2025-04-08T03:18:02Z

frontend/packages/db-structure/src/schema/overrideDbStructure.ts

- * 1. Apply overrides to existing tables (e.g., replacing comments)
- * 2. Add new columns to existing tables
- * 3. Add new relationships
- * 4. Process and merge table groups from both original structure and overrides
+ * 1. Apply overrides to existing tables
+ * 1.1. Replace comments
+ * 1.2. Add new columns
+ * 1.3. Add new constraints
+ * 2. Add new relationships
+ * 3. Process and merge table groups from both original structure and overrides


Sorry, we now have a policy of not unnecessarily adding more information to overrideDbStructure. Can you turn it off now?

ref: Simplify DB override structure to focus on essential features #1194

tnyo43 commented Apr 6, 2025

View reviewed changes

tnyo43 marked this pull request as ready for review April 6, 2025 04:09

tnyo43 requested a review from a team as a code owner April 6, 2025 04:09

tnyo43 requested review from hoshinotsuyoshi, FunamaYukina, junkisai, MH4GF and NoritakaIkeda and removed request for a team April 6, 2025 04:09

qodo-merge-pro-for-open-source bot added the Review effort 3/5 label Apr 6, 2025

This comment was marked as resolved.

Sign in to view

tnyo43 added 9 commits April 6, 2025 13:12

✨ add constraints schemas definitions

ed1cac4

✨ apply constraint override in applyOverrides function

d9b9497

✨ apply constraints to aTable function

a5d8545

✨ add empty constraints for now for each parser

3763bdc

🐛 fix column fields types to accept arrays of column names for compos…

279d3db

…ite key

✨ parse constraints of tbls schema

fa7a675

🔧 update snapshot

cf86442

🔧 add changeset

f67e2df

tnyo43 force-pushed the feat/add-constraints branch from 8acfdbe to f67e2df Compare April 6, 2025 04:51

tnyo43 commented Apr 6, 2025

View reviewed changes

🔧 fix logic

f2f2abe

MH4GF requested changes Apr 8, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

✨ feat: enhance schema to adopt `constraints` data #1168

✨ feat: enhance schema to adopt `constraints` data #1168

tnyo43 commented Apr 6, 2025 •

edited by qodo-merge-pro-for-open-source bot

Loading

changeset-bot bot commented Apr 6, 2025 •

edited

Loading

vercel bot commented Apr 6, 2025

tnyo43 Apr 6, 2025

tnyo43 Apr 6, 2025

MH4GF Apr 8, 2025

tnyo43 Apr 6, 2025

MH4GF Apr 8, 2025

qodo-merge-pro-for-open-source bot commented Apr 6, 2025

This comment was marked as resolved.

tnyo43 Apr 6, 2025

MH4GF Apr 8, 2025

MH4GF left a comment

MH4GF Apr 8, 2025

MH4GF Apr 8, 2025

MH4GF Apr 8, 2025

	columnNames: v.array(columnNameSchema),
	columnName: columnNameSchema,

✨ feat: enhance schema to adopt constraints data #1168

Are you sure you want to change the base?

✨ feat: enhance schema to adopt constraints data #1168

Conversation

tnyo43 commented Apr 6, 2025 • edited by qodo-merge-pro-for-open-source bot Loading

Issue

Why is this change needed?

What would you like reviewers to focus on?

Testing Verification

What was done

🤖 Generated by PR Agent at 8acfdbe

Detailed Changes

Additional Notes

changeset-bot bot commented Apr 6, 2025 • edited Loading

🦋 Changeset detected

vercel bot commented Apr 6, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

qodo-merge-pro-for-open-source bot commented Apr 6, 2025

PR Reviewer Guide 🔍

This comment was marked as resolved.

Choose a reason for hiding this comment

Choose a reason for hiding this comment

MH4GF left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

✨ feat: enhance schema to adopt `constraints` data #1168

✨ feat: enhance schema to adopt `constraints` data #1168

tnyo43 commented Apr 6, 2025 •

edited by qodo-merge-pro-for-open-source bot

Loading

🤖 Generated by PR Agent at `8acfdbe`

changeset-bot bot commented Apr 6, 2025 •

edited

Loading