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

[snaidaGithub]

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 .....");

[lefnire]

+1 for this. There are two important value-adds here:

1. DB admin side, seeing what a column is for. Either at the SQL level (viewing a schema via DataGrip or whatever); or the code-level, a new dev looking through the schemas trying to understand the data layer. We're facing this issue currently, and of course the solution is code-level comments // number of employees at this organization. But:
2. Dynamic usage. I'm working with GPT Functions for inserting data via Chat. If I had .comment(), I could table.reduce(...) the whole thing into JSON Schema where OpenAI requires parameter descriptions. For now I'm just copy/pasting all the schemas.

Obviously not critical, but a nice ergnomic.

[aflatoon2874]

+1 for this. There are two important value-adds here:

1. DB admin side, seeing what a column is for. Either at the SQL level (viewing a schema via DataGrip or whatever); or the code-level, a new dev looking through the schemas trying to understand the data layer. We're facing this issue currently, and of course the solution is code-level comments // number of employees at this organization. But:
2. Dynamic usage. I'm working with GPT Functions for inserting data via Chat. If I had .comment(), I could table.reduce(...) the whole thing into JSON Schema where OpenAI requires parameter descriptions. For now I'm just copy/pasting all the schemas.

Obviously not critical, but a nice ergnomic.

+1
I want to add point 3
3. Comments are critical to the functioning and security implementation for postgraphile v5 graphql implementation. Postgraphile v5 uses column and table level comments extensively for defining behaviours that are used by postgraphile runtime engine.

[kiwamizamurai]

Any updates on this??

[expressgy]

I am very much looking forward to this feature，COMMENT

[Ivan-Baranov]

+1

[lebonnet]

+1

[ohbayashi-fvs]

+1

[vadimshvetsov]

This is especially essential, given that AI might leverage database schemas for insights and data transformations.

[arb85]

+1

[joonhoekim]

How about this approach?

1. Use a special comment prefix //c: to mark comments intended for the database
2. These comments apply to the table or column declaration on the line immediately following the comment (ignoring blank lines and comments without prefix)
3. During migration, parse these comments and convert them to database COMMENT statements

// schema example

//c: User account information table
export const users = pgTable('users', {
  //c: Unique user identifier
  id: serial('id'),
  
  //c: User's email address
  email: varchar('email', { length: 255 }),
});

[arvinxx]

really need it too

[vroshupkin]

+1

[vamonke]

+1