From afa3e027f598e66d829d41c1054c3db2aa4cec85 Mon Sep 17 00:00:00 2001 From: marko-bekhta Date: Fri, 6 Sep 2024 15:06:43 +0200 Subject: [PATCH] HSEARCH-5180 Add a note on logged message format and API change to the migration guide --- .../src/main/asciidoc/migration/index.adoc | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/documentation/src/main/asciidoc/migration/index.adoc b/documentation/src/main/asciidoc/migration/index.adoc index 9ff66e5e1e9..bc3e40dc9bb 100644 --- a/documentation/src/main/asciidoc/migration/index.adoc +++ b/documentation/src/main/asciidoc/migration/index.adoc @@ -88,17 +88,27 @@ are backward-compatible with Hibernate Search {hibernateSearchPreviousStableVers The https://hibernate.org/community/compatibility-policy/#code-categorization[API] in Hibernate Search {hibernateSearchVersion} -is backward-compatible with Hibernate Search {hibernateSearchPreviousStableVersionShort}. +is, in general, backward-compatible with Hibernate Search {hibernateSearchPreviousStableVersionShort}. +But there are next changes: + +- An incubating `org.hibernate.search.mapper.pojo.standalone.loading.MassIdentifierLoader` changed the return type of `#totalCount()` from `long` to `OptionalLong`. +This was done to address the scenarios where the total number of identifiers to load is not known ahead of time. [[spi]] == SPI The https://hibernate.org/community/compatibility-policy/#code-categorization[SPI] in Hibernate Search {hibernateSearchVersion} -is backward-compatible with Hibernate Search {hibernateSearchPreviousStableVersionShort}. +is, in general, backward-compatible with Hibernate Search {hibernateSearchPreviousStableVersionShort}. +But there are next changes: + +- `org.hibernate.search.mapper.pojo.loading.spi.PojoMassIdentifierLoader` also changed the return type of `#totalCount()` from `long` to `OptionalLong` +to reflect the changes in the `org.hibernate.search.mapper.pojo.standalone.loading.MassIdentifierLoader` [[behavior]] == Behavior The behavior of Hibernate Search {hibernateSearchVersion} -is backward-compatible with Hibernate Search {hibernateSearchPreviousStableVersionShort}. +is, in general, backward-compatible with Hibernate Search {hibernateSearchPreviousStableVersionShort}. + +The default mass indexer logging monitor updated the format of the logged messages to provide the information in a more condense form.