Skip to content

Commit 578f5b0

Browse files
pfhartmabwaldvogel
authored andcommitted
README: Minor wording changes
1 parent 2ee19d4 commit 578f5b0

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,15 +26,16 @@ Add the following Maven **runtime** dependency to your project:
2626

2727
### Hibernate
2828

29-
Users of Hibernate typically annotate the enum columns with
29+
For Hibernate entities, we recommend annotating attributes of enum type as shown below:
3030
```java
3131
@JdbcType(PostgreSQLEnumJdbcType.class)
3232
Status status;
3333
```
34-
where `Status` is an enum class.
3534

3635
## Commands ##
3736

37+
The library provides additional liquibase commands, that can be used within a `changeSet`:
38+
3839
### Creating an enum type
3940

4041
```xml
@@ -55,8 +56,8 @@ where `Status` is an enum class.
5556

5657
### Removing one or more values of an existing enum
5758

58-
PostgreSQL does not yet support removing of values of an existing enum. Instead, we implement a workaround described in
59-
https://blog.yo1.dog/updating-enum-values-in-postgresql-the-safe-and-easy-way/ by replacing the enum with a new enum type that has different values.
59+
PostgreSQL does not yet support removing of values of an existing enum. Instead, we implement a workaround
60+
by replacing the enum with a new enum type that has different values (as described in [this blog post][yo1dog-blog]).
6061

6162
⚠ You need to be extra careful when you drop an enum value! First, you need to update the existing tables
6263
to make sure that the value is not used anymore, typically using an `UPDATE` statement.
@@ -84,3 +85,4 @@ to make sure that the value is not used anymore, typically using an `UPDATE` sta
8485

8586
[postgresql-enums]: https://www.postgresql.org/docs/current/datatype-enum.html
8687
[liquibase-changelog-generator]: https://github.com/cronn/liquibase-changelog-generator
88+
[yo1dog-blog]: https://blog.yo1.dog/updating-enum-values-in-postgresql-the-safe-and-easy-way/

0 commit comments

Comments
 (0)