Release 4.0

This version of the XTDB Repository Connector is compatible with V4.x of Egeria

What's Changed

What's Changed

• Initial basis for Egeria 4.0 by @cmgrote in #462
• Build automation revisions by @cmgrote in #463
• Gradle refactoring by @planetf1 in #467
• Fix aggregateJavadoc (add back plugin) by @planetf1 in #468
• #471 creates separate temporary config file per server by @cmgrote in #474
• Update Egeria to 4.0 by @mandy-chessell in #476
• Update version for release by @mandy-chessell in #477
• Prevent parallel release builds by @mandy-chessell in #478
• #479 fix signing of release artifact by @planetf1 in #480

New Contributors

• @mandy-chessell made their first contribution in #476

Full Changelog: v3.15...v4.0

Classification implementation

🎉 New features

• Implements new classification methods that operate on EntityProxy objects.
• Implements the getHomeClassifications method variant that allows point-in-time inquiry.

🐞 Fixes

• Updates of all dependencies to latest versions, including XTDB itself (to 1.23.0).

🧑‍🔧 Migration

• Same as v3.4 -- no new persistence in this release compared to v3.4.

🔨 Dependencies

• Egeria core 3.15

classifyEntity fixes

🐞 Fixes

• Corrects behaviour of classifyEntity methods, including those that operate on entity proxies.
• Updates of all dependencies to latest versions, including XTDB itself (to 1.22.1).

🧑‍🔧 Migration

• Same as v3.4 -- no new persistence in this release compared to v3.4.

🔨 Dependencies

• Egeria core 3.14

Classification fix

🐞 Fixes

• Corrects an error where classifications could not be applied to entity proxies (#390).
• Updates of all dependencies to latest versions, including XTDB itself (to 1.21.0.1).

🧑‍🔧 Migration

• Same as v3.4 -- no new persistence in this release compared to v3.4.

🔨 Dependencies

• Egeria core 3.10

Dependency updates

🐞 Fixes

• Updates of all dependencies to latest versions, including XTDB itself (to 1.21.0).

🧑‍🔧 Migration

• Same as v3.4 -- no new persistence in this release compared to v3.4.

🔨 Dependencies

• Egeria core 3.9

Dependency updates

🔒 Security fixes

• Updates various second-degree dependencies to remove potential risks from published CVEs

🐞 Fixes

• Fixes minor issue with type comparisons using .equals() [#351]
• Updates of all dependencies to latest versions

🧑‍🔧 Migration

• Same as v3.4 -- no new persistence in this release compared to v3.4.

🔨 Dependencies

• Egeria core 3.8

Security and bug fixes

🔒 Security fixes

• Updates httpclient library dependency to address GHSA-hwvm-vfw8-93mw

🐞 Bug fixes

• Fixes a search edge case that could result in xtdb.IllegalArgumentException [#310]

🧑‍🔧 Migration

• Same as v3.4 -- no new persistence in this release compared to v3.4.

🔨 Dependencies

• Egeria core 3.6

Bug fixes

🐞 Bug fixes

• Fixes a troublesome bug that could cause all update operations to fail with an exception depending on the users doing the operations [#278] (thanks to @Inventoroz for discovering!)

🧑‍🔧 Migration

• Same as v3.3 -- no new persistence in this release compared to v3.3.

🔨 Dependencies

• Egeria core 3.4

Performance

🚀 Performance improvements

• Replaces default sorting of all search operations with a lazy evaluation of results rather than forcing a GUID-based default sort, to significantly improve performance (particularly at large volumes) for search operations that have no explicit sort order requested.
• For an extra little boost, using LMDB appears to be the fastest option as the index store.

🐞 Bug fixes

• Fix to allow classifications to be persisted against EntityProxies.

🧑‍🔧 Migration

• Same as v3.2 -- no new persistence in this release compared to v3.2.

🔨 Dependencies

• Egeria core 3.3

Consistency

🎉 New features

• Crux has been renamed XTDB, and as a result we've renamed the connector!
• Write operations are now ACID compliant by making use of XTDB's transaction function capability.
• Read operations now all ensure they use the same singular XTDB resource, even when multiple reads may be necessary to compose the result of an operation, ensuring that the reads are atomically consistent as well.

🧑‍🔧 Migration

• Given the rename, the cruxConfig should now use the xtdb namespace / prefix everywhere rather than crux (and it's now xtdbConfig rather than cruxConfig).
• Given the migration to the new XTDB-native Lucene index, you should allow XTDB to re-index itself by following XTDB's instructions for rebuilding indexes.
• Any metadata in an existing 3.1 (or earlier) Crux repository will need to be migrated (see the Migration Guide); this step is not necessary for a new repository on 3.2.

⚠️ Note

• Note that as the configuration for Lucene is now using XTDB's built-in support, your configuration document should no longer use the egeria.crux.lucene/lucene-store module but instead should now use the xtdb.lucene/lucene-store module. If all you've defined is the db-dir parameter that can remain the same (though note need to re-index above); however, with the native XTDB Lucene index you should now have additional options for configuring Lucene as well.

🔨 Dependencies

• Egeria core 3.2