JPA @column аннотацию, чтобы создать комментарий/описание

Question

мне было интересно, можно ли создать из JPA/спящий режим аннотацию описание столбца базы данных/комментарий, как это:

ALTER TABLE tablename CHANGE status status INT(11) NOT NULL COMMENT 'sample description/comment';

Это будет большой функциональностью, но Я не могу найти что-либо об этом в спецификации JPA.

Может быть, я должен использовать свойство @Column(columnDefinition=""), но у меня нет подсказки. Пожалуйста, помогите

Answer 1

Я нашел ответ на свой вопрос.

Я не уверен, это нормально? Будет ли он работать для всех баз данных?

Обязательно он работает для mysql.

Вот рабочий код:

@Column(columnDefinition=" INT(11) NOT NULL COMMENT '0 for no action, 1 for executed, 2 for validated, 3 for aproved'") 
private int status; 

Answer 2

Хотя Hibernate отображение необходимо для отображения доменных моделей для реляционных данных, это не очень хорошая идея, чтобы растянуть эту функцию для создания схемы базы данных тоже.

Это может работать для относительно небольшого проекта, но когда у вас есть приложение среднего и крупного предприятия, которое развивается с каждой итерацией Sprint, вам понадобится инструмент миграции схемы базы данных, например Flyway.

Комментарий не требует сопоставления модели домена, так как это реляционное специфическое описание. Модель домена должна использовать JavaDocs для документирования каждого значения поля (в соответствии с определенным требованием логики домена).

Answer 3

Описание комментария уже существует для Таблица аннотации. Для этого мы должны использовать аннотацию Hibernate @Table, дополняющую аннотацию JPA @Table.

Например:

@javax.persistence.Table(name = "Cat") 
@org.hibernate.annotations.Table(comment = "Table for cats") 
public class Cat { 
... 

Что касается комментария столбца: Кажется, нет никакого эквивалента, даже в Hibernate 5.2/JPA 2.1.

Была проблема, представленная давным-давно (2007) по этому вопросу, но все еще не решена: Support @Comment or column attribute on @Table and @Column. Заброшены с 2012 года?

Я также нашел применение в комментарий org.hibernate.dialect.Dialect:

/** 
* Does this dialect/database support commenting on tables, columns, etc? 
* 
* @return {@code true} if commenting is supported 
*/ 
public boolean supportsCommentOn() { 
    return false; 
} 

/** 
* Get the comment into a form supported for table definition. 
* 
* @param comment The comment to apply 
* 
* @return The comment fragment 
*/ 
public String getTableComment(String comment) { 
    return ""; 
} 

/** 
* Get the comment into a form supported for column definition. 
* 
* @param comment The comment to apply 
* 
* @return The comment fragment 
*/ 
public String getColumnComment(String comment) { 
    return ""; 
} 

Например PostgreSQL81Dialect поддерживает его (supportsCommentOn() возвращает истину).

Он позволяет использовать команду SQL «COMMENT ON ...», , как в PostgreSQL (https://www.postgresql.org/docs/current/static/sql-comment.html).
Например:

COMMENT ON TABLE my_schema.my_table IS 'Employee Information'; 
COMMENT ON COLUMN my_table.my_column IS 'Employee ID number'; 

Это, кажется, используется там: org.hibernate.tool.schema.internal.StandardTableExporter # getSqlCreateStrings

комментарий колонны извлекают из спящего режима отображения с org.hibernate.mapping.Column # getComment.

Наконец, при использовании Hibernate Tools и обратное проектирование, комментарий столбца извлекается из JDBC DatabaseMetaData с org.hibernate.cfg.reveng.BasicColumnProcessor # processBasicColumns.

-> String comment = (String) columnRs.get("REMARKS");