Drizzle Kit command that ensures schema validity

[L-Mario564]

Hello everyone, I'm here to propose a new feature for Drizzle Kit that will ensure that your Typescript schema is valid, avoiding unexpected behavior in the generated migration files.

Here's an example of how that would look like:

Schema:

const users = pgTable('users', {
  id: serial('id').primaryKey(),
  name: text('id').notNull() // The 'id' alias is already defined
});

const sessions = pgTable('sessions', {
  id: uuid('id').primaryKey(),
  userId: uuid('user_id').notNull().references(() => users.id) // This UUID field references a serial (integer) field
});

The new command (command name and args TBD):

> drizzle-kit check schema

Validating schema...
Invalid schema. Found 2 errors:
- Duplicate column alias "id" found in table "users"
- Column "user_id" in "sessions" is of type "uuid" but references column of type "integer"

Here's a list of validations this command would perform:

• No duplicate table names.
• No duplicate schema names.
• Ensure there aren't any collisions with table names and view names.
• No duplicate column names/aliases within a table.
• No duplicate constraint names (index, unique, check, PK, FK, etc.)
• Ensure the source columns and foreign columns in an FK are of the same data type.

I wanted to bring this idea in a public discussion to see what other developers think of this feature. Please let me know of any additions or changes you want to suggest in relation to this idea that could enhance the Drizzle ORM and Kit experience for every developer.

[kravetsone]

I guess somewho implement in PR

[L-Mario564]

I'll be implementing this with input from the team. I made this discussion in case anyone wants to provide feedback on this idea.

[davidgomes]

My only feedback is that this is a great idea. I've specifically been burned by this one several times in the past: Ensure the source columns and foreign columns in an FK are of the same data type..

But, when calling drizzle-kit generate, check should be called automatically right? I don't think this should just be an isolated command, but it should be called as part of generate automatically (besides also existing as a standalone command of course)

[AndriiSherman]

it can be both, a separate command and will be used inside generate command pipeline

[davidgomes]

👌 perfect

[L-Mario564]

A PR is now open where I implemented what I described in this discussion.
#3043