setting COMMENT on columns and tables (PostgreSQL)

[ulo]

Issue type:

[ ] question
[ ] bug report
[x] feature request
[ ] documentation issue

Database system/driver:

[ ] cordova
[ ] mongodb
[ ] mssql
[ ] mysql / mariadb
[ ] oracle
[x] postgres
[ ] sqlite
[ ] sqljs
[ ] react-native
[ ] expo

TypeORM version:

[x] latest
[ ] @next
[ ] 0.x.x (or put your version here)

Feature request:
When I define my entities I would like to be able to set a COMMENT to the database object. From looking at the source code this seems to be currently possible only for MySQL and not for PostgreSQL:

@Entity()
export class User {
  ...
  @Column({comment: 'The age in years.'})  // <--
  age: number
}

Using PostgreSQL one can also set a COMMENT on the table itself, which is not yet supported by TypeORM at all, but could look like this:

@Entity({comment: 'A user profile in the wep app.'})  // <--
export class User {
  ...
  @Column({comment: 'The age in years.'})
  age: number
}

I am asking for this feature as I am using the awesome PostGraphile tool, which heavily relies on COMMENTs for its configuration, and it would be really useful to do this by using TypeORM entity decorators!!

Many thanks,
Ulrich

[pleerock]

Feature is opened for contributions!

[vlapo]

This should be fixed also for mysql. And investigate comments in all supported databases and implemented it too.

[Diluka]

Please save comment in meta first. It helps generating API docs.

[auerbachb]

+1
(it should be noted that as of this post, adding comments to the args for typeorm for the @Column() decorator does not break anything, but also does not modify the psql database (ie it fails silently)

[imnotjames]

Code in #6902 is ready to go, has tests, should be good to merge.

[AlainBartmanDilaw]

This should be fixed also for mysql. And investigate comments in all supported databases and implemented it too.

Has this feature been implemented for mysql databases ?

[derushio]

@Entity({comment: 'A user profile in the wep app.'})
export class User {
...
}

Is this option not implemented?

[nawaz-pasha]

@Entity({comment: 'A user profile in the wep app.'})
export class User {
...
}

Is this option not implemented?

Don't think so.

Looks like as part of the PR #6902, only column comments support was added. Is there a different issue for table comments support?

[manoger]

@vlapo, I'm facing the same issue as mentioned above by @derushio and @nawaz-pasha .

[gabbrieu]

Any news to table comments? (MySQL)

It would be good if it were implemented to EntitySchema as well

[Josefh90]

can we reopen this ? i dont think that table comments are implemented

[block2k]

table comments are not implement