Interface CommentOptions

@Comment decorator for database schema annotations

Provides the ability to add comments to various database objects:

• Table-level comments (on model classes)
• Column-level comments (on model fields)
• Index comments
• Constraint comments

Usage:

 @Comment('This table stores user information')
 class User extends Model { ... }

 @Column
 @Comment('User unique identifier')
 id: number;

 @Column
 @Comment('User email address')
 email: string;
Copy