Skip to content

Commit f1d1235

Browse files
committed
Update the CHANGELOG
1 parent a96b747 commit f1d1235

1 file changed

Lines changed: 111 additions & 0 deletions

File tree

CHANGELOG.md

Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,116 @@
11
# CHANGELOG #
22

3+
## 6.0.0 ##
4+
5+
This release saw major improvements and some breaking changes. The release is
6+
a dramatic improvement of the library, because it adds:
7+
8+
* Java11 support
9+
* Improved Type Safety
10+
* Internal Refactorings to improve maintainability
11+
* Build Pipelines
12+
* Code Coverage
13+
* Dependency updates
14+
15+
All of this great work was done by [@jonfreedman](https://github.com/jonfreedman).
16+
17+
### Packages ###
18+
19+
There is a major change in how the library is released. The project now
20+
targets both Java8 and Java11. You are able to use the JDK8 version by
21+
appending "-jdk8" to the Maven Package name.
22+
23+
So for Java8 you have to use the following dependencies:
24+
25+
```java
26+
<dependency>
27+
<groupId>de.bytefish.pgbulkinsert</groupId>
28+
<artifactId>pgbulkinsert-core-jdk8</artifactId>
29+
<version>6.0.0</version>
30+
</dependency>
31+
<dependency>
32+
<groupId>de.bytefish.pgbulkinsert</groupId>
33+
<artifactId>pgbulkinsert-rowwriter-jdk8</artifactId>
34+
<version>6.0.0</version>
35+
</dependency>
36+
<dependency>
37+
<groupId>de.bytefish.pgbulkinsert</groupId>
38+
<artifactId>pgbulkinsert-jpa-jdk8</artifactId>
39+
<version>6.0.0</version>
40+
</dependency>
41+
```
42+
43+
So for Java8 you have to use the following dependencies:
44+
45+
```java
46+
<dependency>
47+
<groupId>de.bytefish.pgbulkinsert</groupId>
48+
<artifactId>pgbulkinsert-core-jdk8</artifactId>
49+
<version>6.0.0</version>
50+
</dependency>
51+
<dependency>
52+
<groupId>de.bytefish.pgbulkinsert</groupId>
53+
<artifactId>pgbulkinsert-rowwriter-jdk8</artifactId>
54+
<version>6.0.0</version>
55+
</dependency>
56+
<dependency>
57+
<groupId>de.bytefish.pgbulkinsert</groupId>
58+
<artifactId>pgbulkinsert-jpa-jdk8</artifactId>
59+
<version>6.0.0</version>
60+
</dependency>
61+
```
62+
63+
### Breaking Changes ###
64+
65+
* ``PgBinaryWriter#open`` removed and now opened in constructor
66+
* ``SimpleRowWriter#open`` removed and now opened in constructor
67+
* ``SimpleRowWriter`` not implements the ``AutoClosable`` interface, so it can be used in try-with-resources blocks.
68+
* ``PostgreSqlUtils#tryGetPGConnection`` now returns an ``Optional``
69+
* ``BulkProcessor#cancel`` static method removed
70+
71+
### Additional Information ###
72+
73+
* Static Analysis has been added to the project using [Error Prone](https://github.com/google/error-prone)
74+
* Integration Tests are now run on every commit using Github Pipelines and the Postgres image.
75+
* There have been a lot of refactorings internally, so the overall maintainability is improved.
76+
* The project now has a Code Coverage report, so you get a feeling about the test coverage.
77+
* The README now has badges, so it is easier to see the latest stable release.
78+
79+
### Project development ###
80+
81+
* The project has been moved to an organization structure, so it easier to assign rights and collaborate.
82+
83+
## 5.1.0 ##
84+
85+
This release saw additions and refactorings of the JPA module. It now supports a lot more
86+
data types and is easier to configure by using annotations. If you want control over how
87+
the data is written to the database, you can use the ``@PostgresDataType`` annotation,
88+
which overrides the default values.
89+
90+
Here is an example for mapping a ``short`` value to an ``int4`` Postgres data type.
91+
92+
93+
```java
94+
@Entity
95+
@Table(name = "unit_test", schema = "public")
96+
public static class SampleEntity {
97+
98+
// ...
99+
100+
@Column(name = "some_field_name")
101+
@PostgresDataType(columnName = "some_field_name", dataType = DataType.Int4)
102+
private Short shortField;
103+
104+
public Short getShortField() {
105+
return shortField;
106+
}
107+
108+
public void setShortField(Short shortField) {
109+
this.shortField = shortField;
110+
}
111+
}
112+
```
113+
3114
## 5.0.0 ##
4115

5116
A lot of thanks to the great efforts of user [@cheffe](https://github.com/cheffe) in this release!

0 commit comments

Comments
 (0)