HSEARCH-5160 Add a note about Lucene 10 backend

hibernate · Dec 5, 2024 · 9fb1316 · 9fb1316
1 parent 277b5d9
commit 9fb1316
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 1 deletion.
diff --git a/documentation/pom.xml b/documentation/pom.xml
@@ -337,6 +337,7 @@
                         <jakartaPersistenceVersion>${parsed-version.jakarta.persistence.majorVersion}.${parsed-version.jakarta.persistence.minorVersion}</jakartaPersistenceVersion>
                         <jandexPluginVersion>${version.jandex.plugin}</jandexPluginVersion>
                         <luceneVersion>${version.org.apache.lucene}</luceneVersion>
+                        <lucene10Version>${version.org.apache.lucene10}</lucene10Version>
                         <luceneUrl>https://lucene.apache.org</luceneUrl>
                         <luceneJavadocUrl>${javadoc.org.apache.lucene.core.url}</luceneJavadocUrl>
                         <luceneAnalysisCommonJavadocUrl>${javadoc.org.apache.lucene.analysis.common.url}</luceneAnalysisCommonJavadocUrl>

diff --git a/documentation/src/main/asciidoc/public/reference/_compatibility.adoc b/documentation/src/main/asciidoc/public/reference/_compatibility.adoc
@@ -21,7 +21,7 @@
 |
 |Apache Lucene (for the <<backend-lucene,Lucene backend>>)
 |{luceneVersion}
-|
+|Or Lucene {lucene10Version} when using the JDK 21+ and <<other-integrations-lucene10,different Maven artifacts>>.
 |Elasticsearch server (for the <<backend-elasticsearch,Elasticsearch backend>>)
 |{elasticsearchCompatibleVersions}
 |Most of older minor versions (e.g. {elasticsearchOtherPotentiallyCompatibleVersions}) are not given priority for bugfixes and new features.

diff --git a/documentation/src/main/asciidoc/public/reference/_integrations.adoc b/documentation/src/main/asciidoc/public/reference/_integrations.adoc
@@ -25,3 +25,28 @@ Check the https://hibernate.org/search/releases/#compatibility-matrix[compatibil
 to find versions of Hibernate Search compatible with these older versions of Hibernate ORM.
 
 Use <<other-integrations-jakarta,Hibernate ORM 7>> instead.
+
+[[other-integrations-lucene10]]
+== Lucene 10
+
+Hibernate Search {hibernateSearchVersionShort} provides two variations of the <<backend-lucene,Lucene backend>>.
+
+The default one, that works with JDK 17+ and uses Lucene {luceneVersion}:
+
+[source, XML, subs="+attributes"]
+----
+<dependency>
+    <groupId>org.hibernate.search</groupId>
+    <artifactId>hibernate-search-backend-lucene</artifactId>
+</dependency>
+----
+
+And the Lucene {lucene10Version} based one, that requires JDK 21+:
+
+[source, XML, subs="+attributes"]
+----
+<dependency>
+    <groupId>org.hibernate.search</groupId>
+    <artifactId>hibernate-search-backend-lucene10</artifactId>
+</dependency>
+----