Skip to content

Commit

Permalink
update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
juergen-plohn committed Aug 25, 2023
1 parent 4701684 commit 55df0bc
Showing 1 changed file with 12 additions and 4 deletions.
16 changes: 12 additions & 4 deletions persistence-utils-product/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,16 +19,24 @@ Axon Ivy's JPA Persistence Lib utility helps you accelerate process automation i
- [APS-156](https://1ivy.atlassian.net/browse/APS-156) Fix handling of session in CriteriaQueryContext
- [APS-86](https://1ivy.atlassian.net/browse/APS-86) Use Instant for Auditable Entities create/update/delete
- [APS-87](https://1ivy.atlassian.net/browse/APS-87) Rename isEnabled in ToggleableEntity
- [APS-158](https://1ivy.atlassian.net/browse/APS-158) Refactor Type hirachy for Auditable- and ToggleableEntity

*Incompatibilities*
- Datatype of **AuditableEntity**s **Header** attributes for create/update and delete date where changed to *Instant*
- Attribute **expiryDate** of **ToggleableEntity** has been renamed to **expiry** and its datatype changed to *Instant*
- Datatype of **ToggleableEntity**s **enabled** has been changed to boolean

:exclamation::exclamation: **NOTE: This update contains major changes to column names and datatypes as well as refactoring of entity and DAO structure.**
**Please refer to the list of changes mentioned here and in the recommendations** :exclamation::exclamation:

- Datatype of `AuditableEntity`s `Header` attributes for create/update and delete date where changed to `Instant`
- Attribute `expiryDate` of `ToggleableEntity` has been renamed to **expiry** and its datatype changed to `Instant`
- Datatype of `ToggleableEntity`s **enabled** has been changed to boolean
- `AuditableEntity` and `ToggleableEntity` are now derived from `VersionableEntity` instead of `GenericIdEntity`
- To provide a version of the changed Entities with a predefined `String` id the new Entities `AuditableIdEntity` and `ToggleableIdEntity` and matching DAOs have been introduced

*Recommendations*
- rename the expiry column to **expiry** unless you have customized the column names anyways. e.g. ALTER TABLE **yourtable** RENAME COLUMN **expiryDate** TO **expiry**.
- Make sure there are no *NULL* values for the **enabled** column in your database. The column was defined as not nullable, so only manual changes in the database should have lead to *NULL* values
- use *get/set...AsDate* or *get/set...AsLocalDateTime* methods to get converted datatypes of create/update/delete/expiry *Instant*s
- use `get/set...AsDate` or `get/set...AsLocalDateTime` methods if you need to get converted datatypes of create/modify/delete/expiry `Instant`s
- Change usage of `AuditableEntity` and `ToggleableEntity` to `AuditableIdEntity` and `ToggleableIdEntity`. Use matching DAOs

### 10.0.3
*Changes*
Expand Down

0 comments on commit 55df0bc

Please sign in to comment.