drizzle-team / drizzle-team/drizzle-orm

[FEATURE]: Add a possibility to add a comment on a Table, Column.......

Open
#886 48 comments 280 reactions 0 assignees View on GitHub
drizzle/kit enhancement
Dominant language
TypeScript
Stars
35.8k
Forks
1.6k
Avg merge
2d 7h
Merged PRs (30d)
4

Description

### Describe what you want

It would be great to add a comment on Tables, Columns .... So that you can describe the tables, columns in the drizzle-orm model and it's also in the database, e.g. a database admin also needs this info in the db.

Maybe like this:

```
export const DbRole = pgTable("role", {
name: varchar("name", { length: 256 }).notNull().comment("The name of role, ....."),
description: varchar("description", { length: 256, }).comment("The description, ....."),

isActive: boolean("is_active").default(true).notNull().comment(" ....."),
allowSignup: boolean("allow_signup").default(false).comment("....."),
allowExternal: boolean("allow_external").default(false.comment("....."),
}).comment("The role .....");
```

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.