diff --git a/src/main/java/com/avaje/ebean/dbmigration/package-info.java b/src/main/java/com/avaje/ebean/dbmigration/package-info.java index e69de29bb..b4fed1868 100644 --- a/src/main/java/com/avaje/ebean/dbmigration/package-info.java +++ b/src/main/java/com/avaje/ebean/dbmigration/package-info.java @@ -0,0 +1,8 @@ +/** + * Generation DDL migration scripts based on changes to the model. + *
+ * You can use DbMigration to compare the entity bean model to its prior state
+ * and generate DDL for the differences - adding tables, columns etc.
+ *
- * You can use DbMigration to compare the entity bean model to its prior state
- * and generate DDL for the differences - adding tables, columns etc.
+ * Although you can build something similar using existing event adapters such as BeanPersistController
+ * this is built for purpose to reduce the effort and provide optimal performance for auditing or logging changes.
+ *
+ * By default you can annotate beans with @ChangeLog and associated change events are logged by default
+ * in a JSON form with appropriate auditing attributes such as who made the changes and ip address of the user etc
+ * via implementation of ChangeLogPrepare
*
- * You can use DbMigration to compare the entity bean model to its prior state
- * and generate DDL for the differences - adding tables, columns etc.
+ * Provides a built support for supplied an audit of all the 'read events' for beans annotated
+ * with @ReadAudit
*