Adjust Rest5Client building by using and exposing the callbacks provided by the Elasticsearch Java client library.

Original Pull Request #3143
Closes #3129

Signed-off-by: Peter-Josef Meisch <pj.meisch@sothawo.com>

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,9 +1,17 @@
+<!--
+
 Thank you for proposing a pull request. This template will guide you through the essential steps necessary for a pull request.
+
+When contributing, please make sure an issue exists in issue tracker and comment on this issue with how you want to address it. By this we not only know that someone is working on an issue, we can also align architectural questions and possible solutions before work is invested . We so can prevent that much work is put into Pull Requests that have little or no chances of being merged.
+
 Make sure that:
 
+-->
+
 - [ ] You have read the [Spring Data contribution guidelines](https://github.com/spring-projects/spring-data-build/blob/master/CONTRIBUTING.adoc).
-- [ ] There is a ticket in the bug tracker for the project in our [JIRA](https://jira.spring.io/browse/DATAES).
+- [ ] **There is a ticket in the bug tracker for the project in our [issue tracker](https://github.com/spring-projects/spring-data-elasticsearch/issues)**. Add the issue number to the _Closes #issue-number_ line below
 - [ ] You use the code formatters provided [here](https://github.com/spring-projects/spring-data-build/tree/master/etc/ide) and have them applied to your changes. Don’t submit any formatting related changes.
 - [ ] You submit test cases (unit or integration tests) that back your changes.
 - [ ] You added yourself as author in the headers of the classes you touched. Amend the date range in the Apache license header if needed. For new types, add the license header (copy from another file and set the current year only).
-- [ ] You provide your full name and an email address registered with your GitHub account. If you’re a first-time submitter, make sure you have completed the [Contributor’s License Agreement form](https://support.springsource.com/spring_committer_signup).
+
+Closes #issue-number

.gitignore

@@ -1,21 +1,36 @@
-atlassian-ide-plugin.xml
-
-## Ignore svn files
-.svn
-
-## ignore any target dir
-target
-
-##ignore only top level data dir - local node data files for unit tests
-/data
-
-## Ignore project files created by Eclipse
-.settings
-.project
-.classpath
-
-## Ignore project files created by IntelliJ IDEA
-*.iml
-*.ipr
-*.iws
-.idea
+.DS_Store
+*.graphml
+.springBeans
+
+atlassian-ide-plugin.xml
+
+## Ignore svn files
+.svn
+
+## ignore any target dir
+target
+
+## Ignore project files created by Eclipse
+.settings
+.project
+.classpath
+
+## Ignore project files created by IntelliJ IDEA
+*.iml
+*.ipr
+*.iws
+.idea
+/.env
+
+
+/zap.env
+/localdocker.env
+.localdocker-env
+
+build/
+node_modules
+node
+package-lock.json
+
+.mvn/.develocity
+/src/test/resources/testcontainers-local.properties

.mvn/extensions.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<extensions>
+	<extension>
+		<groupId>io.spring.develocity.conventions</groupId>
+		<artifactId>develocity-conventions-maven-extension</artifactId>
+		<version>0.0.22</version>
+	</extension>
+</extensions>

.mvn/jvm.config

@@ -0,0 +1,14 @@
+--add-exports jdk.compiler/com.sun.tools.javac.api=ALL-UNNAMED
+--add-exports jdk.compiler/com.sun.tools.javac.file=ALL-UNNAMED
+--add-exports jdk.compiler/com.sun.tools.javac.main=ALL-UNNAMED
+--add-exports jdk.compiler/com.sun.tools.javac.model=ALL-UNNAMED
+--add-exports jdk.compiler/com.sun.tools.javac.parser=ALL-UNNAMED
+--add-exports jdk.compiler/com.sun.tools.javac.processing=ALL-UNNAMED
+--add-exports jdk.compiler/com.sun.tools.javac.tree=ALL-UNNAMED
+--add-exports jdk.compiler/com.sun.tools.javac.util=ALL-UNNAMED
+--add-opens jdk.compiler/com.sun.tools.javac.code=ALL-UNNAMED
+--add-opens jdk.compiler/com.sun.tools.javac.comp=ALL-UNNAMED
+--add-opens=java.base/java.util=ALL-UNNAMED
+--add-opens=java.base/java.lang.reflect=ALL-UNNAMED
+--add-opens=java.base/java.text=ALL-UNNAMED
+--add-opens=java.desktop/java.awt.font=ALL-UNNAMED

.mvn/wrapper/MavenWrapperDownloader.java

@@ -0,0 +1,115 @@
+
+/*
+ * Copyright 2007-present the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import java.net.*;
+import java.io.*;
+import java.nio.channels.*;
+import java.util.Properties;
+
+public class MavenWrapperDownloader {
+
+	private static final String WRAPPER_VERSION = "0.5.6";
+	/**
+	 * Default URL to download the maven-wrapper.jar from, if no 'downloadUrl' is provided.
+	 */
+	private static final String DEFAULT_DOWNLOAD_URL = "https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/"
+			+ WRAPPER_VERSION + "/maven-wrapper-" + WRAPPER_VERSION + ".jar";
+
+	/**
+	 * Path to the maven-wrapper.properties file, which might contain a downloadUrl property to use instead of the default
+	 * one.
+	 */
+	private static final String MAVEN_WRAPPER_PROPERTIES_PATH = ".mvn/wrapper/maven-wrapper.properties";
+
+	/**
+	 * Path where the maven-wrapper.jar will be saved to.
+	 */
+	private static final String MAVEN_WRAPPER_JAR_PATH = ".mvn/wrapper/maven-wrapper.jar";
+
+	/**
+	 * Name of the property which should be used to override the default download url for the wrapper.
+	 */
+	private static final String PROPERTY_NAME_WRAPPER_URL = "wrapperUrl";
+
+	public static void main(String args[]) {
+		System.out.println("- Downloader started");
+		File baseDirectory = new File(args[0]);
+		System.out.println("- Using transport directory: " + baseDirectory.getAbsolutePath());
+
+		// If the maven-wrapper.properties exists, read it and check if it contains a custom
+		// wrapperUrl parameter.
+		File mavenWrapperPropertyFile = new File(baseDirectory, MAVEN_WRAPPER_PROPERTIES_PATH);
+		String url = DEFAULT_DOWNLOAD_URL;
+		if (mavenWrapperPropertyFile.exists()) {
+			FileInputStream mavenWrapperPropertyFileInputStream = null;
+			try {
+				mavenWrapperPropertyFileInputStream = new FileInputStream(mavenWrapperPropertyFile);
+				Properties mavenWrapperProperties = new Properties();
+				mavenWrapperProperties.load(mavenWrapperPropertyFileInputStream);
+				url = mavenWrapperProperties.getProperty(PROPERTY_NAME_WRAPPER_URL, url);
+			} catch (IOException e) {
+				System.out.println("- ERROR loading '" + MAVEN_WRAPPER_PROPERTIES_PATH + "'");
+			} finally {
+				try {
+					if (mavenWrapperPropertyFileInputStream != null) {
+						mavenWrapperPropertyFileInputStream.close();
+					}
+				} catch (IOException e) {
+					// Ignore ...
+				}
+			}
+		}
+		System.out.println("- Downloading from: " + url);
+
+		File outputFile = new File(baseDirectory.getAbsolutePath(), MAVEN_WRAPPER_JAR_PATH);
+		if (!outputFile.getParentFile().exists()) {
+			if (!outputFile.getParentFile().mkdirs()) {
+				System.out.println("- ERROR creating output directory '" + outputFile.getParentFile().getAbsolutePath() + "'");
+			}
+		}
+		System.out.println("- Downloading to: " + outputFile.getAbsolutePath());
+		try {
+			downloadFileFromURL(url, outputFile);
+			System.out.println("Done");
+			System.exit(0);
+		} catch (Throwable e) {
+			System.out.println("- Error downloading");
+			e.printStackTrace();
+			System.exit(1);
+		}
+	}
+
+	private static void downloadFileFromURL(String urlString, File destination) throws Exception {
+		if (System.getenv("MVNW_USERNAME") != null && System.getenv("MVNW_PASSWORD") != null) {
+			String username = System.getenv("MVNW_USERNAME");
+			char[] password = System.getenv("MVNW_PASSWORD").toCharArray();
+			Authenticator.setDefault(new Authenticator() {
+				@Override
+				protected PasswordAuthentication getPasswordAuthentication() {
+					return new PasswordAuthentication(username, password);
+				}
+			});
+		}
+		URL website = new URL(urlString);
+		ReadableByteChannel rbc;
+		rbc = Channels.newChannel(website.openStream());
+		FileOutputStream fos = new FileOutputStream(destination);
+		fos.getChannel().transferFrom(rbc, 0, Long.MAX_VALUE);
+		fos.close();
+		rbc.close();
+	}
+
+}

.mvn/wrapper/maven-wrapper.properties

@@ -0,0 +1,3 @@
+#Thu Jul 17 13:59:56 CEST 2025
+wrapperUrl=https\://repo.maven.apache.org/maven2/io/takari/maven-wrapper/0.5.6/maven-wrapper-0.5.6.jar
+distributionUrl=https\://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.11/apache-maven-3.9.11-bin.zip

CI.adoc

@@ -0,0 +1,43 @@
+= Continuous Integration
+
+image:https://jenkins.spring.io/buildStatus/icon?job=spring-data-elasticsearch%2Fmain&subject=2020.0.0%20(main)[link=https://jenkins.spring.io/view/SpringData/job/spring-data-elasticsearch/]
+image:https://jenkins.spring.io/buildStatus/icon?job=spring-data-elasticsearch%2F4.0.x&subject=Neumann%20(4.0.x)[link=https://jenkins.spring.io/view/SpringData/job/spring-data-elasticsearch/]
+image:https://jenkins.spring.io/buildStatus/icon?job=spring-data-elasticsearch%2F3.2.x&subject=Moore%20(3.2.x)[link=https://jenkins.spring.io/view/SpringData/job/spring-data-elasticsearch/]
+
+== Running CI tasks locally
+
+Since this pipeline is purely Docker-based, it's easy to:
+
+* Debug what went wrong on your local machine.
+* Test out a a tweak to your `verify.sh` script before sending it out.
+* Experiment against a new image before submitting your pull request.
+
+All of these use cases are great reasons to essentially run what the CI server does on your local machine.
+
+IMPORTANT: To do this you must have Docker installed on your machine.
+
+1. `docker run -it --mount type=bind,source="$(pwd)",target=/spring-data-elasticsearch-github adoptopenjdk/openjdk8:latest /bin/bash`
++
+This will launch the Docker image and mount your source code at `spring-data-elasticsearch-github`.
++
+2. `cd spring-data-elasticsearch-github`
++
+Next, run your tests from inside the container:
++
+3. `./mvnw clean dependency:list test -Dsort` (or whatever profile you need to test out)
+
+Since the container is binding to your source, you can make edits from your IDE and continue to run build jobs.
+
+If you need to package things up, do this:
+
+1. `docker run -it -v /var/run/docker.sock:/var/run/docker.sock --mount type=bind,source="$(pwd)",target=/spring-data-elasticsearch-github adoptopenjdk/openjdk8:latest /bin/bash`
++
+This will launch the Docker image and mount your source code at `spring-data-elasticsearch-github`.
++
+2. `cd spring-data-elasticsearch-github`
++
+Next, try to package everything up from inside the container:
++
+3. `./mvnw -Pci,snapshot -Dmaven.test.skip=true clean package`
+
+NOTE: Docker containers can eat up disk space fast! From time to time, run `docker system prune` to clean out old images.

CODE_OF_CONDUCT.adoc

@@ -1,27 +0,0 @@
-= Contributor Code of Conduct
-
-As contributors and maintainers of this project, and in the interest of fostering an open and welcoming community, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
-
-We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, or nationality.
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery
-* Personal attacks
-* Trolling or insulting/derogatory comments
-* Public or private harassment
-* Publishing other's private information, such as physical or electronic addresses,
-  without explicit permission
-* Other unethical or unprofessional conduct
-
-Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
-
-By adopting this Code of Conduct, project maintainers commit themselves to fairly and consistently applying these principles to every aspect of managing this project. Project maintainers who do not follow or enforce the Code of Conduct may be permanently removed from the project team.
-
-This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community.
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting a project maintainer at spring-code-of-conduct@pivotal.io.
-All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances.
-Maintainers are obligated to maintain confidentiality with regard to the reporter of an incident.
-
-This Code of Conduct is adapted from the http://contributor-covenant.org[Contributor Covenant], version 1.3.0, available at http://contributor-covenant.org/version/1/3/0/[contributor-covenant.org/version/1/3/0/].

CONTRIBUTING.adoc

@@ -1,3 +1,10 @@
 = Spring Data contribution guidelines
 
-You find the contribution guidelines for Spring Data projects https://github.com/spring-projects/spring-data-build/blob/master/CONTRIBUTING.adoc[here].
+You find the contribution guidelines for Spring Data projects https://github.com/spring-projects/spring-data-build/blob/main/CONTRIBUTING.adoc[here].
+**Please read these carefully!**
+
+Do not submit a Pull Request before having created an issue and having discussed it. This prevents you from doing work that might be rejected.
+
+== Running the test locally
+
+In order to run the tests locally with `./mvnw test` you need to have docker running because Spring Data Elasticsearch uses https://www.testcontainers.org/[Testcontainers] to start a local running Elasticsearch instance.

Jenkinsfile

@@ -0,0 +1,132 @@
+def p = [:]
+node {
+		checkout scm
+		p = readProperties interpolate: true, file: 'ci/pipeline.properties'
+}
+
+pipeline {
+	agent none
+
+	triggers {
+		pollSCM 'H/10 * * * *'
+		upstream(upstreamProjects: "spring-data-commons/main", threshold: hudson.model.Result.SUCCESS)
+	}
+
+	options {
+		disableConcurrentBuilds()
+		buildDiscarder(logRotator(numToKeepStr: '14'))
+	}
+
+	stages {
+		stage("test: baseline (main)") {
+			when {
+				beforeAgent(true)
+				anyOf {
+					branch(pattern: "main|(\\d\\.\\d\\.x)", comparator: "REGEXP")
+					not { triggeredBy 'UpstreamCause' }
+				}
+			}
+			agent {
+				label 'data'
+			}
+			options { timeout(time: 30, unit: 'MINUTES') }
+
+			environment {
+				ARTIFACTORY = credentials("${p['artifactory.credentials']}")
+				DEVELOCITY_ACCESS_KEY = credentials("${p['develocity.access-key']}")
+			}
+
+			steps {
+				script {
+					docker.withRegistry(p['docker.proxy.registry'], p['docker.proxy.credentials']) {
+						docker.image(p['docker.java.main.image']).inside(p['docker.java.inside.docker']) {
+							sh "PROFILE=none JENKINS_USER_NAME=${p['jenkins.user.name']} ci/verify.sh"
+							sh "JENKINS_USER_NAME=${p['jenkins.user.name']} ci/clean.sh"
+						}
+					}
+				}
+			}
+		}
+
+		stage("Test other configurations") {
+			when {
+				beforeAgent(true)
+				allOf {
+					branch(pattern: "main|(\\d\\.\\d\\.x)", comparator: "REGEXP")
+					not { triggeredBy 'UpstreamCause' }
+				}
+			}
+			parallel {
+				stage("test: baseline (next)") {
+					agent {
+						label 'data'
+					}
+					options { timeout(time: 30, unit: 'MINUTES') }
+					environment {
+						ARTIFACTORY = credentials("${p['artifactory.credentials']}")
+						DEVELOCITY_ACCESS_KEY = credentials("${p['develocity.access-key']}")
+					}
+					steps {
+						script {
+							docker.withRegistry(p['docker.proxy.registry'], p['docker.proxy.credentials']) {
+								docker.image(p['docker.java.next.image']).inside(p['docker.java.inside.docker']) {
+									sh "PROFILE=none JENKINS_USER_NAME=${p['jenkins.user.name']} ci/verify.sh"
+									sh "JENKINS_USER_NAME=${p['jenkins.user.name']} ci/clean.sh"
+								}
+							}
+						}
+					}
+				}
+			}
+		}
+
+		stage('Release to artifactory') {
+			when {
+				beforeAgent(true)
+				anyOf {
+					branch(pattern: "main|(\\d\\.\\d\\.x)", comparator: "REGEXP")
+					not { triggeredBy 'UpstreamCause' }
+				}
+			}
+			agent {
+				label 'data'
+			}
+			options { timeout(time: 20, unit: 'MINUTES') }
+			environment {
+				ARTIFACTORY = credentials("${p['artifactory.credentials']}")
+				DEVELOCITY_ACCESS_KEY = credentials("${p['develocity.access-key']}")
+			}
+			steps {
+				script {
+					docker.withRegistry(p['docker.proxy.registry'], p['docker.proxy.credentials']) {
+						docker.image(p['docker.java.main.image']).inside(p['docker.java.inside.docker']) {
+								sh 'MAVEN_OPTS="-Duser.name=' + "${p['jenkins.user.name']}" + ' -Duser.home=/tmp/jenkins-home" ' +
+									"./mvnw -s settings.xml -Pci,artifactory " +
+									"-Ddevelocity.storage.directory=/tmp/jenkins-home/.develocity-root " +
+									"-Dartifactory.server=${p['artifactory.url']} " +
+									"-Dartifactory.username=${ARTIFACTORY_USR} " +
+									"-Dartifactory.password=${ARTIFACTORY_PSW} " +
+									"-Dartifactory.staging-repository=${p['artifactory.repository.snapshot']} " +
+									"-Dartifactory.build-name=spring-data-elasticsearch " +
+									"-Dartifactory.build-number=spring-data-elasticsearch-${BRANCH_NAME}-build-${BUILD_NUMBER} " +
+									"-Dmaven.repo.local=/tmp/jenkins-home/.m2/spring-data-elasticsearch " +
+									"-Dmaven.test.skip=true clean deploy -U -B"
+						}
+					}
+				}
+			}
+		}
+	}
+
+	post {
+		changed {
+			script {
+				emailext(
+						subject: "[${currentBuild.fullDisplayName}] ${currentBuild.currentResult}",
+						mimeType: 'text/html',
+						recipientProviders: [[$class: 'CulpritsRecipientProvider'], [$class: 'RequesterRecipientProvider']],
+						body: "<a href=\"${env.BUILD_URL}\">${currentBuild.fullDisplayName} is reported as ${currentBuild.currentResult}</a>")
+			}
+		}
+	}
+}

LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        https://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       https://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

README.adoc

@@ -0,0 +1,179 @@
+= Spring Data for Elasticsearch image:https://jenkins.spring.io/buildStatus/icon?job=spring-data-elasticsearch%2Fmain&subject=Build[link=https://jenkins.spring.io/view/SpringData/job/spring-data-elasticsearch/] https://gitter.im/spring-projects/spring-data[image:https://badges.gitter.im/spring-projects/spring-data.svg[Gitter]] image:https://img.shields.io/badge/Revved%20up%20by-Develocity-06A0CE?logo=Gradle&labelColor=02303A["Revved up by Develocity", link="https://ge.spring.io/scans?search.rootProjectNames=Spring Data Elasticsearch"]
+
+The primary goal of the https://projects.spring.io/spring-data[Spring Data] project is to make it easier to build Spring-powered applications that use new data access technologies such as non-relational databases, map-reduce frameworks, and cloud based data services.
+
+The Spring Data Elasticsearch project provides integration with the https://www.elastic.co/[Elasticsearch] search engine.
+Key functional areas of Spring Data Elasticsearch are a POJO centric model for interacting with Elasticsearch Documents and easily writing a Repository style data access layer.
+
+This project is lead and maintained by the community.
+
+== Features
+
+* Spring configuration support using Java based `@Configuration` classes or an XML namespace for an ES client instances.
+* `ElasticsearchOperations` class and implementations that increases productivity performing common ES operations.
+Includes integrated object mapping between documents and POJOs.
+* Feature Rich Object Mapping integrated with Spring’s Conversion Service
+* Annotation based mapping metadata
+* Automatic implementation of `Repository` interfaces including support for custom search methods.
+* CDI support for repositories
+
+== Code of Conduct
+
+This project is governed by the https://github.com/spring-projects/.github/blob/e3cc2ff230d8f1dca06535aa6b5a4a23815861d4/CODE_OF_CONDUCT.md[Spring Code of Conduct].
+By participating, you are expected to uphold this code of conduct.
+Please report unacceptable behavior to spring-code-of-conduct@pivotal.io.
+
+== Getting Started
+
+Here is a quick teaser of an application using Spring Data Repositories in Java:
+
+[source,java]
+----
+public interface PersonRepository extends CrudRepository<Person, Long> {
+
+  List<Person> findByLastname(String lastname);
+
+  List<Person> findByFirstnameLike(String firstname);
+}
+
+@Service
+public class MyService {
+
+  private final PersonRepository repository;
+
+  public MyService(PersonRepository repository) {
+    this.repository = repository;
+  }
+
+  public void doWork() {
+
+    repository.deleteAll();
+
+    Person person = new Person();
+    person.setFirstname("Oliver");
+    person.setLastname("Gierke");
+    repository.save(person);
+
+    List<Person> lastNameResults = repository.findByLastname("Gierke");
+    List<Person> firstNameResults = repository.findByFirstnameLike("Oli");
+ }
+}
+----
+
+=== Using the RestClient
+
+Please check the https://docs.spring.io/spring-data/elasticsearch/docs/current/reference/html/#elasticsearch.clients.configuration[official documentation].
+
+=== Maven configuration
+
+Add the Maven dependency:
+
+[source,xml]
+----
+<dependency>
+  <groupId>org.springframework.data</groupId>
+  <artifactId>spring-data-elasticsearch</artifactId>
+  <version>${version}</version>
+</dependency>
+----
+
+**Compatibility Matrix**
+
+The compatibility between Spring Data Elasticsearch, Elasticsearch client drivers and Spring Boot versions can be found in the https://docs.spring.io/spring-data/elasticsearch/docs/current/reference/html/#preface.versions[reference documentation].
+
+To use the Release candidate versions of the upcoming major version, use our Maven milestone repository and declare the appropriate dependency version:
+
+[source,xml]
+----
+<dependency>
+  <groupId>org.springframework.data</groupId>
+  <artifactId>spring-data-elasticsearch</artifactId>
+  <version>${version}.RCx</version> <!-- x being 1, 2, ... -->
+</dependency>
+
+<repository>
+  <id>spring-snapshot</id>
+  <name>Spring Snapshot Repository</name>
+  <url>https://repo.spring.io/milestone</url>
+</repository>
+----
+
+If you'd rather like the latest snapshots of the upcoming major version, use our Maven snapshot repository and declare the appropriate dependency version:
+
+[source,xml]
+----
+<dependency>
+  <groupId>org.springframework.data</groupId>
+  <artifactId>spring-data-elasticsearch</artifactId>
+  <version>${version}-SNAPSHOT</version>
+</dependency>
+
+<repository>
+  <id>spring-snapshot</id>
+  <name>Spring Snapshot Repository</name>
+  <url>https://repo.spring.io/snapshot</url>
+</repository>
+----
+
+== Getting Help
+
+Having trouble with Spring Data?
+We’d love to help!
+
+* Check the
+https://docs.spring.io/spring-data/elasticsearch/docs/current/reference/html/[reference documentation], and https://docs.spring.io/spring-data/elasticsearch/docs/current/api/[Javadocs].
+* Learn the Spring basics – Spring Data builds on Spring Framework, check the https://spring.io[spring.io] web-site for a wealth of reference documentation.
+If you are just starting out with Spring, try one of the https://spring.io/guides[guides].
+* Ask a question or chat with the community on https://app.gitter.im/#/room/#spring-projects_spring-data:gitter.im[Gitter].
+* Report bugs with Spring Data for Elasticsearch at https://github.com/spring-projects/spring-data-elasticsearch/issues[https://github.com/spring-projects/spring-data-elasticsearch/issues].
+
+== Reporting Issues
+
+Spring Data uses GitHub as issue tracking system to record bugs and feature requests.
+If you want to raise an issue, please follow the recommendations below:
+
+* Before you log a bug, please search the
+https://github.com/spring-projects/spring-data-elasticsearch/issues[issue tracker] to see if someone has already reported the problem.
+* If the issue doesn't already exist, https://github.com/spring-projects/spring-data-elasticsearch/issues/new[create a new issue].
+* Please provide as much information as possible with the issue report, we like to know the version of Spring Data Elasticsearch that you are using and JVM version.
+* If you need to paste code, or include a stack trace use Markdown +++```+++ escapes before and after your text.
+* If possible try to create a test-case or project that replicates the issue.
+Attach a link to your code or a compressed file containing your code.
+
+== Building from Source
+
+You don’t need to build from source to use Spring Data (binaries in https://repo.spring.io[repo.spring.io]), but if you want to try out the latest and greatest, Spring Data can be easily built with the https://github.com/takari/maven-wrapper[maven wrapper].
+
+You need JDK 17 or above to build the _main_ branch.
+For the branches up to and including release 4.4, JDK 8 is required.
+
+[source,bash]
+----
+ $ ./mvnw clean install
+----
+
+If you want to build with the regular `mvn` command, you will need https://maven.apache.org/run-maven/index.html[Maven v3.5.0 or above].
+
+_Also see link:CONTRIBUTING.adoc[CONTRIBUTING.adoc] if you wish to submit pull requests, and in particular please sign the https://cla.pivotal.io/sign/spring[Contributor’s Agreement] before submitting your first pull request._
+
+IMPORTANT: When contributing, please make sure an issue exists in https://github.com/spring-projects/spring-data-elasticsearch/issues[issue tracker] and comment on this issue with how you want to address it.
+By this we not only know that someone is working on an issue, we can also align architectural questions and possible solutions before work is invested . We so can prevent that much work is put into Pull Requests that have little or no chances of being merged.
+
+=== Building reference documentation
+
+Building the documentation builds also the project without running tests.
+
+[source,bash]
+----
+ $ ./mvnw clean install -Pantora
+----
+
+The generated documentation is available from `target/site/index.html`.
+
+== Examples
+
+For examples on using the Spring Data for Elasticsearch, see the https://github.com/spring-projects/spring-data-examples/tree/main/elasticsearch/example[spring-data-examples] project.
+
+== License
+
+Spring Data for Elasticsearch Open Source software released under the https://www.apache.org/licenses/LICENSE-2.0.html[Apache 2.0 license].

README.md

@@ -1,253 +0,0 @@
-Spring Data Elasticsearch
-=========================
-
-Spring Data implementation for ElasticSearch
-
-Spring Data makes it easier to build Spring-powered applications that use new data access technologies such as non-relational databases, map-reduce frameworks, and cloud based data services as well as provide improved support for relational database technologies.
-
-The Spring Data Elasticsearch project provides integration with the [elasticsearch](http://www.elasticsearch.org/) search engine.
-
-Guide
-------------
-
-* [Reference Documentation](http://docs.spring.io/spring-data/elasticsearch/docs/current/reference/html/)
-* [API Documentation](http://docs.spring.io/spring-data/elasticsearch/docs/current/api/)
-* [Spring Data Project](http://projects.spring.io/spring-data)
-* [Sample Test Application](https://github.com/BioMedCentralLtd/spring-data-elasticsearch-sample-application)
-* [Issues](https://jira.springsource.org/browse/DATAES)
-* [Spring Data Elasticsearch Google Group](https://groups.google.com/d/forum/spring-data-elasticsearch-devs)
-* [Questions](http://stackoverflow.com/questions/tagged/spring-data-elasticsearch)
-
-
-Quick Start
------------
-Wiki page for [Getting Started](https://github.com/spring-projects/spring-data-elasticsearch/wiki/How-to-start-with-spring-data-elasticsearch)
-
-### Maven configuration
-
-Add the Maven dependency:
-
-```xml
-<dependency>
-    <groupId>org.springframework.data</groupId>
-    <artifactId>spring-data-elasticsearch</artifactId>
-    <version>x.y.z.RELEASE</version>
-</dependency>
-```
-
-If you'd rather like the latest snapshots of the upcoming major version, use our Maven snapshot repository and declare
-the appropriate dependency version.
-
-```xml
-<dependency>
-  <groupId>org.springframework.data</groupId>
-  <artifactId>spring-data-elasticsearch</artifactId>
-  <version>x.y.z.BUILD-SNAPSHOT</version>
-</dependency>
-
-<repository>
-  <id>spring-libs-snapshot</id>
-  <name>Spring Snapshot Repository</name>
-  <url>http://repo.spring.io/libs-snapshot</url>
-</repository>
-```
-
-|   spring data elasticsearch         | elasticsearch |
-|:-----------------------------------:|:-------------:|
-|           2.0.4.RELEASE             |      2.4.0    |
-|           2.0.0.RELEASE             |      2.2.0    |
-|           1.4.0.M1                  |      1.7.3    |
-|           1.3.0.RELEASE             |      1.5.2    |
-|           1.2.0.RELEASE             |      1.4.4    |
-|           1.1.0.RELEASE             |      1.3.2    |
-|           1.0.0.RELEASE             |      1.1.1    |
-
-
-### ElasticsearchRepository
-A default implementation of ElasticsearchRepository, aligning to the generic Repository Interfaces, is provided. Spring can do the Repository implementation for you depending on method names in the interface definition.
-
-The ElasticsearchCrudRepository extends PagingAndSortingRepository
-
-```java
-    public interface ElasticsearchCrudRepository<T, ID extends Serializable> extends ElasticsearchRepository<T, ID>, PagingAndSortingRepository<T, ID> {
-    }
-```
-
-Extending ElasticsearchRepository for custom methods
-
-```java
-    public interface BookRepository extends Repository<Book, String> {
-
-        List<Book> findByNameAndPrice(String name, Integer price);
-
-        List<Book> findByNameOrPrice(String name, Integer price);
-        
-        Page<Book> findByName(String name,Pageable page);
-
-        Page<Book> findByNameNot(String name,Pageable page);
-
-        Page<Book> findByPriceBetween(int price,Pageable page);
-
-        Page<Book> findByNameLike(String name,Pageable page);
-
-        @Query("{\"bool\" : {\"must\" : {\"term\" : {\"message\" : \"?0\"}}}}")
-        Page<Book> findByMessage(String message, Pageable pageable);
-    }
-```
-Indexing a single document with Repository
-
-```java
-        @Autowired
-        private SampleElasticsearchRepository repository;
-
-        String documentId = "123456";
-        SampleEntity sampleEntity = new SampleEntity();
-        sampleEntity.setId(documentId);
-        sampleEntity.setMessage("some message");
-
-        repository.save(sampleEntity);
-```
-
-Indexing multiple Document(bulk index) using Repository
-
-```java
-        @Autowired
-        private SampleElasticsearchRepository repository;
-
-        String documentId = "123456";
-        SampleEntity sampleEntity1 = new SampleEntity();
-        sampleEntity1.setId(documentId);
-        sampleEntity1.setMessage("some message");
-
-        String documentId2 = "123457"
-        SampleEntity sampleEntity2 = new SampleEntity();
-        sampleEntity2.setId(documentId2);
-        sampleEntity2.setMessage("test message");
-
-        List<SampleEntity> sampleEntities = Arrays.asList(sampleEntity1, sampleEntity2);
-
-        //bulk index
-        repository.save(sampleEntities);
-```
-
-
-### ElasticsearchTemplate
-
-ElasticsearchTemplate is the central support class for elasticsearch operations.
-
-Indexing a single document using Elasticsearch Template
-
-```java
-        String documentId = "123456";
-        SampleEntity sampleEntity = new SampleEntity();
-        sampleEntity.setId(documentId);
-        sampleEntity.setMessage("some message");
-        IndexQuery indexQuery = new IndexQueryBuilder().withId(sampleEntity.getId()).withObject(sampleEntity).build();
-        elasticsearchTemplate.index(indexQuery);
-```
-
-Indexing multiple Document(bulk index) using Elasticsearch Template
-
-```java
-        @Autowired
-        private ElasticsearchTemplate elasticsearchTemplate;
-
-        List<IndexQuery> indexQueries = new ArrayList<IndexQuery>();
-        //first document
-        String documentId = "123456";
-        SampleEntity sampleEntity1 = new SampleEntity();
-        sampleEntity1.setId(documentId);
-        sampleEntity1.setMessage("some message");
-
-        IndexQuery indexQuery1 = new IndexQueryBuilder().withId(sampleEntity1.getId()).withObject(sampleEntity1).build();
-        indexQueries.add(indexQuery1);
-
-        //second document
-        String documentId2 = "123457";
-        SampleEntity sampleEntity2 = new SampleEntity();
-        sampleEntity2.setId(documentId2);
-        sampleEntity2.setMessage("some message");
-
-        IndexQuery indexQuery2 = new IndexQueryBuilder().withId(sampleEntity2.getId()).withObject(sampleEntity2).build()
-        indexQueries.add(indexQuery2);
-
-        //bulk index
-        elasticsearchTemplate.bulkIndex(indexQueries);
-```
-
-Searching entities using Elasticsearch Template
-
-```java
-        @Autowired
-        private ElasticsearchTemplate elasticsearchTemplate;
-
-        SearchQuery searchQuery = new NativeSearchQueryBuilder()
-        .withQuery(queryString(documentId).field("id"))
-        .build();
-        Page<SampleEntity> sampleEntities = elasticsearchTemplate.queryForPage(searchQuery,SampleEntity.class);
-```
-
-### XML Namespace
-
-You can set up repository scanning via xml configuration, which will happily create your repositories.
-
-Using Node Client
-
-```xml
-<?xml version="1.0" encoding="UTF-8"?>
-<beans xmlns="http://www.springframework.org/schema/beans"
-       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-       xmlns:elasticsearch="http://www.springframework.org/schema/data/elasticsearch"
-       xsi:schemaLocation="http://www.springframework.org/schema/data/elasticsearch http://www.springframework.org/schema/data/elasticsearch/spring-elasticsearch.xsd
-		http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd">
-
-    <elasticsearch:node-client id="client" local="true"/>
-
-    <bean name="elasticsearchTemplate" class="org.springframework.data.elasticsearch.core.ElasticsearchTemplate">
-        <constructor-arg name="client" ref="client"/>
-    </bean>
-
-</beans>
-```
-
-Using Transport Client
-
-```xml
-<?xml version="1.0" encoding="UTF-8"?>
-<beans xmlns="http://www.springframework.org/schema/beans"
-       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-       xmlns:elasticsearch="http://www.springframework.org/schema/data/elasticsearch"
-       xsi:schemaLocation="http://www.springframework.org/schema/data/elasticsearch http://www.springframework.org/schema/data/elasticsearch/spring-elasticsearch.xsd
-		http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd">
-
-    <elasticsearch:repositories base-package="com.xyz.acme"/>
-
-    <elasticsearch:transport-client id="client" cluster-nodes="ip:9300,ip:9300" cluster-name="elasticsearch" />
-
-    <bean name="elasticsearchTemplate" class="org.springframework.data.elasticsearch.core.ElasticsearchTemplate">
-        <constructor-arg name="client" ref="client"/>
-    </bean>
-
-</beans>
-```
-
-## Help Pages
-
-* [Geo distance and location search](https://github.com/spring-projects/spring-data-elasticsearch/wiki/Geo-indexing-and-request)
-* [Custom object mapper](https://github.com/spring-projects/spring-data-elasticsearch/wiki/Custom-ObjectMapper)
-
-## Contributing to Spring Data
-
-Here are some ways for you to get involved in the community:
-
-* Get involved with the Spring community on the Spring Community Forums.  Please help out on the [forum](http://forum.springsource.org/forumdisplay.php?f=80) by responding to questions and joining the debate.
-* Create [JIRA](https://jira.springframework.org/browse/DATAES) tickets for bugs and new features and comment and vote on the ones that you are interested in.  
-* Github is for social coding: if you want to write code, we encourage contributions through pull requests from [forks of this repository](http://help.github.com/forking/). If you want to contribute code this way, please reference a JIRA ticket as well covering the specific issue you are addressing.
-* Watch for upcoming articles on Spring by [subscribing](http://www.springsource.org/node/feed) to springframework.org
-
-Before we accept a non-trivial patch or pull request we will need you to sign the [contributor's agreement](https://support.springsource.com/spring_committer_signup).  Signing the contributor's agreement does not grant anyone commit rights to the main repository, but it does mean that we can accept your contributions, and you will get an author credit if we do.  Active contributors might be asked to join the core team, and given the ability to merge pull requests.
-
-
-Code formatting for [Eclipse and Intellij](https://github.com/spring-projects/spring-data-build/tree/master/etc/ide)
-
-[More information about contributing to Spring Data](https://github.com/spring-projects/spring-data-build/blob/master/CONTRIBUTING.adoc)

SECURITY.adoc

@@ -0,0 +1,9 @@
+# Security Policy
+
+## Supported Versions
+
+Please see the https://spring.io/projects/spring-data-elasticsearch[Spring Data Elasticsearch] project page for supported versions.
+
+## Reporting a Vulnerability
+
+Please don't raise security vulnerabilities here. Head over to https://pivotal.io/security to learn how to disclose them responsibly.

TESTING.adoc

@@ -0,0 +1,20 @@
+= Testing
+
+== Unit tests
+
+Unit tests in the project are run with
+
+----
+./mvnw test
+----
+
+== Integration tests
+
+Integration tests are executed when
+----
+./mvnw verify
+----
+is run. There must be _docker_ running, as the integration tests use docker to start an Elasticsearch server.
+
+Integration tests are tests that have the Junit5 Tag `@Tag("integration-test")` on the test class. Normally this should not be set explicitly, but the annotation `@SpringIntegrationTest` should be used. This not only marks the test as integration test, but integrates an automatic setup of an Elasticsearch Testcontainer and integrate this with Spring, so
+that the required Beans can be automatically injected. Check _src/test/java/org/springframework/data/elasticsearch/JUnit5SampleRestClientBasedTests.java_ as a reference setup

ci/clean.sh

@@ -0,0 +1,8 @@
+#!/bin/bash -x
+
+set -euo pipefail
+
+export JENKINS_USER=${JENKINS_USER_NAME}
+
+MAVEN_OPTS="-Duser.name=${JENKINS_USER} -Duser.home=/tmp/jenkins-home" \
+  ./mvnw -s settings.xml clean -Dscan=false -Dmaven.repo.local=/tmp/jenkins-home/.m2/spring-data-elasticsearch -Ddevelocity.storage.directory=/tmp/jenkins-home/.develocity-root

ci/pipeline.properties

@@ -0,0 +1,31 @@
+# Java versions
+java.main.tag=24.0.1_9-jdk-noble
+java.next.tag=24.0.1_9-jdk-noble
+
+# Docker container images - standard
+docker.java.main.image=library/eclipse-temurin:${java.main.tag}
+docker.java.next.image=library/eclipse-temurin:${java.next.tag}
+
+# Supported versions of MongoDB
+docker.mongodb.6.0.version=6.0.23
+docker.mongodb.7.0.version=7.0.20
+docker.mongodb.8.0.version=8.0.9
+
+# Supported versions of Redis
+docker.redis.6.version=6.2.13
+docker.redis.7.version=7.2.4
+
+# Docker environment settings
+docker.java.inside.basic=-v $HOME:/tmp/jenkins-home
+docker.java.inside.docker=-u root -v /var/run/docker.sock:/var/run/docker.sock -v /usr/bin/docker:/usr/bin/docker -v $HOME:/tmp/jenkins-home
+
+# Credentials
+docker.registry=
+docker.credentials=hub.docker.com-springbuildmaster
+docker.proxy.registry=https://docker-hub.usw1.packages.broadcom.com
+docker.proxy.credentials=usw1_packages_broadcom_com-jenkins-token
+artifactory.credentials=02bd1690-b54f-4c9f-819d-a77cb7a9822c
+artifactory.url=https://repo.spring.io
+artifactory.repository.snapshot=libs-snapshot-local
+develocity.access-key=gradle_enterprise_secret_access_key
+jenkins.user.name=spring-builds+jenkins

ci/verify.sh

@@ -0,0 +1,10 @@
+#!/bin/bash -x
+
+set -euo pipefail
+
+mkdir -p /tmp/jenkins-home/.m2/spring-data-elasticsearch
+export JENKINS_USER=${JENKINS_USER_NAME}
+
+MAVEN_OPTS="-Duser.name=${JENKINS_USER} -Duser.home=/tmp/jenkins-home" \
+  ./mvnw -s settings.xml \
+  -P${PROFILE} clean dependency:list verify -Dsort -U -B -Dmaven.repo.local=/tmp/jenkins-home/.m2/spring-data-elasticsearch -Ddevelocity.storage.directory=/tmp/jenkins-home/.develocity-root

mvnw

@@ -0,0 +1,310 @@
+#!/bin/sh
+# ----------------------------------------------------------------------------
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+# ----------------------------------------------------------------------------
+
+# ----------------------------------------------------------------------------
+# Maven Start Up Batch script
+#
+# Required ENV vars:
+# ------------------
+#   JAVA_HOME - location of a JDK home dir
+#
+# Optional ENV vars
+# -----------------
+#   M2_HOME - location of maven2's installed home dir
+#   MAVEN_OPTS - parameters passed to the Java VM when running Maven
+#     e.g. to debug Maven itself, use
+#       set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000
+#   MAVEN_SKIP_RC - flag to disable loading of mavenrc files
+# ----------------------------------------------------------------------------
+
+if [ -z "$MAVEN_SKIP_RC" ] ; then
+
+  if [ -f /etc/mavenrc ] ; then
+    . /etc/mavenrc
+  fi
+
+  if [ -f "$HOME/.mavenrc" ] ; then
+    . "$HOME/.mavenrc"
+  fi
+
+fi
+
+# OS specific support.  $var _must_ be set to either true or false.
+cygwin=false;
+darwin=false;
+mingw=false
+case "`uname`" in
+  CYGWIN*) cygwin=true ;;
+  MINGW*) mingw=true;;
+  Darwin*) darwin=true
+    # Use /usr/libexec/java_home if available, otherwise fall back to /Library/Java/Home
+    # See https://developer.apple.com/library/mac/qa/qa1170/_index.html
+    if [ -z "$JAVA_HOME" ]; then
+      if [ -x "/usr/libexec/java_home" ]; then
+        export JAVA_HOME="`/usr/libexec/java_home`"
+      else
+        export JAVA_HOME="/Library/Java/Home"
+      fi
+    fi
+    ;;
+esac
+
+if [ -z "$JAVA_HOME" ] ; then
+  if [ -r /etc/gentoo-release ] ; then
+    JAVA_HOME=`java-config --jre-home`
+  fi
+fi
+
+if [ -z "$M2_HOME" ] ; then
+  ## resolve links - $0 may be a link to maven's home
+  PRG="$0"
+
+  # need this for relative symlinks
+  while [ -h "$PRG" ] ; do
+    ls=`ls -ld "$PRG"`
+    link=`expr "$ls" : '.*-> \(.*\)$'`
+    if expr "$link" : '/.*' > /dev/null; then
+      PRG="$link"
+    else
+      PRG="`dirname "$PRG"`/$link"
+    fi
+  done
+
+  saveddir=`pwd`
+
+  M2_HOME=`dirname "$PRG"`/..
+
+  # make it fully qualified
+  M2_HOME=`cd "$M2_HOME" && pwd`
+
+  cd "$saveddir"
+  # echo Using m2 at $M2_HOME
+fi
+
+# For Cygwin, ensure paths are in UNIX format before anything is touched
+if $cygwin ; then
+  [ -n "$M2_HOME" ] &&
+    M2_HOME=`cygpath --unix "$M2_HOME"`
+  [ -n "$JAVA_HOME" ] &&
+    JAVA_HOME=`cygpath --unix "$JAVA_HOME"`
+  [ -n "$CLASSPATH" ] &&
+    CLASSPATH=`cygpath --path --unix "$CLASSPATH"`
+fi
+
+# For Mingw, ensure paths are in UNIX format before anything is touched
+if $mingw ; then
+  [ -n "$M2_HOME" ] &&
+    M2_HOME="`(cd "$M2_HOME"; pwd)`"
+  [ -n "$JAVA_HOME" ] &&
+    JAVA_HOME="`(cd "$JAVA_HOME"; pwd)`"
+fi
+
+if [ -z "$JAVA_HOME" ]; then
+  javaExecutable="`which javac`"
+  if [ -n "$javaExecutable" ] && ! [ "`expr \"$javaExecutable\" : '\([^ ]*\)'`" = "no" ]; then
+    # readlink(1) is not available as standard on Solaris 10.
+    readLink=`which readlink`
+    if [ ! `expr "$readLink" : '\([^ ]*\)'` = "no" ]; then
+      if $darwin ; then
+        javaHome="`dirname \"$javaExecutable\"`"
+        javaExecutable="`cd \"$javaHome\" && pwd -P`/javac"
+      else
+        javaExecutable="`readlink -f \"$javaExecutable\"`"
+      fi
+      javaHome="`dirname \"$javaExecutable\"`"
+      javaHome=`expr "$javaHome" : '\(.*\)/bin'`
+      JAVA_HOME="$javaHome"
+      export JAVA_HOME
+    fi
+  fi
+fi
+
+if [ -z "$JAVACMD" ] ; then
+  if [ -n "$JAVA_HOME"  ] ; then
+    if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
+      # IBM's JDK on AIX uses strange locations for the executables
+      JAVACMD="$JAVA_HOME/jre/sh/java"
+    else
+      JAVACMD="$JAVA_HOME/bin/java"
+    fi
+  else
+    JAVACMD="`which java`"
+  fi
+fi
+
+if [ ! -x "$JAVACMD" ] ; then
+  echo "Error: JAVA_HOME is not defined correctly." >&2
+  echo "  We cannot execute $JAVACMD" >&2
+  exit 1
+fi
+
+if [ -z "$JAVA_HOME" ] ; then
+  echo "Warning: JAVA_HOME environment variable is not set."
+fi
+
+CLASSWORLDS_LAUNCHER=org.codehaus.plexus.classworlds.launcher.Launcher
+
+# traverses directory structure from process work directory to filesystem root
+# first directory with .mvn subdirectory is considered project transport directory
+find_maven_basedir() {
+
+  if [ -z "$1" ]
+  then
+    echo "Path not specified to find_maven_basedir"
+    return 1
+  fi
+
+  basedir="$1"
+  wdir="$1"
+  while [ "$wdir" != '/' ] ; do
+    if [ -d "$wdir"/.mvn ] ; then
+      basedir=$wdir
+      break
+    fi
+    # workaround for JBEAP-8937 (on Solaris 10/Sparc)
+    if [ -d "${wdir}" ]; then
+      wdir=`cd "$wdir/.."; pwd`
+    fi
+    # end of workaround
+  done
+  echo "${basedir}"
+}
+
+# concatenates all lines of a file
+concat_lines() {
+  if [ -f "$1" ]; then
+    echo "$(tr -s '\n' ' ' < "$1")"
+  fi
+}
+
+BASE_DIR=`find_maven_basedir "$(pwd)"`
+if [ -z "$BASE_DIR" ]; then
+  exit 1;
+fi
+
+##########################################################################################
+# Extension to allow automatically downloading the maven-wrapper.jar from Maven-central
+# This allows using the maven wrapper in projects that prohibit checking in binary data.
+##########################################################################################
+if [ -r "$BASE_DIR/.mvn/wrapper/maven-wrapper.jar" ]; then
+    if [ "$MVNW_VERBOSE" = true ]; then
+      echo "Found .mvn/wrapper/maven-wrapper.jar"
+    fi
+else
+    if [ "$MVNW_VERBOSE" = true ]; then
+      echo "Couldn't find .mvn/wrapper/maven-wrapper.jar, downloading it ..."
+    fi
+    if [ -n "$MVNW_REPOURL" ]; then
+      jarUrl="$MVNW_REPOURL/io/takari/maven-wrapper/0.5.6/maven-wrapper-0.5.6.jar"
+    else
+      jarUrl="https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/0.5.6/maven-wrapper-0.5.6.jar"
+    fi
+    while IFS="=" read key value; do
+      case "$key" in (wrapperUrl) jarUrl="$value"; break ;;
+      esac
+    done < "$BASE_DIR/.mvn/wrapper/maven-wrapper.properties"
+    if [ "$MVNW_VERBOSE" = true ]; then
+      echo "Downloading from: $jarUrl"
+    fi
+    wrapperJarPath="$BASE_DIR/.mvn/wrapper/maven-wrapper.jar"
+    if $cygwin; then
+      wrapperJarPath=`cygpath --path --windows "$wrapperJarPath"`
+    fi
+
+    if command -v wget > /dev/null; then
+        if [ "$MVNW_VERBOSE" = true ]; then
+          echo "Found wget ... using wget"
+        fi
+        if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then
+            wget "$jarUrl" -O "$wrapperJarPath"
+        else
+            wget --http-user=$MVNW_USERNAME --http-password=$MVNW_PASSWORD "$jarUrl" -O "$wrapperJarPath"
+        fi
+    elif command -v curl > /dev/null; then
+        if [ "$MVNW_VERBOSE" = true ]; then
+          echo "Found curl ... using curl"
+        fi
+        if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then
+            curl -o "$wrapperJarPath" "$jarUrl" -f
+        else
+            curl --user $MVNW_USERNAME:$MVNW_PASSWORD -o "$wrapperJarPath" "$jarUrl" -f
+        fi
+
+    else
+        if [ "$MVNW_VERBOSE" = true ]; then
+          echo "Falling back to using Java to download"
+        fi
+        javaClass="$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.java"
+        # For Cygwin, switch paths to Windows format before running javac
+        if $cygwin; then
+          javaClass=`cygpath --path --windows "$javaClass"`
+        fi
+        if [ -e "$javaClass" ]; then
+            if [ ! -e "$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.class" ]; then
+                if [ "$MVNW_VERBOSE" = true ]; then
+                  echo " - Compiling MavenWrapperDownloader.java ..."
+                fi
+                # Compiling the Java class
+                ("$JAVA_HOME/bin/javac" "$javaClass")
+            fi
+            if [ -e "$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.class" ]; then
+                # Running the downloader
+                if [ "$MVNW_VERBOSE" = true ]; then
+                  echo " - Running MavenWrapperDownloader.java ..."
+                fi
+                ("$JAVA_HOME/bin/java" -cp .mvn/wrapper MavenWrapperDownloader "$MAVEN_PROJECTBASEDIR")
+            fi
+        fi
+    fi
+fi
+##########################################################################################
+# End of extension
+##########################################################################################
+
+export MAVEN_PROJECTBASEDIR=${MAVEN_BASEDIR:-"$BASE_DIR"}
+if [ "$MVNW_VERBOSE" = true ]; then
+  echo $MAVEN_PROJECTBASEDIR
+fi
+MAVEN_OPTS="$(concat_lines "$MAVEN_PROJECTBASEDIR/.mvn/jvm.config") $MAVEN_OPTS"
+
+# For Cygwin, switch paths to Windows format before running java
+if $cygwin; then
+  [ -n "$M2_HOME" ] &&
+    M2_HOME=`cygpath --path --windows "$M2_HOME"`
+  [ -n "$JAVA_HOME" ] &&
+    JAVA_HOME=`cygpath --path --windows "$JAVA_HOME"`
+  [ -n "$CLASSPATH" ] &&
+    CLASSPATH=`cygpath --path --windows "$CLASSPATH"`
+  [ -n "$MAVEN_PROJECTBASEDIR" ] &&
+    MAVEN_PROJECTBASEDIR=`cygpath --path --windows "$MAVEN_PROJECTBASEDIR"`
+fi
+
+# Provide a "standardized" way to retrieve the CLI args that will
+# work with both Windows and non-Windows executions.
+MAVEN_CMD_LINE_ARGS="$MAVEN_CONFIG $@"
+export MAVEN_CMD_LINE_ARGS
+
+WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain
+
+exec "$JAVACMD" \
+  $MAVEN_OPTS \
+  -classpath "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" \
+  "-Dmaven.home=${M2_HOME}" "-Dmaven.multiModuleProjectDirectory=${MAVEN_PROJECTBASEDIR}" \
+  ${WRAPPER_LAUNCHER} $MAVEN_CONFIG "$@"

mvnw.cmd

@@ -0,0 +1,182 @@
+@REM ----------------------------------------------------------------------------
+@REM Licensed to the Apache Software Foundation (ASF) under one
+@REM or more contributor license agreements.  See the NOTICE file
+@REM distributed with this work for additional information
+@REM regarding copyright ownership.  The ASF licenses this file
+@REM to you under the Apache License, Version 2.0 (the
+@REM "License"); you may not use this file except in compliance
+@REM with the License.  You may obtain a copy of the License at
+@REM
+@REM    http://www.apache.org/licenses/LICENSE-2.0
+@REM
+@REM Unless required by applicable law or agreed to in writing,
+@REM software distributed under the License is distributed on an
+@REM "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+@REM KIND, either express or implied.  See the License for the
+@REM specific language governing permissions and limitations
+@REM under the License.
+@REM ----------------------------------------------------------------------------
+
+@REM ----------------------------------------------------------------------------
+@REM Maven Start Up Batch script
+@REM
+@REM Required ENV vars:
+@REM JAVA_HOME - location of a JDK home dir
+@REM
+@REM Optional ENV vars
+@REM M2_HOME - location of maven2's installed home dir
+@REM MAVEN_BATCH_ECHO - set to 'on' to enable the echoing of the batch commands
+@REM MAVEN_BATCH_PAUSE - set to 'on' to wait for a keystroke before ending
+@REM MAVEN_OPTS - parameters passed to the Java VM when running Maven
+@REM     e.g. to debug Maven itself, use
+@REM set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000
+@REM MAVEN_SKIP_RC - flag to disable loading of mavenrc files
+@REM ----------------------------------------------------------------------------
+
+@REM Begin all REM lines with '@' in case MAVEN_BATCH_ECHO is 'on'
+@echo off
+@REM set title of command window
+title %0
+@REM enable echoing by setting MAVEN_BATCH_ECHO to 'on'
+@if "%MAVEN_BATCH_ECHO%" == "on"  echo %MAVEN_BATCH_ECHO%
+
+@REM set %HOME% to equivalent of $HOME
+if "%HOME%" == "" (set "HOME=%HOMEDRIVE%%HOMEPATH%")
+
+@REM Execute a user defined script before this one
+if not "%MAVEN_SKIP_RC%" == "" goto skipRcPre
+@REM check for pre script, once with legacy .bat ending and once with .cmd ending
+if exist "%HOME%\mavenrc_pre.bat" call "%HOME%\mavenrc_pre.bat"
+if exist "%HOME%\mavenrc_pre.cmd" call "%HOME%\mavenrc_pre.cmd"
+:skipRcPre
+
+@setlocal
+
+set ERROR_CODE=0
+
+@REM To isolate internal variables from possible post scripts, we use another setlocal
+@setlocal
+
+@REM ==== START VALIDATION ====
+if not "%JAVA_HOME%" == "" goto OkJHome
+
+echo.
+echo Error: JAVA_HOME not found in your environment. >&2
+echo Please set the JAVA_HOME variable in your environment to match the >&2
+echo location of your Java installation. >&2
+echo.
+goto error
+
+:OkJHome
+if exist "%JAVA_HOME%\bin\java.exe" goto init
+
+echo.
+echo Error: JAVA_HOME is set to an invalid directory. >&2
+echo JAVA_HOME = "%JAVA_HOME%" >&2
+echo Please set the JAVA_HOME variable in your environment to match the >&2
+echo location of your Java installation. >&2
+echo.
+goto error
+
+@REM ==== END VALIDATION ====
+
+:init
+
+@REM Find the project base dir, i.e. the directory that contains the folder ".mvn".
+@REM Fallback to current working directory if not found.
+
+set MAVEN_PROJECTBASEDIR=%MAVEN_BASEDIR%
+IF NOT "%MAVEN_PROJECTBASEDIR%"=="" goto endDetectBaseDir
+
+set EXEC_DIR=%CD%
+set WDIR=%EXEC_DIR%
+:findBaseDir
+IF EXIST "%WDIR%"\.mvn goto baseDirFound
+cd ..
+IF "%WDIR%"=="%CD%" goto baseDirNotFound
+set WDIR=%CD%
+goto findBaseDir
+
+:baseDirFound
+set MAVEN_PROJECTBASEDIR=%WDIR%
+cd "%EXEC_DIR%"
+goto endDetectBaseDir
+
+:baseDirNotFound
+set MAVEN_PROJECTBASEDIR=%EXEC_DIR%
+cd "%EXEC_DIR%"
+
+:endDetectBaseDir
+
+IF NOT EXIST "%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config" goto endReadAdditionalConfig
+
+@setlocal EnableExtensions EnableDelayedExpansion
+for /F "usebackq delims=" %%a in ("%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config") do set JVM_CONFIG_MAVEN_PROPS=!JVM_CONFIG_MAVEN_PROPS! %%a
+@endlocal & set JVM_CONFIG_MAVEN_PROPS=%JVM_CONFIG_MAVEN_PROPS%
+
+:endReadAdditionalConfig
+
+SET MAVEN_JAVA_EXE="%JAVA_HOME%\bin\java.exe"
+set WRAPPER_JAR="%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.jar"
+set WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain
+
+set DOWNLOAD_URL="https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/0.5.6/maven-wrapper-0.5.6.jar"
+
+FOR /F "tokens=1,2 delims==" %%A IN ("%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.properties") DO (
+    IF "%%A"=="wrapperUrl" SET DOWNLOAD_URL=%%B
+)
+
+@REM Extension to allow automatically downloading the maven-wrapper.jar from Maven-central
+@REM This allows using the maven wrapper in projects that prohibit checking in binary data.
+if exist %WRAPPER_JAR% (
+    if "%MVNW_VERBOSE%" == "true" (
+        echo Found %WRAPPER_JAR%
+    )
+) else (
+    if not "%MVNW_REPOURL%" == "" (
+        SET DOWNLOAD_URL="%MVNW_REPOURL%/io/takari/maven-wrapper/0.5.6/maven-wrapper-0.5.6.jar"
+    )
+    if "%MVNW_VERBOSE%" == "true" (
+        echo Couldn't find %WRAPPER_JAR%, downloading it ...
+        echo Downloading from: %DOWNLOAD_URL%
+    )
+
+    powershell -Command "&{"^
+		"$webclient = new-object System.Net.WebClient;"^
+		"if (-not ([string]::IsNullOrEmpty('%MVNW_USERNAME%') -and [string]::IsNullOrEmpty('%MVNW_PASSWORD%'))) {"^
+		"$webclient.Credentials = new-object System.Net.NetworkCredential('%MVNW_USERNAME%', '%MVNW_PASSWORD%');"^
+		"}"^
+		"[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12; $webclient.DownloadFile('%DOWNLOAD_URL%', '%WRAPPER_JAR%')"^
+		"}"
+    if "%MVNW_VERBOSE%" == "true" (
+        echo Finished downloading %WRAPPER_JAR%
+    )
+)
+@REM End of extension
+
+@REM Provide a "standardized" way to retrieve the CLI args that will
+@REM work with both Windows and non-Windows executions.
+set MAVEN_CMD_LINE_ARGS=%*
+
+%MAVEN_JAVA_EXE% %JVM_CONFIG_MAVEN_PROPS% %MAVEN_OPTS% %MAVEN_DEBUG_OPTS% -classpath %WRAPPER_JAR% "-Dmaven.multiModuleProjectDirectory=%MAVEN_PROJECTBASEDIR%" %WRAPPER_LAUNCHER% %MAVEN_CONFIG% %*
+if ERRORLEVEL 1 goto error
+goto end
+
+:error
+set ERROR_CODE=1
+
+:end
+@endlocal & set ERROR_CODE=%ERROR_CODE%
+
+if not "%MAVEN_SKIP_RC%" == "" goto skipRcPost
+@REM check for post script, once with legacy .bat ending and once with .cmd ending
+if exist "%HOME%\mavenrc_post.bat" call "%HOME%\mavenrc_post.bat"
+if exist "%HOME%\mavenrc_post.cmd" call "%HOME%\mavenrc_post.cmd"
+:skipRcPost
+
+@REM pause the script if MAVEN_BATCH_PAUSE is set to 'on'
+if "%MAVEN_BATCH_PAUSE%" == "on" pause
+
+if "%MAVEN_TERMINATE_CMD%" == "on" exit %ERROR_CODE%
+
+exit /B %ERROR_CODE%

package.json

@@ -0,0 +1,10 @@
+{
+    "dependencies": {
+        "antora": "3.2.0-alpha.6",
+        "@antora/atlas-extension": "1.0.0-alpha.2",
+        "@antora/collector-extension": "1.0.0-alpha.7",
+        "@asciidoctor/tabs": "1.0.0-beta.6",
+        "@springio/antora-extensions": "1.13.0",
+        "@springio/asciidoctor-extensions": "1.0.0-alpha.11"
+    }
+}

pom.xml

@@ -1,208 +1,490 @@
-<?xml version="1.0" encoding="UTF-8" standalone="no"?>
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
-    <modelVersion>4.0.0</modelVersion>
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
 
-    <groupId>org.springframework.data</groupId>
-    <artifactId>spring-data-elasticsearch</artifactId>
-    <version>3.0.0.M1</version>
+	<modelVersion>4.0.0</modelVersion>
 
-    <parent>
-        <groupId>org.springframework.data.build</groupId>
-        <artifactId>spring-data-parent</artifactId>
-        <version>2.0.0.M1</version>
-        <relativePath>../spring-data-build/parent/pom.xml</relativePath>
-    </parent>
+	<groupId>org.springframework.data</groupId>
+	<artifactId>spring-data-elasticsearch</artifactId>
+	<version>6.0.0-SNAPSHOT</version>
 
-    <name>Spring Data Elasticsearch</name>
-    <description>Spring Data Implementation for Elasticsearch</description>
-    <url>https://github.com/spring-projects/spring-data-elasticsearch</url>
+	<parent>
+		<groupId>org.springframework.data.build</groupId>
+		<artifactId>spring-data-parent</artifactId>
+		<version>4.0.0-SNAPSHOT</version>
+	</parent>
 
-    <properties>
+	<name>Spring Data Elasticsearch</name>
+	<description>Spring Data Implementation for Elasticsearch</description>
+	<url>https://github.com/spring-projects/spring-data-elasticsearch</url>
 
-        <dist.key>DATAES</dist.key>
+	<properties>
+		<springdata.commons>4.0.0-SNAPSHOT</springdata.commons>
 
-        <commonscollections>3.2.1</commonscollections>
-        <commonslang>2.6</commonslang>
-        <elasticsearch>2.4.0</elasticsearch>
-        <springdata.commons>2.0.0.M1</springdata.commons>
+		<!-- version of the ElasticsearchClient	-->
+		<elasticsearch-java>9.0.4</elasticsearch-java>
 
-    </properties>
+		<hoverfly>0.19.0</hoverfly>
+		<log4j>2.23.1</log4j>
+		<jsonassert>1.5.3</jsonassert>
+		<testcontainers>1.20.0</testcontainers>
+		<wiremock>3.9.1</wiremock>
 
-    <dependencies>
+		<java-module-name>spring.data.elasticsearch</java-module-name>
 
-        <!-- Spring -->
-        <dependency>
-            <groupId>org.springframework</groupId>
-            <artifactId>spring-context</artifactId>
-            <exclusions>
-                <exclusion>
-                    <groupId>commons-logging</groupId>
-                    <artifactId>commons-logging</artifactId>
-                </exclusion>
-            </exclusions>
-        </dependency>
+		<!--
+			properties defining the maven phase for the tests and integration tests
+			set to "none" to disable the corresponding test execution (-Dmvn.unit-test.goal=none)
+			default execution for unit-test: "test", for the integration tests: "integration-test"
+		-->
+		<mvn.unit-test.goal>test</mvn.unit-test.goal>
+		<mvn.integration-test-elasticsearch.goal>integration-test</mvn.integration-test-elasticsearch.goal>
+	</properties>
 
-        <dependency>
-            <groupId>org.springframework</groupId>
-            <artifactId>spring-tx</artifactId>
-        </dependency>
+	<developers>
+		<developer>
+			<id>biomedcentral</id>
+			<name>BioMed Central Development Team</name>
+			<timezone>+0</timezone>
+		</developer>
+		<developer>
+			<id>cstrobl</id>
+			<name>Christoph Strobl</name>
+			<email>cstrobl at pivotal.io</email>
+			<organization>Pivotal</organization>
+			<organizationUrl>https://www.pivotal.io</organizationUrl>
+			<roles>
+				<role>Developer</role>
+			</roles>
+			<timezone>+1</timezone>
+		</developer>
+		<developer>
+			<id>mpaluch</id>
+			<name>Mark Paluch</name>
+			<email>mpaluch at pivotal.io</email>
+			<organization>Pivotal</organization>
+			<organizationUrl>https://www.pivotal.io</organizationUrl>
+			<roles>
+				<role>Developer</role>
+			</roles>
+			<timezone>+1</timezone>
+		</developer>
+	</developers>
 
-        <!-- SPRING DATA -->
-        <dependency>
-            <groupId>org.springframework.data</groupId>
-            <artifactId>spring-data-commons</artifactId>
-            <version>${springdata.commons}</version>
-        </dependency>
+	<scm>
+		<url>https://github.com/spring-projects/spring-data-elasticsearch</url>
+		<connection>scm:git:git://github.com/spring-projects/spring-data-elasticsearch.git</connection>
+		<developerConnection>scm:git:ssh://git@github.com/spring-projects/spring-data-elasticsearch.git
+		</developerConnection>
+	</scm>
 
-        <!-- APACHE -->
-        <dependency>
-            <groupId>commons-lang</groupId>
-            <artifactId>commons-lang</artifactId>
-            <version>${commonslang}</version>
-        </dependency>
+	<ciManagement>
+		<system>Bamboo</system>
+		<url>https://build.spring.io/browse/SPRINGDATAES</url>
+	</ciManagement>
 
-        <!-- JODA Time -->
-        <dependency>
-            <groupId>joda-time</groupId>
-            <artifactId>joda-time</artifactId>
-            <version>${jodatime}</version>
-        </dependency>
+	<issueManagement>
+		<system>GitHub</system>
+		<url>https://github.com/spring-projects/spring-data-elasticsearch/issues</url>
+	</issueManagement>
 
-        <!-- Elasticsearch -->
-        <dependency>
-            <groupId>org.elasticsearch</groupId>
-            <artifactId>elasticsearch</artifactId>
-            <version>${elasticsearch}</version>
-        </dependency>
+	<dependencies>
 
-        <!-- Jackson JSON Mapper -->
-        <dependency>
-            <groupId>com.fasterxml.jackson.core</groupId>
-            <artifactId>jackson-core</artifactId>
-            <version>${jackson}</version>
-        </dependency>
-        <dependency>
-            <groupId>com.fasterxml.jackson.core</groupId>
-            <artifactId>jackson-databind</artifactId>
-            <version>${jackson}</version>
-        </dependency>
-        
-        <!-- CDI -->
-        <dependency>
-            <groupId>javax.enterprise</groupId>
-            <artifactId>cdi-api</artifactId>
-            <version>${cdi}</version>
-            <scope>provided</scope>
-            <optional>true</optional>
-        </dependency>
+		<!-- Spring -->
+		<dependency>
+			<groupId>org.springframework</groupId>
+			<artifactId>spring-context</artifactId>
+		</dependency>
 
-        <!-- Test -->
-        <dependency>
-            <groupId>org.springframework</groupId>
-            <artifactId>spring-test</artifactId>
-            <scope>test</scope>
-        </dependency>
-        <dependency>
-            <groupId>org.apache.openwebbeans.test</groupId>
-            <artifactId>cditest-owb</artifactId>
-            <version>${webbeans}</version>
-            <scope>test</scope>
-            <exclusions>
-                <exclusion>
-                    <groupId>org.apache.geronimo.specs</groupId>
-                    <artifactId>geronimo-jcdi_1.0_spec</artifactId>
-                </exclusion>
-                <exclusion>
-                    <groupId>org.apache.geronimo.specs</groupId>
-                    <artifactId>geronimo-atinject_1.0_spec</artifactId>
-                </exclusion>
-            </exclusions>
-        </dependency>
-        <dependency>
-            <groupId>javax.servlet</groupId>
-            <artifactId>servlet-api</artifactId>
-            <version>3.0-alpha-1</version>
-            <scope>test</scope>
-        </dependency>
+		<dependency>
+			<groupId>org.springframework</groupId>
+			<artifactId>spring-tx</artifactId>
+		</dependency>
 
-        <dependency>
-            <groupId>org.projectlombok</groupId>
-            <artifactId>lombok</artifactId>
-            <version>${lombok}</version>
-            <scope>test</scope>
-        </dependency>
+		<!-- SPRING DATA -->
+		<dependency>
+			<groupId>org.springframework.data</groupId>
+			<artifactId>spring-data-commons</artifactId>
+			<version>${springdata.commons}</version>
+		</dependency>
 
-    </dependencies>
+		<!-- Reactive Infrastructure -->
+		<dependency>
+			<groupId>org.springframework</groupId>
+			<artifactId>spring-webflux</artifactId>
+			<optional>true</optional>
+		</dependency>
 
-    <build>
-        <plugins>
-            <plugin>
-                <groupId>org.apache.maven.plugins</groupId>
-                <artifactId>maven-assembly-plugin</artifactId>
-            </plugin>
-            <plugin>
-                <groupId>org.codehaus.mojo</groupId>
-                <artifactId>wagon-maven-plugin</artifactId>
-            </plugin>
-            <plugin>
-                <groupId>org.asciidoctor</groupId>
-                <artifactId>asciidoctor-maven-plugin</artifactId>
-            </plugin>
-        </plugins>
-    </build>
+		<dependency>
+			<groupId>io.projectreactor</groupId>
+			<artifactId>reactor-test</artifactId>
+			<scope>test</scope>
+		</dependency>
 
-    <profiles>
-        <profile>
-            <id>release</id>
-            <build>
-                <plugins>
-                    <plugin>
-                        <groupId>org.jfrog.buildinfo</groupId>
-                        <artifactId>artifactory-maven-plugin</artifactId>
-                        <inherited>false</inherited>
-                    </plugin>
-                </plugins>
-            </build>
-        </profile>
-    </profiles>
+		<dependency>
+			<groupId>co.elastic.clients</groupId>
+			<artifactId>elasticsearch-java</artifactId>
+			<version>${elasticsearch-java}</version>
+			<exclusions>
+				<exclusion>
+					<groupId>commons-logging</groupId>
+					<artifactId>commons-logging</artifactId>
+				</exclusion>
+			</exclusions>
+		</dependency>
 
-    <developers>
-        <developer>
-            <id>biomedcentral</id>
-            <name>BioMed Central Development Team</name>
-            <timezone>+0</timezone>
-        </developer>
-    </developers>
+		<!-- the old RestCLient is an optional dependency for user that still want to use it-->
+		<dependency>
+			<groupId>org.elasticsearch.client</groupId>
+			<artifactId>elasticsearch-rest-client</artifactId>
+			<version>${elasticsearch-java}</version>
+			<exclusions>
+				<exclusion>
+					<groupId>commons-logging</groupId>
+					<artifactId>commons-logging</artifactId>
+				</exclusion>
+			</exclusions>
+			<optional>true</optional>
+		</dependency>
 
-    <repositories>
-        <repository>
-            <id>spring-libs-milestone</id>
-            <url>https://repo.spring.io/libs-milestone</url>
-        </repository>
-    </repositories>
+		<dependency>
+			<groupId>com.querydsl</groupId>
+			<artifactId>querydsl-core</artifactId>
+			<version>${querydsl}</version>
+			<optional>true</optional>
+		</dependency>
 
-    <pluginRepositories>
-        <pluginRepository>
-            <id>spring-plugins-release</id>
-            <url>https://repo.spring.io/plugins-release</url>
-        </pluginRepository>
-    </pluginRepositories>
+		<!-- Jackson JSON Mapper -->
+		<dependency>
+			<groupId>com.fasterxml.jackson.core</groupId>
+			<artifactId>jackson-core</artifactId>
+		</dependency>
+		<dependency>
+			<groupId>com.fasterxml.jackson.core</groupId>
+			<artifactId>jackson-databind</artifactId>
+		</dependency>
 
-    <scm>
-        <url>https://github.com/spring-projects/spring-data-elasticsearch</url>
-        <connection>scm:git:git://github.com/spring-projects/spring-data-elasticsearch.git</connection>
-        <developerConnection>scm:git:ssh://git@github.com/spring-projects/spring-data-elasticsearch.git
-        </developerConnection>
-    </scm>
+		<!-- CDI -->
 
-    <ciManagement>
-        <system>Bamboo</system>
-        <url>http://build.springsource.org/browse/SPRINGDATAES</url>
-    </ciManagement>
+		<dependency>
+			<groupId>javax.interceptor</groupId>
+			<artifactId>javax.interceptor-api</artifactId>
+			<version>1.2.2</version>
+			<scope>test</scope>
+		</dependency>
 
-    <issueManagement>
-        <system>JIRA</system>
-        <url>https://jira.springsource.org/browse/DATAES</url>
-    </issueManagement>
+		<dependency>
+			<groupId>jakarta.enterprise</groupId>
+			<artifactId>jakarta.enterprise.cdi-api</artifactId>
+			<scope>provided</scope>
+			<optional>true</optional>
+		</dependency>
+
+		<dependency>
+			<groupId>jakarta.annotation</groupId>
+			<artifactId>jakarta.annotation-api</artifactId>
+			<version>${jakarta-annotation-api}</version>
+			<scope>test</scope>
+		</dependency>
+
+		<dependency>
+			<groupId>org.apache.openwebbeans</groupId>
+			<artifactId>openwebbeans-se</artifactId>
+			<version>${webbeans}</version>
+			<scope>test</scope>
+		</dependency>
+
+		<!-- Kotlin extension -->
+		<dependency>
+			<groupId>org.jetbrains.kotlin</groupId>
+			<artifactId>kotlin-stdlib</artifactId>
+			<optional>true</optional>
+		</dependency>
+
+		<dependency>
+			<groupId>org.jetbrains.kotlin</groupId>
+			<artifactId>kotlin-reflect</artifactId>
+			<optional>true</optional>
+		</dependency>
+
+		<dependency>
+			<groupId>org.jetbrains.kotlinx</groupId>
+			<artifactId>kotlinx-coroutines-core</artifactId>
+			<optional>true</optional>
+		</dependency>
+
+		<dependency>
+			<groupId>org.jetbrains.kotlinx</groupId>
+			<artifactId>kotlinx-coroutines-reactor</artifactId>
+			<optional>true</optional>
+		</dependency>
+
+		<!-- Test -->
+		<dependency>
+			<groupId>org.springframework</groupId>
+			<artifactId>spring-test</artifactId>
+			<scope>test</scope>
+			<exclusions>
+				<exclusion>
+					<groupId>ch.qos.logback</groupId>
+					<artifactId>logback-classic</artifactId>
+				</exclusion>
+			</exclusions>
+		</dependency>
+
+		<dependency>
+			<groupId>org.jetbrains.kotlinx</groupId>
+			<artifactId>kotlinx-coroutines-test</artifactId>
+			<scope>test</scope>
+			<optional>true</optional>
+		</dependency>
+
+		<dependency>
+			<groupId>org.slf4j</groupId>
+			<artifactId>log4j-over-slf4j</artifactId>
+			<version>${slf4j}</version>
+			<scope>test</scope>
+		</dependency>
+		<dependency>
+			<groupId>org.apache.logging.log4j</groupId>
+			<artifactId>log4j-core</artifactId>
+			<version>${log4j}</version>
+			<scope>test</scope>
+		</dependency>
+		<dependency>
+			<groupId>org.apache.logging.log4j</groupId>
+			<artifactId>log4j-to-slf4j</artifactId>
+			<version>${log4j}</version>
+			<scope>test</scope>
+		</dependency>
+
+		<dependency>
+			<groupId>org.skyscreamer</groupId>
+			<artifactId>jsonassert</artifactId>
+			<version>${jsonassert}</version>
+			<scope>test</scope>
+		</dependency>
+
+		<dependency>
+			<groupId>org.wiremock</groupId>
+			<artifactId>wiremock</artifactId>
+			<version>${wiremock}</version>
+			<scope>test</scope>
+			<exclusions>
+				<!-- these exclusions are needed because of Elasticsearch JarHell-->
+				<exclusion>
+					<groupId>commons-logging</groupId>
+					<artifactId>commons-logging</artifactId>
+				</exclusion>
+				<exclusion>
+					<groupId>org.ow2.asm</groupId>
+					<artifactId>asm</artifactId>
+				</exclusion>
+			</exclusions>
+		</dependency>
+
+		<dependency>
+			<groupId>io.specto</groupId>
+			<artifactId>hoverfly-java-junit5</artifactId>
+			<version>${hoverfly}</version>
+			<scope>test</scope>
+		</dependency>
+
+		<!-- Upgrade xbean to 4.5 to prevent incompatibilities due to ASM versions -->
+		<dependency>
+			<groupId>org.apache.xbean</groupId>
+			<artifactId>xbean-asm5-shaded</artifactId>
+			<version>4.5</version>
+			<scope>test</scope>
+		</dependency>
+
+		<dependency>
+			<groupId>javax.servlet</groupId>
+			<artifactId>javax.servlet-api</artifactId>
+			<version>3.1.0</version>
+			<scope>test</scope>
+		</dependency>
+
+		<dependency>
+			<groupId>org.mockito</groupId>
+			<artifactId>mockito-junit-jupiter</artifactId>
+			<version>${mockito}</version>
+			<scope>test</scope>
+		</dependency>
+
+		<dependency>
+			<groupId>org.testcontainers</groupId>
+			<artifactId>elasticsearch</artifactId>
+			<version>${testcontainers}</version>
+			<scope>test</scope>
+		</dependency>
+
+		<!--we need Murmur3Hash in a test, before 5.2 we had it from the old Elasticsearch dependency	-->
+		<dependency>
+			<groupId>commons-codec</groupId>
+			<artifactId>commons-codec</artifactId>
+			<version>1.15</version>
+			<scope>test</scope>
+		</dependency>
+
+		<dependency>
+			<groupId>com.tngtech.archunit</groupId>
+			<artifactId>archunit-junit5</artifactId>
+			<version>${archunit}</version>
+			<scope>test</scope>
+		</dependency>
+
+	</dependencies>
+
+	<build>
+		<resources>
+			<resource>
+				<directory>src/main/resources</directory>
+				<filtering>true</filtering>
+				<includes>
+					<include>**/versions.properties</include>
+				</includes>
+			</resource>
+			<resource>
+				<directory>src/main/resources</directory>
+				<filtering>false</filtering>
+				<excludes>
+					<exclude>**/versions.properties</exclude>
+				</excludes>
+			</resource>
+		</resources>
+
+		<plugins>
+			<plugin>
+				<groupId>org.apache.maven.plugins</groupId>
+				<artifactId>maven-surefire-plugin</artifactId>
+				<configuration>
+					<useSystemClassLoader>true</useSystemClassLoader>
+					<useFile>false</useFile>
+					<includes>
+						<include>**/*Tests.java</include>
+						<include>**/*Test.java</include>
+					</includes>
+					<systemPropertyVariables>
+						<es.set.netty.runtime.available.processors>false</es.set.netty.runtime.available.processors>
+					</systemPropertyVariables>
+				</configuration>
+				<executions>
+					<!-- the default-test execution runs only the unit tests -->
+					<execution>
+						<id>default-test</id>
+						<phase>${mvn.unit-test.goal}</phase>
+						<goals>
+							<goal>test</goal>
+						</goals>
+						<configuration>
+							<excludedGroups>integration-test</excludedGroups>
+						</configuration>
+					</execution>
+					<!-- execution to run the integration tests against Elasticsearch -->
+					<execution>
+						<id>integration-test-elasticsearch</id>
+						<phase>${mvn.integration-test-elasticsearch.goal}</phase>
+						<goals>
+							<goal>test</goal>
+						</goals>
+						<configuration>
+							<groups>integration-test</groups>
+							<systemPropertyVariables>
+								<sde.integration-test.environment>elasticsearch</sde.integration-test.environment>
+							</systemPropertyVariables>
+						</configuration>
+					</execution>
+				</executions>
+			</plugin>
+			<plugin>
+				<groupId>org.apache.maven.plugins</groupId>
+				<artifactId>maven-assembly-plugin</artifactId>
+			</plugin>
+			<plugin>
+				<groupId>org.apache.maven.plugins</groupId>
+				<artifactId>maven-compiler-plugin</artifactId>
+				<configuration>
+					<annotationProcessorPaths>
+						<path>
+							<groupId>org.apache.logging.log4j</groupId>
+							<artifactId>log4j-core</artifactId>
+							<version>${log4j}</version>
+						</path>
+					</annotationProcessorPaths>
+				</configuration>
+			</plugin>
+		</plugins>
+	</build>
+
+	<profiles>
+		<profile>
+			<id>ci</id>
+			<build>
+				<plugins>
+					<plugin>
+						<groupId>org.apache.maven.plugins</groupId>
+						<artifactId>maven-checkstyle-plugin</artifactId>
+						<configuration>
+							<checkstyleRules>
+								<module name="Checker">
+
+									<!-- Configure checker to use UTF-8 encoding -->
+									<property name="charset" value="UTF-8"/>
+
+									<module name="io.spring.nohttp.checkstyle.check.NoHttpCheck"/>
+								</module>
+							</checkstyleRules>
+							<includes>**/*</includes>
+							<excludes>
+								.git/**/*,target/**/*,**/target/**/*,.idea/**/*,**/spring.schemas,**/*.svg,mvnw,mvnw.cmd,**/*.policy
+							</excludes>
+							<sourceDirectories>./</sourceDirectories>
+						</configuration>
+					</plugin>
+				</plugins>
+			</build>
+		</profile>
+
+		<profile>
+			<id>antora-process-resources</id>
+			<build>
+				<resources>
+					<resource>
+						<directory>src/main/antora/resources/antora-resources</directory>
+						<filtering>true</filtering>
+					</resource>
+				</resources>
+			</build>
+		</profile>
+
+		<profile>
+			<id>antora</id>
+			<build>
+				<plugins>
+					<plugin>
+						<groupId>org.antora</groupId>
+						<artifactId>antora-maven-plugin</artifactId>
+					</plugin>
+				</plugins>
+			</build>
+		</profile>
+	</profiles>
+
+	<repositories>
+		<repository>
+			<id>spring-snapshot</id>
+			<url>https://repo.spring.io/snapshot</url>
+			<snapshots>
+				<enabled>true</enabled>
+			</snapshots>
+			<releases>
+				<enabled>false</enabled>
+			</releases>
+		</repository>
+		<repository>
+			<id>spring-milestone</id>
+			<url>https://repo.spring.io/milestone</url>
+		</repository>
+	</repositories>
 
 </project>

settings.xml

@@ -0,0 +1,29 @@
+<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
+          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+          xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0
+                      https://maven.apache.org/xsd/settings-1.0.0.xsd">
+
+	<servers>
+		<server>
+			<id>spring-plugins-release</id>
+			<username>${env.ARTIFACTORY_USR}</username>
+			<password>${env.ARTIFACTORY_PSW}</password>
+		</server>
+		<server>
+			<id>spring-libs-snapshot</id>
+			<username>${env.ARTIFACTORY_USR}</username>
+			<password>${env.ARTIFACTORY_PSW}</password>
+		</server>
+		<server>
+			<id>spring-libs-milestone</id>
+			<username>${env.ARTIFACTORY_USR}</username>
+			<password>${env.ARTIFACTORY_PSW}</password>
+		</server>
+		<server>
+			<id>spring-libs-release</id>
+			<username>${env.ARTIFACTORY_USR}</username>
+			<password>${env.ARTIFACTORY_PSW}</password>
+		</server>
+	</servers>
+
+</settings>

src/main/antora/antora-playbook.yml

@@ -0,0 +1,40 @@
+# PACKAGES antora@3.2.0-alpha.2 @antora/atlas-extension:1.0.0-alpha.1 @antora/collector-extension@1.0.0-alpha.3 @springio/antora-extensions@1.1.0-alpha.2 @asciidoctor/tabs@1.0.0-alpha.12 @opendevise/antora-release-line-extension@1.0.0-alpha.2
+#
+# The purpose of this Antora playbook is to build the docs in the current branch.
+antora:
+  extensions:
+    - require: '@springio/antora-extensions'
+      root_component_name: 'data-elasticsearch'
+site:
+  title: Spring Data Elasticsearch
+  url: https://docs.spring.io/spring-data-elasticsearch/reference/
+content:
+  sources:
+    - url: ./../../..
+      branches: HEAD
+      start_path: src/main/antora
+      worktrees: true
+    - url: https://github.com/spring-projects/spring-data-commons
+      # Refname matching:
+      # https://docs.antora.org/antora/latest/playbook/content-refname-matching/
+      branches: [ main, 3.4.x, 3.3.x ]
+      start_path: src/main/antora
+asciidoc:
+  attributes:
+    hide-uri-scheme: '@'
+    tabs-sync-option: '@'
+  extensions:
+    - '@asciidoctor/tabs'
+    - '@springio/asciidoctor-extensions'
+    - '@springio/asciidoctor-extensions/javadoc-extension'
+  sourcemap: true
+urls:
+  latest_version_segment: ''
+runtime:
+  log:
+    failure_level: warn
+    format: pretty
+ui:
+  bundle:
+    url: https://github.com/spring-io/antora-ui-spring/releases/download/v0.4.16/ui-bundle.zip
+    snapshot: true

src/main/antora/antora.yml

@@ -0,0 +1,17 @@
+name: data-elasticsearch
+version: true
+title: Spring Data Elasticsearch
+nav:
+  - modules/ROOT/nav.adoc
+ext:
+  collector:
+    - run:
+        command: ./mvnw validate process-resources -am -Pantora-process-resources
+        local: true
+      scan:
+        dir: target/classes/
+    - run:
+        command: ./mvnw package -Pdistribute
+        local: true
+      scan:
+        dir: target/antora

src/main/antora/modules/ROOT/nav.adoc

@@ -0,0 +1,47 @@
+* xref:index.adoc[Overview]
+** xref:commons/upgrade.adoc[]
+** xref:migration-guides.adoc[]
+*** xref:migration-guides/migration-guide-3.2-4.0.adoc[]
+*** xref:migration-guides/migration-guide-4.0-4.1.adoc[]
+*** xref:migration-guides/migration-guide-4.1-4.2.adoc[]
+*** xref:migration-guides/migration-guide-4.2-4.3.adoc[]
+*** xref:migration-guides/migration-guide-4.3-4.4.adoc[]
+*** xref:migration-guides/migration-guide-4.4-5.0.adoc[]
+*** xref:migration-guides/migration-guide-5.0-5.1.adoc[]
+*** xref:migration-guides/migration-guide-5.1-5.2.adoc[]
+*** xref:migration-guides/migration-guide-5.2-5.3.adoc[]
+*** xref:migration-guides/migration-guide-5.3-5.4.adoc[]
+*** xref:migration-guides/migration-guide-5.4-5.5.adoc[]
+*** xref:migration-guides/migration-guide-5.5-6.0.adoc[]
+
+
+* xref:elasticsearch.adoc[]
+** xref:elasticsearch/clients.adoc[]
+** xref:elasticsearch/object-mapping.adoc[]
+** xref:elasticsearch/template.adoc[]
+** xref:elasticsearch/reactive-template.adoc[]
+** xref:elasticsearch/entity-callbacks.adoc[]
+** xref:elasticsearch/auditing.adoc[]
+** xref:elasticsearch/join-types.adoc[]
+** xref:elasticsearch/routing.adoc[]
+** xref:elasticsearch/misc.adoc[]
+** xref:elasticsearch/scripted-and-runtime-fields.adoc[]
+
+* xref:repositories.adoc[]
+** xref:repositories/core-concepts.adoc[]
+** xref:repositories/definition.adoc[]
+** xref:elasticsearch/repositories/elasticsearch-repositories.adoc[]
+** xref:elasticsearch/repositories/reactive-elasticsearch-repositories.adoc[]
+** xref:repositories/create-instances.adoc[]
+** xref:repositories/query-methods-details.adoc[]
+** xref:elasticsearch/repositories/elasticsearch-repository-queries.adoc[]
+** xref:repositories/projections.adoc[]
+** xref:repositories/custom-implementations.adoc[]
+** xref:repositories/core-domain-events.adoc[]
+** xref:repositories/null-handling.adoc[]
+** xref:elasticsearch/repositories/cdi-integration.adoc[]
+** xref:repositories/query-keywords-reference.adoc[]
+** xref:repositories/query-return-types-reference.adoc[]
+
+* xref:attachment$api/java/index.html[Javadoc,role=link-external,window=_blank]
+* https://github.com/spring-projects/spring-data-commons/wiki[Wiki,role=link-external,window=_blank]

src/main/antora/modules/ROOT/pages/commons/upgrade.adoc

@@ -0,0 +1 @@
+include::{commons}@data-commons::page$upgrade.adoc[]

src/main/antora/modules/ROOT/pages/elasticsearch.adoc

@@ -0,0 +1,16 @@
+[[elasticsearch.core]]
+= Elasticsearch Support
+:page-section-summary-toc: 1
+
+Spring Data support for Elasticsearch contains a wide range of features:
+
+* Spring configuration support for various xref:elasticsearch/clients.adoc[Elasticsearch clients].
+* The xref:elasticsearch/template.adoc[`ElasticsearchTemplate` and `ReactiveElasticsearchTemplate`] helper classes that provide object mapping between ES index operations and POJOs.
+* xref:elasticsearch/template.adoc#exception-translation[Exception translation] into Spring's portable {springDocsUrl}data-access.html#dao-exceptions[Data Access Exception Hierarchy].
+* Feature rich xref:elasticsearch/object-mapping.adoc[object mapping] integrated with _Spring's_ {springDocsUrl}core.html#core-convert[Conversion Service].
+* xref:elasticsearch/object-mapping.adoc#elasticsearch.mapping.meta-model.annotations[Annotation-based mapping] metadata that is extensible to support other metadata formats.
+* Java-based xref:elasticsearch/template.adoc#cassandra.template.query[query, criteria, and update DSLs].
+* Automatic implementation of xref:repositories.adoc[imperative and reactive `Repository` interfaces] including support for xref:repositories/custom-implementations.adoc[custom query methods].
+
+For most data-oriented tasks, you can use the `[Reactive]ElasticsearchTemplate` or the `Repository` support, both of which use the rich object-mapping functionality.
+Spring Data Elasticsearch uses consistent naming conventions on objects in various APIs to those found in the DataStax Java Driver so that they are familiar and so that you can map your existing knowledge onto the Spring APIs.

src/main/antora/modules/ROOT/pages/elasticsearch/auditing.adoc

@@ -0,0 +1,85 @@
+[[elasticsearch.auditing]]
+= Elasticsearch Auditing
+
+[[elasticsearch.auditing.preparing]]
+== Preparing entities
+
+In order for the auditing code to be able to decide whether an entity instance is new, the entity must implement the `Persistable<ID>` interface which is defined as follows:
+
+[source,java]
+----
+package org.springframework.data.domain;
+
+import org.jspecify.annotations.Nullable;
+
+public interface Persistable<ID> {
+    @Nullable
+    ID getId();
+
+    boolean isNew();
+}
+----
+
+As the existence of an Id is not a sufficient criterion to determine if an enitity is new in Elasticsearch, additional information is necessary. One way is to use the creation-relevant auditing fields for this decision:
+
+A `Person` entity might look as follows - omitting getter and setter methods for brevity:
+
+[source,java]
+----
+@Document(indexName = "person")
+public class Person implements Persistable<Long> {
+    @Id private Long id;
+    private String lastName;
+    private String firstName;
+    @CreatedDate
+    @Field(type = FieldType.Date, format = DateFormat.basic_date_time)
+    private Instant createdDate;
+    @CreatedBy
+    private String createdBy
+    @Field(type = FieldType.Date, format = DateFormat.basic_date_time)
+    @LastModifiedDate
+    private Instant lastModifiedDate;
+    @LastModifiedBy
+    private String lastModifiedBy;
+
+    public Long getId() {                                                 // <.>
+        return id;
+    }
+
+    @Override
+    public boolean isNew() {
+        return id == null || (createdDate == null && createdBy == null);  // <.>
+    }
+}
+----
+<.> the getter is the required implementation from the interface
+<.> an object is new if it either has no `id` or none of fields containing creation attributes are set.
+
+[[elasticsearch.auditing.activating]]
+== Activating auditing
+
+After the entities have been set up and providing the `AuditorAware` - or `ReactiveAuditorAware` - the Auditing must be activated by setting the `@EnableElasticsearchAuditing` on a configuration class:
+
+[source,java]
+----
+@Configuration
+@EnableElasticsearchRepositories
+@EnableElasticsearchAuditing
+class MyConfiguration {
+   // configuration code
+}
+----
+
+When using the reactive stack this must be:
+[source,java]
+----
+@Configuration
+@EnableReactiveElasticsearchRepositories
+@EnableReactiveElasticsearchAuditing
+class MyConfiguration {
+   // configuration code
+}
+----
+
+If your code contains more than one `AuditorAware` bean for different types, you must provide the name of the bean to use as an argument to the `auditorAwareRef` parameter of the
+ `@EnableElasticsearchAuditing` annotation.

src/main/antora/modules/ROOT/pages/elasticsearch/clients.adoc

@@ -0,0 +1,460 @@
+[[elasticsearch.clients]]
+= Elasticsearch Clients
+
+This chapter illustrates configuration and usage of supported Elasticsearch client implementations.
+
+Spring Data Elasticsearch operates upon an Elasticsearch client (provided by Elasticsearch client libraries) that is connected to a single Elasticsearch node or a cluster.
+Although the Elasticsearch Client can be used directly to work with the cluster, applications using Spring Data Elasticsearch normally use the higher level abstractions of xref:elasticsearch/template.adoc[Elasticsearch Operations] and xref:elasticsearch/repositories/elasticsearch-repositories.adoc[Elasticsearch Repositories].
+
+[[elasticsearch.clients.rest5client]]
+== Imperative Rest5Client
+
+To use the imperative (non-reactive) Rest5Client, a configuration bean must be configured like this:
+
+====
+[source,java]
+----
+import org.springframework.data.elasticsearch.client.elc.ElasticsearchConfiguration;
+
+@Configuration
+public class MyClientConfig extends ElasticsearchConfiguration {
+
+	@Override
+	public ClientConfiguration clientConfiguration() {
+		return ClientConfiguration.builder()           <.>
+			.connectedTo("localhost:9200")
+			.build();
+	}
+}
+----
+
+<.> for a detailed description of the builder methods see xref:elasticsearch/clients.adoc#elasticsearch.clients.configuration[Client Configuration]
+====
+
+The javadoc:org.springframework.data.elasticsearch.client.elc.ElasticsearchConfiguration[] class allows further configuration by overriding for example the `jsonpMapper()` or `transportOptions()` methods.
+
+
+The following beans can then be injected in other Spring components:
+
+====
+[source,java]
+----
+import org.springframework.beans.factory.annotation.Autowired;@Autowired
+ElasticsearchOperations operations;      <.>
+
+@Autowired
+ElasticsearchClient elasticsearchClient; <.>
+
+@Autowired
+Rest5Client rest5Client;                 <.>
+
+@Autowired
+JsonpMapper jsonpMapper;                 <.>
+----
+
+<.> an implementation of javadoc:org.springframework.data.elasticsearch.core.ElasticsearchOperations[]
+<.> the `co.elastic.clients.elasticsearch.ElasticsearchClient` that is used.
+<.> the low level `Rest5Client` from the Elasticsearch libraries
+<.> the `JsonpMapper` user by the Elasticsearch `Transport`
+====
+
+Basically one should just use the javadoc:org.springframework.data.elasticsearch.core.ElasticsearchOperations[] to interact with the Elasticsearch cluster.
+When using repositories, this instance is used under the hood as well.
+
+[[elasticsearch.clients.restclient]]
+== Deprecated Imperative RestClient
+
+To use the imperative (non-reactive) RestClient - deprecated since version 6 - , the following dependency needs to be added, adapt the correct version. The exclusion is needed in a Spring Boot application:
+====
+[source,xml]
+----
+        <dependency>
+            <groupId>org.elasticsearch.client</groupId>
+            <artifactId>elasticsearch-rest-client</artifactId>
+            <version>${elasticsearch-client.version}</version>
+            <exclusions>
+                <exclusion>
+                    <groupId>commons-logging</groupId>
+                    <artifactId>commons-logging</artifactId>
+                </exclusion>
+            </exclusions>
+        </dependency>
+
+----
+====
+
+The configuration bean must be configured like this:
+
+====
+[source,java]
+----
+import org.springframework.data.elasticsearch.client.elc.ElasticsearchLegacyRestClientConfiguration;
+
+@Configuration
+public class MyClientConfig extends ElasticsearchLegacyRestClientConfiguration {
+
+	@Override
+	public ClientConfiguration clientConfiguration() {
+		return ClientConfiguration.builder()           <.>
+			.connectedTo("localhost:9200")
+			.build();
+	}
+}
+----
+
+<.> for a detailed description of the builder methods see xref:elasticsearch/clients.adoc#elasticsearch.clients.configuration[Client Configuration]
+====
+
+The javadoc:org.springframework.data.elasticsearch.client.elc.ElasticsearchConfiguration[] class allows further configuration by overriding for example the `jsonpMapper()` or `transportOptions()` methods.
+
+
+The following beans can then be injected in other Spring components:
+
+====
+[source,java]
+----
+import org.springframework.beans.factory.annotation.Autowired;@Autowired
+ElasticsearchOperations operations;      <.>
+
+@Autowired
+ElasticsearchClient elasticsearchClient; <.>
+
+@Autowired
+RestClient restClient;                 <.>
+
+@Autowired
+JsonpMapper jsonpMapper;                 <.>
+----
+
+<.> an implementation of javadoc:org.springframework.data.elasticsearch.core.ElasticsearchOperations[]
+<.> the `co.elastic.clients.elasticsearch.ElasticsearchClient` that is used.
+<.> the low level `RestClient` from the Elasticsearch libraries
+<.> the `JsonpMapper` user by the Elasticsearch `Transport`
+====
+
+Basically one should just use the javadoc:org.springframework.data.elasticsearch.core.ElasticsearchOperations[] to interact with the Elasticsearch cluster.
+When using repositories, this instance is used under the hood as well.
+
+[[elasticsearch.clients.reactiverest5client]]
+== Reactive Rest5Client
+
+When working with the reactive stack, the configuration must be derived from a different class:
+
+====
+[source,java]
+----
+import org.springframework.data.elasticsearch.client.elc.ReactiveElasticsearchConfiguration;
+
+@Configuration
+public class MyClientConfig extends ReactiveElasticsearchConfiguration {
+
+	@Override
+	public ClientConfiguration clientConfiguration() {
+		return ClientConfiguration.builder()           <.>
+			.connectedTo("localhost:9200")
+			.build();
+	}
+}
+----
+
+<.> for a detailed description of the builder methods see xref:elasticsearch/clients.adoc#elasticsearch.clients.configuration[Client Configuration]
+====
+
+The javadoc:org.springframework.data.elasticsearch.client.elc.ReactiveElasticsearchConfiguration[] class allows further configuration by overriding for example the `jsonpMapper()` or `transportOptions()` methods.
+
+The following beans can then be injected in other Spring components:
+
+====
+[source,java]
+----
+@Autowired
+ReactiveElasticsearchOperations operations;      <.>
+
+@Autowired
+ReactiveElasticsearchClient elasticsearchClient; <.>
+
+@Autowired
+Rest5Client rest5Client;                           <.>
+
+@Autowired
+JsonpMapper jsonpMapper;                         <.>
+----
+
+the following can be injected:
+
+<.> an implementation of javadoc:org.springframework.data.elasticsearch.core.ReactiveElasticsearchOperations[]
+<.> the `org.springframework.data.elasticsearch.client.elc.ReactiveElasticsearchClient` that is used.
+This is a reactive implementation based on the Elasticsearch client implementation.
+<.> the low level `RestClient` from the Elasticsearch libraries
+<.> the `JsonpMapper` user by the Elasticsearch `Transport`
+====
+
+Basically one should just use the javadoc:org.springframework.data.elasticsearch.core.ReactiveElasticsearchOperations[] to interact with the Elasticsearch cluster.
+When using repositories, this instance is used under the hood as well.
+
+[[elasticsearch.clients.reactiverestclient]]
+== Deprecated Reactive RestClient
+
+See the section above for the imperative code to use the deprecated RestClient for the necessary dependencies to include.
+
+When working with the reactive stack, the configuration must be derived from a different class:
+
+====
+[source,java]
+----
+import org.springframework.data.elasticsearch.client.elc.ReactiveElasticsearchLegacyRestClientConfiguration;
+
+@Configuration
+public class MyClientConfig extends ReactiveElasticsearchLegacyRestClientConfiguration {
+
+	@Override
+	public ClientConfiguration clientConfiguration() {
+		return ClientConfiguration.builder()           <.>
+			.connectedTo("localhost:9200")
+			.build();
+	}
+}
+----
+
+<.> for a detailed description of the builder methods see xref:elasticsearch/clients.adoc#elasticsearch.clients.configuration[Client Configuration]
+====
+
+The javadoc:org.springframework.data.elasticsearch.client.elc.ReactiveElasticsearchConfiguration[] class allows further configuration by overriding for example the `jsonpMapper()` or `transportOptions()` methods.
+
+The following beans can then be injected in other Spring components:
+
+====
+[source,java]
+----
+@Autowired
+ReactiveElasticsearchOperations operations;      <.>
+
+@Autowired
+ReactiveElasticsearchClient elasticsearchClient; <.>
+
+@Autowired
+RestClient restClient;                           <.>
+
+@Autowired
+JsonpMapper jsonpMapper;                         <.>
+----
+
+the following can be injected:
+
+<.> an implementation of javadoc:org.springframework.data.elasticsearch.core.ReactiveElasticsearchOperations[]
+<.> the `org.springframework.data.elasticsearch.client.elc.ReactiveElasticsearchClient` that is used.
+This is a reactive implementation based on the Elasticsearch client implementation.
+<.> the low level `RestClient` from the Elasticsearch libraries
+<.> the `JsonpMapper` user by the Elasticsearch `Transport`
+====
+
+Basically one should just use the javadoc:org.springframework.data.elasticsearch.core.ReactiveElasticsearchOperations[] to interact with the Elasticsearch cluster.
+When using repositories, this instance is used under the hood as well.
+
+[[elasticsearch.clients.configuration]]
+== Client Configuration
+
+Client behaviour can be changed via the javadoc:org.springframework.data.elasticsearch.client.ClientConfiguration[] that allows to set options for SSL, connect and socket timeouts, headers and other parameters.
+
+.Client Configuration
+====
+[source,java]
+----
+import org.springframework.data.elasticsearch.client.ClientConfiguration;
+import org.springframework.data.elasticsearch.support.HttpHeaders;
+
+import static org.springframework.data.elasticsearch.client.elc.ElasticsearchClients.*;
+
+HttpHeaders httpHeaders = new HttpHeaders();
+httpHeaders.add("some-header", "on every request")                      <.>
+
+ClientConfiguration clientConfiguration = ClientConfiguration.builder()
+  .connectedTo("localhost:9200", "localhost:9291")                      <.>
+  .usingSsl()                                                           <.>
+  .withProxy("localhost:8888")                                          <.>
+  .withPathPrefix("ela")                                                <.>
+  .withConnectTimeout(Duration.ofSeconds(5))                            <.>
+  .withSocketTimeout(Duration.ofSeconds(3))                             <.>
+  .withDefaultHeaders(defaultHeaders)                                   <.>
+  .withBasicAuth(username, password)                                    <.>
+  .withHeaders(() -> {                                                  <.>
+    HttpHeaders headers = new HttpHeaders();
+    headers.add("currentTime", LocalDateTime.now().format(DateTimeFormatter.ISO_LOCAL_DATE_TIME));
+    return headers;
+  })
+  .withClientConfigurer(                                                <.>
+    ElasticsearchHttpClientConfigurationCallback.from(clientBuilder -> {
+  	  // ...
+      return clientBuilder;
+  	}))
+  . // ... other options
+  .build();
+
+----
+
+<.> Define default headers, if they need to be customized
+<.> Use the builder to provide cluster addresses, set default `HttpHeaders` or enable SSL.
+<.> Optionally enable SSL.There exist overloads of this function that can take a `SSLContext` or as an alternative the fingerprint of the certificate as it is output by Elasticsearch 8 on startup.
+<.> Optionally set a proxy.
+<.> Optionally set a path prefix, mostly used when different clusters a behind some reverse proxy.
+<.> Set the connection timeout.
+<.> Set the socket timeout.
+<.> Optionally set headers.
+<.> Add basic authentication.
+<.> A `Supplier<HttpHeaders>` function can be specified which is called every time before a request is sent to Elasticsearch - here, as an example, the current time is written in a header.
+<.> a function to configure the created client (see xref:elasticsearch/clients.adoc#elasticsearch.clients.configuration.callbacks[Client configuration callbacks]), can be added multiple times.
+====
+
+IMPORTANT: Adding a Header supplier as shown in above example allows to inject headers that may change over the time, like authentication JWT tokens.
+If this is used in the reactive setup, the supplier function *must not* block!
+
+[[elasticsearch.clients.configuration.callbacks]]
+=== Client configuration callbacks
+
+The javadoc:org.springframework.data.elasticsearch.client.ClientConfiguration[] class offers the most common parameters to configure the client.
+In the case this is not enough, the user can add callback functions by using the `withClientConfigurer(ClientConfigurationCallback<?>)` method.
+
+The following callbacks are provided:
+
+[[elasticsearch.clients.configuration.callbacks.rest5]]
+==== Configuration of the low level Elasticsearch `Rest5Client`:
+
+This callback provides a `org.elasticsearch.client.RestClientBuilder` that can be used to configure the Elasticsearch
+`RestClient`:
+====
+[source,java]
+----
+ClientConfiguration.builder()
+    .connectedTo("localhost:9200", "localhost:9291")
+    .withClientConfigurer(Rest5Clients.ElasticsearchRest5ClientConfigurationCallback.from(restClientBuilder -> {
+        // configure the Elasticsearch Rest5Client
+        return restClientBuilder;
+    }))
+    .build();
+----
+====
+[[elasticsearch.clients.configuration.callbacks.rest]]
+==== Configuration of the deprecated low level Elasticsearch `RestClient`:
+
+This callback provides a `org.elasticsearch.client.RestClientBuilder` that can be used to configure the Elasticsearch
+`RestClient`:
+====
+[source,java]
+----
+ClientConfiguration.builder()
+    .connectedTo("localhost:9200", "localhost:9291")
+    .withClientConfigurer(RestClients.ElasticsearchRestClientConfigurationCallback.from(restClientBuilder -> {
+        // configure the Elasticsearch RestClient
+        return restClientBuilder;
+    }))
+    .build();
+----
+====
+
+[[elasticsearch.clients.configurationcallbacks.httpasync5]]
+==== Configuration of the HttpAsyncClient used by the low level Elasticsearch `Rest5Client`:
+
+This callback provides a `org.apache.hc.client5.http.impl.async.HttpAsyncClientBuilder` to configure the HttpClient that is
+used by the `Rest5Client`.
+
+====
+[source,java]
+----
+ClientConfiguration.builder()
+    .connectedTo("localhost:9200", "localhost:9291")
+    .withClientConfigurer(Rest5Clients.ElasticsearchHttpClientConfigurationCallback.from(httpAsyncClientBuilder -> {
+        // configure the HttpAsyncClient
+        return httpAsyncClientBuilder;
+    }))
+    .build();
+----
+====
+
+[[elasticsearch.clients.configurationcallbacks.httpasync]]
+==== Configuration of the HttpAsyncClient used by the deprecated low level Elasticsearch `RestClient`:
+
+This callback provides a `org.apache.http.impl.nio.client.HttpAsyncClientBuilder` to configure the HttpClient that is
+used by the `RestClient`.
+
+====
+[source,java]
+----
+ClientConfiguration.builder()
+    .connectedTo("localhost:9200", "localhost:9291")
+    .withClientConfigurer(RestClients.ElasticsearchHttpClientConfigurationCallback.from(httpAsyncClientBuilder -> {
+        // configure the HttpAsyncClient
+        return httpAsyncClientBuilder;
+    }))
+    .build();
+----
+====
+
+[[elasticsearch.clients.configurationcallbacks.connectionconfig]]
+==== Configuration of the ConnectionConfig used by the low level Elasticsearch `Rest5Client`:
+
+This callback provides a `org.apache.hc.client5.http.config.ConnectionConfig` to configure the connection that is
+used by the `Rest5Client`.
+
+====
+[source,java]
+----
+ClientConfiguration.builder()
+    .connectedTo("localhost:9200", "localhost:9291")
+    .withClientConfigurer(Rest5Clients.ElasticsearchConnectionConfigurationCallback.from(connectionConfigBuilder -> {
+        // configure the connection
+        return connectionConfigBuilder;
+    }))
+    .build();
+----
+====
+
+[[elasticsearch.clients.configurationcallbacks.connectioncmanager]]
+==== Configuration of the ConnectionManager used by the low level Elasticsearch `Rest5Client`:
+
+This callback provides a `org.apache.hc.client5.http.impl.nio.PoolingAsyncClientConnectionManagerBuilder` to configure the connection manager that is
+used by the `Rest5Client`.
+
+====
+[source,java]
+----
+ClientConfiguration.builder()
+    .connectedTo("localhost:9200", "localhost:9291")
+    .withClientConfigurer(Rest5Clients.ElasticsearchConnectionManagerCallback.from(connectionManagerBuilder -> {
+        // configure the connection manager
+        return connectionManagerBuilder;
+    }))
+    .build();
+----
+====
+
+[[elasticsearch.clients.configurationcallbacks.requestconfig]]
+==== Configuration of the RequestConfig used by the low level Elasticsearch `Rest5Client`:
+
+This callback provides a `org.apache.hc.client5.http.config.RequestConfig` to configure the RequestConfig that is
+used by the `Rest5Client`.
+
+====
+[source,java]
+----
+ClientConfiguration.builder()
+    .connectedTo("localhost:9200", "localhost:9291")
+    .withClientConfigurer(Rest5Clients.ElasticsearchRequestConfigCallback.from(requestConfigBuilder -> {
+        // configure the request config
+        return requestConfigBuilder;
+    }))
+    .build();
+----
+====
+
+[[elasticsearch.clients.logging]]
+== Client Logging
+
+To see what is actually sent to and received from the server `Request` / `Response` logging on the transport level needs to be turned on as outlined in the snippet below.
+This can be enabled in the Elasticsearch client by setting the level of the `tracer` package to "trace" (see
+https://www.elastic.co/guide/en/elasticsearch/client/java-api-client/current/java-rest-low-usage-logging.html)
+
+.Enable transport layer logging
+[source,xml]
+----
+<logger name="tracer" level="trace"/>
+----

src/main/antora/modules/ROOT/pages/elasticsearch/elasticsearch-new.adoc

@@ -0,0 +1,122 @@
+[[new-features]]
+= What's new
+
+[[new-features.6-0-0]]
+== New in Spring Data Elasticsearch 6.0
+
+* Upgarde to Spring 7
+* Switch to jspecify nullability annotations
+* Upgrade to Elasticsearch 9.0.4
+* Use the new Elasticsearch Rest5Client as default
+
+
+[[new-features.5-5-0]]
+== New in Spring Data Elasticsearch 5.5
+
+* Upgrade to Elasticsearch 8.18.1.
+* Add support for the `@SearchTemplateQuery` annotation on repository methods.
+* Scripted field properties of type collection can be populated from scripts returning arrays.
+
+[[new-features.5-4-0]]
+== New in Spring Data Elasticsearch 5.4
+
+* Upgrade to Elasticsearch 8.15.3.
+* Allow to customize the mapped type name for `@InnerField` and `@Field` annotations.
+* Support for Elasticsearch SQL.
+* Add support for retrieving request executionDuration.
+
+[[new-features.5-3-0]]
+== New in Spring Data Elasticsearch 5.3
+
+* Upgrade to Elasticsearch 8.13.2.
+* Add support for highlight queries in highlighting.
+* Add shard statistics to the `SearchHit` class.
+* Add support for multi search template API.
+* Add support for SpEL in @Query.
+* Add support for field aliases in the index mapping.
+* Add support for has_child and has_parent queries.
+
+[[new-features.5-2-0]]
+== New in Spring Data Elasticsearch 5.2
+
+* Upgrade to Elasticsearch 8.11.1
+* The `JsonpMapper` for Elasticsearch is now configurable and provided as bean.
+* Improved AOT runtime hints for Elasticsearch client library classes.
+* Add Kotlin extensions and repository coroutine support.
+* Introducing `VersionConflictException` class thrown in case thatElasticsearch reports an 409 error with a version conflict.
+* Enable MultiField annotation on property getter
+* Support nested sort option
+* Improved scripted und runtime field support
+* Improved refresh policy support
+
+[[new-features.5-1-0]]
+== New in Spring Data Elasticsearch 5.1
+
+* Upgrade to Elasticsearch 8.7.1
+* Allow specification of the TLS certificate when connecting to an Elasticsearch 8 cluster
+
+[[new-features.5-0-0]]
+== New in Spring Data Elasticsearch 5.0
+
+* Upgrade to Java 17 baseline
+* Upgrade to Spring Framework 6
+* Upgrade to Elasticsearch 8.5.0
+* Use the new Elasticsearch client library
+
+[[new-features.4-4-0]]
+== New in Spring Data Elasticsearch 4.4
+
+* Introduction of new imperative and reactive clients using the classes from the new Elasticsearch Java client
+* Upgrade to Elasticsearch 7.17.3.
+
+[[new-features.4-3-0]]
+== New in Spring Data Elasticsearch 4.3
+
+* Upgrade to Elasticsearch 7.15.2.
+* Allow runtime_fields to be defined in the index mapping.
+* Add native support for range field types by using a range object.
+* Add repository search for nullable or empty properties.
+* Enable custom converters for single fields.
+* Supply a custom `Sort.Order` providing Elasticsearch specific parameters.
+
+[[new-features.4-2-0]]
+== New in Spring Data Elasticsearch 4.2
+
+* Upgrade to Elasticsearch 7.10.0.
+* Support for custom routing values
+
+[[new-features.4-1-0]]
+== New in Spring Data Elasticsearch 4.1
+
+* Uses Spring 5.3.
+* Upgrade to Elasticsearch 7.9.3.
+* Improved API for alias management.
+* Introduction of `ReactiveIndexOperations` for index management.
+* Index templates support.
+* Support for Geo-shape data with GeoJson.
+
+[[new-features.4-0-0]]
+== New in Spring Data Elasticsearch 4.0
+
+* Uses Spring 5.2.
+* Upgrade to Elasticsearch 7.6.2.
+* Deprecation of `TransportClient` usage.
+* Implements most of the mapping-types available for the index mappings.
+* Removal of the Jackson `ObjectMapper`, now using the xref:elasticsearch/object-mapping.adoc#elasticsearch.mapping.meta-model[MappingElasticsearchConverter]
+* Cleanup of the API in the `*Operations` interfaces, grouping and renaming methods so that they match the Elasticsearch API, deprecating the old methods, aligning with other Spring Data modules.
+* Introduction of `SearchHit<T>` class to represent a found document together with the relevant result metadata for this document (i.e. _sortValues_).
+* Introduction of the `SearchHits<T>` class to represent a whole search result together with the metadata for the complete search result (i.e. _max_score_).
+* Introduction of `SearchPage<T>` class to represent a paged result containing a `SearchHits<T>` instance.
+* Introduction of the `GeoDistanceOrder` class to be able to create sorting by geographical distance
+* Implementation of Auditing Support
+* Implementation of lifecycle entity callbacks
+
+[[new-features.3-2-0]]
+== New in Spring Data Elasticsearch 3.2
+
+* Secured Elasticsearch cluster support with Basic Authentication and SSL transport.
+* Upgrade to Elasticsearch 6.8.1.
+* Reactive programming support with xref:elasticsearch/repositories/reactive-elasticsearch-repositories.adoc[Reactive Elasticsearch Repositories] and xref:.
+* Introduction of the xref:elasticsearch/object-mapping.adoc#elasticsearch.mapping.meta-model[ElasticsearchEntityMapper] as an alternative to the Jackson `ObjectMapper`.
+* Field name customization in `@Field`.
+* Support for Delete by Query.

src/main/antora/modules/ROOT/pages/elasticsearch/entity-callbacks.adoc

@@ -0,0 +1,42 @@
+include::{commons}@data-commons::page$entity-callbacks.adoc[]
+
+[[elasticsearch.entity-callbacks]]
+== Store specific EntityCallbacks
+
+Spring Data Elasticsearch uses the `EntityCallback` API internally for its auditing support and reacts on the following callbacks:
+
+.Supported Entity Callbacks
+[%header,cols="4"]
+|===
+| Callback
+| Method
+| Description
+| Order
+
+| Reactive/BeforeConvertCallback
+| `onBeforeConvert(T entity, IndexCoordinates index)`
+| Invoked before a domain object is converted to `org.springframework.data.elasticsearch.core.document.Document`.
+Can return the `entity` or a modified entity which then will be converted.
+| `Ordered.LOWEST_PRECEDENCE`
+
+| Reactive/AfterLoadCallback
+| `onAfterLoad(Document document, Class<T> type, IndexCoordinates indexCoordinates)`
+| Invoked after the result from Elasticsearch has been read into a `org.springframework.data.elasticsearch.core.document.Document`.
+| `Ordered.LOWEST_PRECEDENCE`
+
+| Reactive/AfterConvertCallback
+| `onAfterConvert(T entity, Document document, IndexCoordinates indexCoordinates)`
+| Invoked after a domain object is converted from `org.springframework.data.elasticsearch.core.document.Document` on reading result data from Elasticsearch.
+| `Ordered.LOWEST_PRECEDENCE`
+
+| Reactive/AuditingEntityCallback
+| `onBeforeConvert(Object entity, IndexCoordinates index)`
+| Marks an auditable entity _created_ or _modified_
+| 100
+
+| Reactive/AfterSaveCallback
+| `T onAfterSave(T entity, IndexCoordinates index)`
+| Invoked after a domain object is saved.
+| `Ordered.LOWEST_PRECEDENCE`
+
+|===

src/main/antora/modules/ROOT/pages/elasticsearch/join-types.adoc

@@ -0,0 +1,239 @@
+[[elasticsearch.jointype]]
+= Join-Type implementation
+
+Spring Data Elasticsearch supports the https://www.elastic.co/guide/en/elasticsearch/reference/current/parent-join.html[Join data type] for creating the corresponding index mappings and for storing the relevant information.
+
+[[elasticsearch.jointype.setting-up]]
+== Setting up the data
+
+For an entity to be used in a parent child join relationship, it must have a property of type `JoinField` which must be annotated.
+Let's assume a `Statement` entity where a statement may be a _question_, an _answer_, a _comment_ or a _vote_ (a _Builder_ is also shown in this example, it's not necessary, but later used in the sample code):
+
+====
+[source,java]
+----
+@Document(indexName = "statements")
+@Routing("routing")                                                                       <.>
+public class Statement {
+    @Id
+    private String id;
+
+    @Field(type = FieldType.Text)
+    private String text;
+
+    @Field(type = FieldType.Keyword)
+    private String routing;
+
+    @JoinTypeRelations(
+        relations =
+            {
+                @JoinTypeRelation(parent = "question", children = {"answer", "comment"}), <.>
+                @JoinTypeRelation(parent = "answer", children = "vote")                   <.>
+            }
+    )
+    private JoinField<String> relation;                                                   <.>
+
+    private Statement() {
+    }
+
+    public static StatementBuilder builder() {
+        return new StatementBuilder();
+    }
+
+    public String getId() {
+        return id;
+    }
+
+    public void setId(String id) {
+        this.id = id;
+    }
+
+    public String getRouting() {
+        return routing;
+    }
+
+    public void setRouting(String routing) {
+        this.routing = routing;
+    }
+
+    public String getText() {
+        return text;
+    }
+
+    public void setText(String text) {
+        this.text = text;
+    }
+
+    public JoinField<String> getRelation() {
+        return relation;
+    }
+
+    public void setRelation(JoinField<String> relation) {
+        this.relation = relation;
+    }
+
+    public static final class StatementBuilder {
+        private String id;
+        private String text;
+        private String routing;
+        private JoinField<String> relation;
+
+        private StatementBuilder() {
+        }
+
+        public StatementBuilder withId(String id) {
+            this.id = id;
+            return this;
+        }
+
+        public StatementBuilder withRouting(String routing) {
+            this.routing = routing;
+            return this;
+        }
+
+        public StatementBuilder withText(String text) {
+            this.text = text;
+            return this;
+        }
+
+        public StatementBuilder withRelation(JoinField<String> relation) {
+            this.relation = relation;
+            return this;
+        }
+
+        public Statement build() {
+            Statement statement = new Statement();
+            statement.setId(id);
+            statement.setRouting(routing);
+            statement.setText(text);
+            statement.setRelation(relation);
+            return statement;
+        }
+    }
+}
+----
+<.> for routing related info see xref:elasticsearch/routing.adoc[Routing values]
+<.> a question can have answers and comments
+<.> an answer can have votes
+<.> the `JoinField` property is used to combine the name (_question_, _answer_, _comment_ or _vote_) of the relation with the parent id.
+The generic type must be the same as the `@Id` annotated property.
+====
+
+Spring Data Elasticsearch will build the following mapping for this class:
+
+====
+[source,json]
+----
+{
+  "statements": {
+    "mappings": {
+      "properties": {
+        "_class": {
+          "type": "text",
+          "fields": {
+            "keyword": {
+              "type": "keyword",
+              "ignore_above": 256
+            }
+          }
+        },
+        "routing": {
+          "type": "keyword"
+        },
+        "relation": {
+          "type": "join",
+          "eager_global_ordinals": true,
+          "relations": {
+            "question": [
+              "answer",
+              "comment"
+            ],
+            "answer": "vote"
+          }
+        },
+        "text": {
+          "type": "text"
+        }
+      }
+    }
+  }
+}
+----
+====
+
+[[elasticsearch.jointype.storing]]
+==  Storing data
+
+Given a repository for this class the following code inserts a question, two answers, a comment and a vote:
+
+====
+[source,java]
+----
+void init() {
+    repository.deleteAll();
+
+    Statement savedWeather = repository.save(
+        Statement.builder()
+            .withText("How is the weather?")
+            .withRelation(new JoinField<>("question"))                          <1>
+            .build());
+
+    Statement sunnyAnswer = repository.save(
+        Statement.builder()
+            .withText("sunny")
+            .withRelation(new JoinField<>("answer", savedWeather.getId()))      <2>
+            .build());
+
+    repository.save(
+        Statement.builder()
+            .withText("rainy")
+            .withRelation(new JoinField<>("answer", savedWeather.getId()))      <3>
+            .build());
+
+    repository.save(
+        Statement.builder()
+            .withText("I don't like the rain")
+            .withRelation(new JoinField<>("comment", savedWeather.getId()))     <4>
+            .build());
+
+    repository.save(
+        Statement.builder()
+            .withText("+1 for the sun")
+            .withRouting(savedWeather.getId())
+            .withRelation(new JoinField<>("vote", sunnyAnswer.getId()))         <5>
+            .build());
+}
+----
+<1> create a question statement
+<2> the first answer to the question
+<3> the second answer
+<4> a comment to the question
+<5> a vote for the first answer, this needs to have the routing set to the weather document, see xref:elasticsearch/routing.adoc[Routing values].
+====
+
+[[elasticsearch.jointype.retrieving]]
+==  Retrieving data
+
+Currently native queries must be used to query the data, so there is no support from standard repository methods. xref:repositories/custom-implementations.adoc[] can be used instead.
+
+The following code shows as an example how to retrieve all entries that have a _vote_ (which must be _answers_, because only answers can have a vote) using an `ElasticsearchOperations` instance:
+
+====
+[source,java]
+----
+SearchHits<Statement> hasVotes() {
+
+	Query query = NativeQuery.builder()
+		.withQuery(co.elastic.clients.elasticsearch._types.query_dsl.Query.of(qb -> qb
+			.hasChild(hc -> hc
+				.type("answer")
+				.queryName("vote")
+				.query(matchAllQueryAsQuery())
+				.scoreMode(ChildScoreMode.None)
+			)))
+		.build();
+
+	return operations.search(query, Statement.class);
+}
+----
+====

src/main/antora/modules/ROOT/pages/elasticsearch/misc.adoc

@@ -0,0 +1,453 @@
+[[elasticsearch.misc]]
+= Miscellaneous Elasticsearch Operation Support
+
+This chapter covers additional support for Elasticsearch operations that cannot be directly accessed via the repository interface.
+It is recommended to add those operations as custom implementation as described in xref:repositories/custom-implementations.adoc[] .
+
+[[elasticsearc.misc.index.settings]]
+== Index settings
+
+When creating Elasticsearch indices with Spring Data Elasticsearch different index settings can be defined by using the `@Setting` annotation.
+The following arguments are available:
+
+* `useServerConfiguration` does not send any settings parameters, so the Elasticsearch server configuration determines them.
+* `settingPath` refers to a JSON file defining the settings that must be resolvable in the classpath
+* `shards` the number of shards to use, defaults to _1_
+* `replicas` the number of replicas, defaults to _1_
+* `refreshIntervall`, defaults to _"1s"_
+* `indexStoreType`, defaults to _"fs"_
+
+It is as well possible to define https://www.elastic.co/guide/en/elasticsearch/reference/7.11/index-modules-index-sorting.html[index sorting] (check the linked Elasticsearch documentation for the possible field types and values):
+
+====
+[source,java]
+----
+@Document(indexName = "entities")
+@Setting(
+  sortFields = { "secondField", "firstField" },                                  <.>
+  sortModes = { Setting.SortMode.max, Setting.SortMode.min },                    <.>
+  sortOrders = { Setting.SortOrder.desc, Setting.SortOrder.asc },
+  sortMissingValues = { Setting.SortMissing._last, Setting.SortMissing._first })
+class Entity {
+    @Nullable
+    @Id private String id;
+
+    @Nullable
+    @Field(name = "first_field", type = FieldType.Keyword)
+    private String firstField;
+
+    @Nullable @Field(name = "second_field", type = FieldType.Keyword)
+    private String secondField;
+
+    // getter and setter...
+}
+----
+
+<.> when defining sort fields, use the name of the Java property (_firstField_), not the name that might be defined for Elasticsearch (_first_field_)
+<.> `sortModes`, `sortOrders` and `sortMissingValues` are optional, but if they are set, the number of entries must match the number of `sortFields` elements
+====
+
+[[elasticsearch.misc.mappings]]
+== Index Mapping
+
+When Spring Data Elasticsearch creates the index mapping with the `IndexOperations.createMapping()` methods, it uses the annotations described in xref:elasticsearch/object-mapping.adoc#elasticsearch.mapping.meta-model.annotations[Mapping Annotation Overview], especially the `@Field` annotation.
+In addition to that it is possible to add the `@Mapping` annotation to a class.
+This annotation has the following properties:
+
+* `mappingPath` a classpath resource in JSON format; if this is not empty it is used as the mapping, no other mapping processing is done.
+* `enabled`  when set to false, this flag is written to the mapping and no further processing is done.
+* `dateDetection` and `numericDetection` set the corresponding properties in the mapping when not set to `DEFAULT`.
+* `dynamicDateFormats` when this String array is not empty, it defines the date formats used for automatic date detection.
+* `runtimeFieldsPath` a classpath resource in JSON format containing the definition of runtime fields which is written to the index mappings, for example:
+
+====
+[source,json]
+----
+{
+  "day_of_week": {
+    "type": "keyword",
+    "script": {
+      "source": "emit(doc['@timestamp'].value.dayOfWeekEnum.getDisplayName(TextStyle.FULL, Locale.ROOT))"
+    }
+  }
+}
+----
+====
+
+[[elasticsearch.misc.filter]]
+== Filter Builder
+
+Filter Builder improves query speed.
+
+====
+[source,java]
+----
+private ElasticsearchOperations operations;
+
+IndexCoordinates index = IndexCoordinates.of("sample-index");
+
+Query query = NativeQuery.builder()
+	.withQuery(q -> q
+		.matchAll(ma -> ma))
+	.withFilter( q -> q
+		.bool(b -> b
+			.must(m -> m
+				.term(t -> t
+					.field("id")
+					.value(documentId))
+			)))
+	.build();
+
+SearchHits<SampleEntity> sampleEntities = operations.search(query, SampleEntity.class, index);
+----
+====
+
+[[elasticsearch.scroll]]
+== Using Scroll For Big Result Set
+
+Elasticsearch has a scroll API for getting big result set in chunks.
+This is internally used by Spring Data Elasticsearch to provide the implementations of the `<T> SearchHitsIterator<T> SearchOperations.searchForStream(Query query, Class<T> clazz, IndexCoordinates index)` method.
+
+====
+[source,java]
+----
+IndexCoordinates index = IndexCoordinates.of("sample-index");
+
+Query searchQuery = NativeQuery.builder()
+    .withQuery(q -> q
+        .matchAll(ma -> ma))
+    .withFields("message")
+    .withPageable(PageRequest.of(0, 10))
+    .build();
+
+SearchHitsIterator<SampleEntity> stream = elasticsearchOperations.searchForStream(searchQuery, SampleEntity.class,
+index);
+
+List<SampleEntity> sampleEntities = new ArrayList<>();
+while (stream.hasNext()) {
+  sampleEntities.add(stream.next());
+}
+
+stream.close();
+----
+====
+
+There are no methods in the `SearchOperations` API to access the scroll id, if it should be necessary to access this, the following methods of the `AbstractElasticsearchTemplate` can be used (this is the base implementation for the different `ElasticsearchOperations` implementations):
+
+====
+[source,java]
+----
+
+@Autowired ElasticsearchOperations operations;
+
+AbstractElasticsearchTemplate template = (AbstractElasticsearchTemplate)operations;
+
+IndexCoordinates index = IndexCoordinates.of("sample-index");
+
+Query query = NativeQuery.builder()
+    .withQuery(q -> q
+        .matchAll(ma -> ma))
+    .withFields("message")
+    .withPageable(PageRequest.of(0, 10))
+    .build();
+
+SearchScrollHits<SampleEntity> scroll = template.searchScrollStart(1000, query, SampleEntity.class, index);
+
+String scrollId = scroll.getScrollId();
+List<SampleEntity> sampleEntities = new ArrayList<>();
+while (scroll.hasSearchHits()) {
+  sampleEntities.addAll(scroll.getSearchHits());
+  scrollId = scroll.getScrollId();
+  scroll = template.searchScrollContinue(scrollId, 1000, SampleEntity.class);
+}
+template.searchScrollClear(scrollId);
+----
+====
+
+To use the Scroll API with repository methods, the return type must defined as `Stream` in the Elasticsearch Repository.
+The implementation of the method will then use the scroll methods from the ElasticsearchTemplate.
+
+====
+[source,java]
+----
+interface SampleEntityRepository extends Repository<SampleEntity, String> {
+
+    Stream<SampleEntity> findBy();
+
+}
+----
+====
+
+[[elasticsearch.misc.sorts]]
+== Sort options
+
+In addition to the default sort options described in xref:repositories/query-methods-details.adoc#repositories.paging-and-sorting[Paging and Sorting], Spring Data Elasticsearch provides the class `org.springframework.data.elasticsearch.core.query.Order` which derives from `org.springframework.data.domain.Sort.Order`.
+It offers additional parameters that can be sent to Elasticsearch when specifying the sorting of the result (see https://www.elastic.co/guide/en/elasticsearch/reference/7.15/sort-search-results.html).
+
+There also is the  `org.springframework.data.elasticsearch.core.query.GeoDistanceOrder` class which can be used to have the result of a search operation ordered by geographical distance.
+
+If the class to be retrieved has a `GeoPoint` property named _location_, the following `Sort` would sort the results by distance to the given point:
+
+====
+[source,java]
+----
+Sort.by(new GeoDistanceOrder("location", new GeoPoint(48.137154, 11.5761247)))
+----
+====
+
+[[elasticsearch.misc.runtime-fields]]
+== Runtime Fields
+
+From version 7.12 on Elasticsearch has added the feature of runtime fields (https://www.elastic.co/guide/en/elasticsearch/reference/7.12/runtime.html).
+Spring Data Elasticsearch supports this in two ways:
+
+[[elasticsearch.misc.runtime-fields.index-mappings]]
+=== Runtime field definitions in the index mappings
+
+The first way to define runtime fields is by adding the definitions to the index mappings (see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/runtime-mapping-fields.html).
+To use this approach in Spring Data Elasticsearch the user must provide a JSON file that contains the corresponding definition, for example:
+
+.runtime-fields.json
+====
+[source,json]
+----
+{
+  "day_of_week": {
+    "type": "keyword",
+    "script": {
+      "source": "emit(doc['@timestamp'].value.dayOfWeekEnum.getDisplayName(TextStyle.FULL, Locale.ROOT))"
+    }
+  }
+}
+----
+====
+
+The path to this JSON file, which must be present on the classpath, must then be set in the `@Mapping` annotation of the entity:
+
+====
+[source,java]
+----
+@Document(indexName = "runtime-fields")
+@Mapping(runtimeFieldsPath = "/runtime-fields.json")
+public class RuntimeFieldEntity {
+	// properties, getter, setter,...
+}
+
+----
+====
+
+[[elasticsearch.misc.runtime-fields.query]]
+=== Runtime fields definitions set on a Query
+
+The second way to define runtime fields is by adding the definitions to a search query (see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/runtime-search-request.html).
+The following code example shows how to do this with Spring Data Elasticsearch :
+
+The entity used is a simple object that has a `price` property:
+
+====
+[source,java]
+----
+@Document(indexName = "some_index_name")
+public class SomethingToBuy {
+
+	private @Id @Nullable String id;
+	@Nullable @Field(type = FieldType.Text) private String description;
+	@Nullable @Field(type = FieldType.Double) private Double price;
+
+	// getter and setter
+}
+
+----
+====
+
+The following query uses a runtime field that calculates a `priceWithTax` value by adding 19% to the price and uses this value in the search query to find all entities where `priceWithTax` is higher or equal than a given value:
+
+====
+[source,java]
+----
+RuntimeField runtimeField = new RuntimeField("priceWithTax", "double", "emit(doc['price'].value * 1.19)");
+Query query = new CriteriaQuery(new Criteria("priceWithTax").greaterThanEqual(16.5));
+query.addRuntimeField(runtimeField);
+
+SearchHits<SomethingToBuy> searchHits = operations.search(query, SomethingToBuy.class);
+----
+====
+
+This works with every implementation of the `Query` interface.
+
+[[elasticsearch.misc.point-in-time]]
+== Point In Time (PIT) API
+
+`ElasticsearchOperations` supports the point in time API of Elasticsearch (see https://www.elastic.co/guide/en/elasticsearch/reference/8.3/point-in-time-api.html).
+The following code snippet shows how to use this feature with a fictional `Person` class:
+
+====
+[source,java]
+----
+ElasticsearchOperations operations; // autowired
+Duration tenSeconds = Duration.ofSeconds(10);
+
+String pit = operations.openPointInTime(IndexCoordinates.of("person"), tenSeconds); <.>
+
+// create query for the pit
+Query query1 = new CriteriaQueryBuilder(Criteria.where("lastName").is("Smith"))
+    .withPointInTime(new Query.PointInTime(pit, tenSeconds))                        <.>
+    .build();
+SearchHits<Person> searchHits1 = operations.search(query1, Person.class);
+// do something with the data
+
+// create 2nd query for the pit, use the id returned in the previous result
+Query query2 = new CriteriaQueryBuilder(Criteria.where("lastName").is("Miller"))
+    .withPointInTime(
+        new Query.PointInTime(searchHits1.getPointInTimeId(), tenSeconds))          <.>
+    .build();
+SearchHits<Person> searchHits2 = operations.search(query2, Person.class);
+// do something with the data
+
+operations.closePointInTime(searchHits2.getPointInTimeId());                        <.>
+
+----
+
+<.> create a point in time for an index (can be multiple names) and a keep-alive duration and retrieve its id
+<.> pass that id into the query to search together with the next keep-alive value
+<.> for the next query, use the id returned from the previous search
+<.> when done, close the point in time using the last returned id
+====
+
+[[elasticsearch.misc.searchtemplates]]
+== Search Template support
+
+Use of the search template API is supported.
+To use this, it first is necessary to create a stored script.
+The `ElasticsearchOperations` interface extends `ScriptOperations` which provides the necessary functions.
+The example used here assumes that we have `Person` entity with a property named `firstName`.
+A search template script can be saved like this:
+
+====
+[source,java]
+----
+import org.springframework.data.elasticsearch.core.ElasticsearchOperations;
+import org.springframework.data.elasticsearch.core.script.Script;
+
+operations.putScript(                            <.>
+  Script.builder()
+    .withId("person-firstname")                  <.>
+    .withLanguage("mustache")                    <.>
+    .withSource("""                              <.>
+      {
+        "query": {
+          "bool": {
+            "must": [
+              {
+                "match": {
+                  "firstName": "{{firstName}}"   <.>
+                }
+              }
+            ]
+          }
+        },
+        "from": "{{from}}",                      <.>
+        "size": "{{size}}"                       <.>
+      }
+      """)
+    .build()
+);
+----
+
+<.> Use the `putScript()` method to store a search template script
+<.> The name / id of the script
+<.> Scripts that are used in search templates must be in the _mustache_ language.
+<.> The script source
+<.> The search parameter in the script
+<.> Paging request offset
+<.> Paging request size
+====
+
+To use a search template in a search query, Spring Data Elasticsearch provides the `SearchTemplateQuery`, an implementation of the `org.springframework.data.elasticsearch.core.query.Query` interface.
+
+NOTE: Although `SearchTemplateQuery` is an implementation of the `Query` interface, not all of the functionality provided by the base class is available for a `SearchTemplateQuery` like setting a `Pageable` or a `Sort`. Values for this functionality must be added to the stored script like shown in the following example for paging parameters. If these values are set on the `Query` object, they will be ignored.
+
+In the following code, we will add a call using a search template query to a custom repository implementation (see
+xref:repositories/custom-implementations.adoc[]) as an example how this can be integrated into a repository call.
+
+We first define the custom repository fragment interface:
+
+====
+[source,java]
+----
+interface PersonCustomRepository {
+	SearchPage<Person> findByFirstNameWithSearchTemplate(String firstName, Pageable pageable);
+}
+----
+====
+
+The implementation of this repository fragment looks like this:
+
+====
+[source,java]
+----
+public class PersonCustomRepositoryImpl implements PersonCustomRepository {
+
+  private final ElasticsearchOperations operations;
+
+  public PersonCustomRepositoryImpl(ElasticsearchOperations operations) {
+    this.operations = operations;
+  }
+
+  @Override
+  public SearchPage<Person> findByFirstNameWithSearchTemplate(String firstName, Pageable pageable) {
+
+    var query = SearchTemplateQuery.builder()                               <.>
+      .withId("person-firstname")                                           <.>
+      .withParams(
+        Map.of(                                                             <.>
+          "firstName", firstName,
+          "from", pageable.getOffset(),
+          "size", pageable.getPageSize()
+          )
+      )
+      .build();
+
+    SearchHits<Person> searchHits = operations.search(query, Person.class); <.>
+
+    return SearchHitSupport.searchPageFor(searchHits, pageable);
+  }
+}
+----
+
+<.> Create a `SearchTemplateQuery`
+<.> Provide the id of the search template
+<.> The parameters are passed in a `Map<String,Object>`
+<.> Do the search in the same way as with the other query types.
+====
+
+[[elasticsearch.misc.nested-sort]]
+== Nested sort
+Spring Data Elasticsearch supports sorting within nested objects (https://www.elastic.co/guide/en/elasticsearch/reference/8.9/sort-search-results.html#nested-sorting)
+
+The following example, taken from the `org.springframework.data.elasticsearch.core.query.sort.NestedSortIntegrationTests` class, shows how to define the nested sort.
+
+====
+[source,java]
+----
+var filter = StringQuery.builder("""
+	{ "term": {"movies.actors.sex": "m"} }
+	""").build();
+var order = new org.springframework.data.elasticsearch.core.query.Order(Sort.Direction.DESC,
+	"movies.actors.yearOfBirth")
+	.withNested(
+		Nested.builder("movies")
+			.withNested(
+				Nested.builder("movies.actors")
+					.withFilter(filter)
+					.build())
+			.build());
+
+var query = Query.findAll().addSort(Sort.by(order));
+
+----
+====
+
+About the filter query: It is not possible to use a `CriteriaQuery` here, as this query would be converted into a Elasticsearch nested query which does not work in the filter context. So only `StringQuery` or `NativeQuery` can be used here. When using one of these, like the term query above, the Elasticsearch field names must be used, so take care, when these are redefined with the `@Field(name="...")` definition.
+
+For the definition of the order path and the nested paths, the Java entity property names should be used.

src/main/antora/modules/ROOT/pages/elasticsearch/object-mapping.adoc

@@ -0,0 +1,478 @@
+[[elasticsearch.mapping]]
+= Elasticsearch Object Mapping
+
+Spring Data Elasticsearch Object Mapping is the process that maps a Java object - the domain entity - into the JSON representation that is stored in Elasticsearch and back.
+The class that is internally used for this mapping is the
+`MappingElasticsearchConverter`.
+
+[[elasticsearch.mapping.meta-model]]
+== Meta Model Object Mapping
+
+The Metamodel based approach uses domain type information for reading/writing from/to Elasticsearch.
+This allows to register `Converter` instances for specific domain type mapping.
+
+[[elasticsearch.mapping.meta-model.annotations]]
+=== Mapping Annotation Overview
+
+The `MappingElasticsearchConverter` uses metadata to drive the mapping of objects to documents.
+The metadata is taken from the entity's properties which can be annotated.
+
+The following annotations are available:
+
+* `@Document`: Applied at the class level to indicate this class is a candidate for mapping to the database.
+The most important attributes are (check the API documentation for the complete list of attributes):
+** `indexName`: the name of the index to store this entity in.
+This can contain a SpEL template expression like `"log-#{T(java.time.LocalDate).now().toString()}"`
+** `createIndex`: flag whether to create an index on repository bootstrapping.
+Default value is _true_.
+See xref:elasticsearch/repositories/elasticsearch-repositories.adoc#elasticsearch.repositories.autocreation[Automatic creation of indices with the corresponding mapping]
+
+
+* `@Id`: Applied at the field level to mark the field used for identity purpose.
+* `@Transient`, `@ReadOnlyProperty`, `@WriteOnlyProperty`: see the following section xref:elasticsearch/object-mapping.adoc#elasticsearch.mapping.meta-model.annotations.read-write[Controlling which properties are written to and read from Elasticsearch] for detailed information.
+* `@PersistenceConstructor`: Marks a given constructor - even a package protected one - to use when instantiating the object from the database.
+Constructor arguments are mapped by name to the key values in the retrieved Document.
+* `@Field`: Applied at the field level and defines properties of the field, most of the attributes map to the respective https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping.html[Elasticsearch Mapping] definitions (the following list is not complete, check the annotation Javadoc for a complete reference):
+** `name`: The name of the field as it will be represented in the Elasticsearch document, if not set, the Java field name is used.
+** `type`: The field type, can be one of _Text, Keyword, Long, Integer, Short, Byte, Double, Float, Half_Float, Scaled_Float, Date, Date_Nanos, Boolean, Binary, Integer_Range, Float_Range, Long_Range, Double_Range, Date_Range, Ip_Range, Object, Nested, Ip, TokenCount, Percolator, Flattened, Search_As_You_Type_.
+See https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-types.html[Elasticsearch Mapping Types].
+If the field type is not specified, it defaults to `FieldType.Auto`.
+This means, that no mapping entry is written for the property and that Elasticsearch will add a mapping entry dynamically when the first data for this property is stored (check the Elasticsearch documentation for dynamic mapping rules).
+** `format`: One or more built-in date formats, see the next section xref:elasticsearch/object-mapping.adoc#elasticsearch.mapping.meta-model.annotations.date-formats[Date format mapping].
+** `pattern`: One or more custom date formats, see the next section xref:elasticsearch/object-mapping.adoc#elasticsearch.mapping.meta-model.annotations.date-formats[Date format mapping].
+** `store`: Flag whether the original field value should be store in Elasticsearch, default value is _false_.
+** `analyzer`, `searchAnalyzer`, `normalizer` for specifying custom analyzers and normalizer.
+* `@GeoPoint`: Marks a field as _geo_point_ datatype.
+Can be omitted if the field is an instance of the `GeoPoint` class.
+* `@ValueConverter` defines a class to be used to convert the given property.
+In difference to a registered Spring `Converter` this only converts the annotated property and not every property of the given type.
+
+The mapping metadata infrastructure is defined in a separate spring-data-commons project that is technology agnostic.
+
+[[elasticsearch.mapping.meta-model.annotations.read-write]]
+==== Controlling which properties are written to and read from Elasticsearch
+
+This section details the annotations that define if the value of a property is written to or read from Elasticsearch.
+
+`@Transient`: A property annotated with this annotation will not be written to the mapping, it's value will not be sent to Elasticsearch and when documents are returned from Elasticsearch, this property will not be set in the resulting entity.
+
+`@ReadOnlyProperty`: A property with this annotation will not have its value written to Elasticsearch, but when returning data, the property will be filled with the value returned in the document from Elasticsearch.
+One use case for this are runtime fields defined in the index mapping.
+
+`@WriteOnlyProperty`: A property with this annotation will have its value stored in Elasticsearch but will not be set with any value when reading document.
+This can be used for example for synthesized fields which should go into the Elasticsearch index but are not used elsewhere.
+
+[[elasticsearch.mapping.meta-model.annotations.date-formats]]
+==== Date format mapping
+
+Properties that derive from `TemporalAccessor` or are of type `java.util.Date` must either have a `@Field` annotation of type `FieldType.Date` or a custom converter must be registered for this type.
+This paragraph describes the use of
+`FieldType.Date`.
+
+There are two attributes of the `@Field` annotation that define which date format information is written to the mapping (also see https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-date-format.html#built-in-date-formats[Elasticsearch Built In Formats] and https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-date-format.html#custom-date-formats[Elasticsearch Custom Date Formats])
+
+The `format` attribute is used to define at least one of the predefined formats.
+If it is not defined, then a default value of __date_optional_time_ and _epoch_millis_ is used.
+
+The `pattern` attribute can be used to add additional custom format strings.
+If you want to use only custom date formats, you must set the `format` property to empty `{}`.
+
+The following table shows the different attributes and the mapping created from their values:
+
+[cols=2*,options=header]
+|===
+| annotation
+| format string in Elasticsearch mapping
+
+| @Field(type=FieldType.Date)
+| "date_optional_time\|\|epoch_millis",
+
+| @Field(type=FieldType.Date, format=DateFormat.basic_date)
+| "basic_date"
+
+| @Field(type=FieldType.Date, format={DateFormat.basic_date, DateFormat.basic_time})
+| "basic_date\|\|basic_time"
+
+| @Field(type=FieldType.Date, pattern="dd.MM.uuuu")
+| "date_optional_time\|\|epoch_millis\|\|dd.MM.uuuu",
+
+| @Field(type=FieldType.Date, format={}, pattern="dd.MM.uuuu")
+| "dd.MM.uuuu"
+
+|===
+
+NOTE: If you are using a custom date format, you need to use _uuuu_ for the year instead of _yyyy_.
+This is due to a https://www.elastic.co/guide/en/elasticsearch/reference/current/migrate-to-java-time.html#java-time-migration-incompatible-date-formats[change in Elasticsearch 7].
+
+Check the code of the `org.springframework.data.elasticsearch.annotations.DateFormat` enum for a complete list of predefined values and their patterns.
+
+[[elasticsearch.mapping.meta-model.annotations.range]]
+==== Range types
+
+When a field is annotated with a type of one of _Integer_Range, Float_Range, Long_Range, Double_Range, Date_Range,_ or _Ip_Range_ the field must be an instance of a class that will be mapped to an Elasticsearch range, for example:
+
+====
+[source,java]
+----
+class SomePersonData {
+
+    @Field(type = FieldType.Integer_Range)
+    private ValidAge validAge;
+
+    // getter and setter
+}
+
+class ValidAge {
+    @Field(name="gte")
+    private Integer from;
+
+    @Field(name="lte")
+    private Integer to;
+
+    // getter and setter
+}
+----
+====
+
+As an alternative Spring Data Elasticsearch provides a `Range<T>` class so that the previous example can be written as:
+
+====
+[source,java]
+----
+class SomePersonData {
+
+    @Field(type = FieldType.Integer_Range)
+    private Range<Integer> validAge;
+
+    // getter and setter
+}
+----
+====
+
+Supported classes for the type `<T>` are `Integer`, `Long`, `Float`, `Double`, `Date` and classes that implement the
+`TemporalAccessor` interface.
+
+[[elasticsearch.mapping.meta-model.annotations.mapped-names]]
+==== Mapped field names
+
+Without further configuration, Spring Data Elasticsearch will use the property name of an object as field name in Elasticsearch.
+This can be changed for individual field by using the `@Field` annotation on that property.
+
+It is also possible to define a `FieldNamingStrategy` in the configuration of the client (xref:elasticsearch/clients.adoc[Elasticsearch Clients]).
+If for example a `SnakeCaseFieldNamingStrategy` is configured, the property _sampleProperty_ of the object would be mapped to _sample_property_ in Elasticsearch.
+A `FieldNamingStrategy` applies to all entities; it can be overwritten by setting a specific name with `@Field` on a property.
+
+[[elasticsearch.mapping.meta-model.annotations.non-field-backed-properties]]
+==== Non-field-backed properties
+
+Normally the properties used in an entity are fields of the entity class.
+There might be cases, when a property value is calculated in the entity and should be stored in Elasticsearch.
+In this case, the getter method (`getProperty()`) can be annotated with the `@Field` annotation, in addition to that the method must be annotated with `@AccessType(AccessType.Type
+.PROPERTY)`.
+The third annotation that is needed in such a case is `@WriteOnlyProperty`, as such a value is only written to Elasticsearch.
+A full example:
+
+====
+[source,java]
+----
+@Field(type = Keyword)
+@WriteOnlyProperty
+@AccessType(AccessType.Type.PROPERTY)
+public String getProperty() {
+	return "some value that is calculated here";
+}
+----
+====
+
+[[elasticsearch.mapping.meta-model.annotations.misc]]
+==== Other property annotations
+
+[[indexedindexname]]
+===== @IndexedIndexName
+
+This annotation can be set on a String property of an entity.
+This property will not be written to the mapping, it will not be stored in Elasticsearch and its value will not be read from an Elasticsearch document.
+After an entity is persisted, for example with a call to `ElasticsearchOperations.save(T entity)`, the entity returned from that call will contain the name of the index that an entity was saved to in that property.
+This is useful when the index name is dynamically set by a bean, or when writing to a write alias.
+
+Putting some value into such a property does not set the index into which an entity is stored!
+
+[[elasticsearch.mapping.meta-model.rules]]
+=== Mapping Rules
+
+[[elasticsearch.mapping.meta-model.rules.typehints]]
+==== Type Hints
+
+Mapping uses _type hints_ embedded in the document sent to the server to allow generic type mapping.
+Those type hints are represented as `_class` attributes within the document and are written for each aggregate root.
+
+.Type Hints
+====
+[source,java]
+----
+public class Person {              <1>
+  @Id String id;
+  String firstname;
+  String lastname;
+}
+----
+
+[source,json]
+----
+{
+  "_class" : "com.example.Person", <1>
+  "id" : "cb7bef",
+  "firstname" : "Sarah",
+  "lastname" : "Connor"
+}
+----
+
+<1> By default the domain types class name is used for the type hint.
+====
+
+Type hints can be configured to hold custom information.
+Use the `@TypeAlias` annotation to do so.
+
+NOTE: Make sure to add types with `@TypeAlias` to the initial entity set (`AbstractElasticsearchConfiguration#getInitialEntitySet`) to already have entity information available when first reading data from the store.
+
+.Type Hints with Alias
+====
+[source,java]
+----
+@TypeAlias("human")                <1>
+public class Person {
+
+  @Id String id;
+  // ...
+}
+----
+
+[source,json]
+----
+{
+  "_class" : "human",              <1>
+  "id" : ...
+}
+----
+
+<1> The configured alias is used when writing the entity.
+====
+
+NOTE: Type hints will not be written for nested Objects unless the properties type is `Object`, an interface or the actual value type does not match the properties declaration.
+
+[[disabling-type-hints]]
+===== Disabling Type Hints
+
+It may be necessary to disable writing of type hints when the index that should be used already exists without having the type hints defined in its mapping and with the mapping mode set to strict.
+In this case, writing the type hint will produce an error, as the field cannot be added automatically.
+
+Type hints can be disabled for the whole application by overriding the method `writeTypeHints()` in a configuration class derived from `AbstractElasticsearchConfiguration` (see xref:elasticsearch/clients.adoc[Elasticsearch Clients]).
+
+As an alternative they can be disabled for a single index with the `@Document` annotation:
+
+====
+[source,java]
+----
+@Document(indexName = "index", writeTypeHint = WriteTypeHint.FALSE)
+----
+====
+
+WARNING: We strongly advise against disabling Type Hints.
+Only do this if you are forced to.
+Disabling type hints can lead to documents not being retrieved correctly from Elasticsearch in case of polymorphic data or document retrieval may fail completely.
+
+[[elasticsearch.mapping.meta-model.rules.geospatial]]
+==== Geospatial Types
+
+Geospatial types like `Point` & `GeoPoint` are converted into _lat/lon_ pairs.
+
+.Geospatial types
+====
+[source,java]
+----
+public class Address {
+  String city, street;
+  Point location;
+}
+----
+
+[source,json]
+----
+{
+  "city" : "Los Angeles",
+  "street" : "2800 East Observatory Road",
+  "location" : { "lat" : 34.118347, "lon" : -118.3026284 }
+}
+----
+====
+
+[[elasticsearch.mapping.meta-model.rules.geojson]]
+==== GeoJson Types
+
+Spring Data Elasticsearch supports the GeoJson types by providing an interface `GeoJson` and implementations for the different geometries.
+They are mapped to Elasticsearch documents according to the GeoJson specification.
+The corresponding properties of the entity are specified in the index mappings as `geo_shape` when the index mappings is written. (check the https://www.elastic.co/guide/en/elasticsearch/reference/current/geo-shape.html[Elasticsearch documentation] as well)
+
+.GeoJson types
+====
+[source,java]
+----
+public class Address {
+
+  String city, street;
+  GeoJsonPoint location;
+}
+----
+
+[source,json]
+----
+{
+  "city": "Los Angeles",
+  "street": "2800 East Observatory Road",
+  "location": {
+    "type": "Point",
+    "coordinates": [-118.3026284, 34.118347]
+  }
+}
+----
+====
+
+The following GeoJson types are implemented:
+
+* `GeoJsonPoint`
+* `GeoJsonMultiPoint`
+* `GeoJsonLineString`
+* `GeoJsonMultiLineString`
+* `GeoJsonPolygon`
+* `GeoJsonMultiPolygon`
+* `GeoJsonGeometryCollection`
+
+[[elasticsearch.mapping.meta-model.rules.collections]]
+==== Collections
+
+For values inside Collections apply the same mapping rules as for aggregate roots when it comes to _type hints_ and xref:elasticsearch/object-mapping.adoc#elasticsearch.mapping.meta-model.conversions[Custom Conversions].
+
+.Collections
+====
+[source,java]
+----
+public class Person {
+
+  // ...
+
+  List<Person> friends;
+
+}
+----
+
+[source,json]
+----
+{
+  // ...
+
+  "friends" : [ { "firstname" : "Kyle", "lastname" : "Reese" } ]
+}
+----
+====
+
+[[elasticsearch.mapping.meta-model.rules.maps]]
+==== Maps
+
+For values inside Maps apply the same mapping rules as for aggregate roots when it comes to _type hints_ and xref:elasticsearch/object-mapping.adoc#elasticsearch.mapping.meta-model.conversions[Custom Conversions].
+However the Map key needs to a String to be processed by Elasticsearch.
+
+.Collections
+====
+[source,java]
+----
+public class Person {
+
+  // ...
+
+  Map<String, Address> knownLocations;
+
+}
+----
+
+[source,json]
+----
+{
+  // ...
+
+  "knownLocations" : {
+    "arrivedAt" : {
+       "city" : "Los Angeles",
+       "street" : "2800 East Observatory Road",
+       "location" : { "lat" : 34.118347, "lon" : -118.3026284 }
+     }
+  }
+}
+----
+====
+
+[[elasticsearch.mapping.meta-model.conversions]]
+=== Custom Conversions
+
+Looking at the `Configuration` from the xref:elasticsearch/object-mapping.adoc#elasticsearch.mapping.meta-model[previous section] `ElasticsearchCustomConversions` allows registering specific rules for mapping domain and simple types.
+
+.Meta Model Object Mapping Configuration
+====
+[source,java]
+----
+@Configuration
+public class Config extends ElasticsearchConfiguration  {
+
+	@Override
+	public ClientConfiguration clientConfiguration() {
+		return ClientConfiguration.builder() //
+				.connectedTo("localhost:9200") //
+				.build();
+	}
+
+  @Bean
+  @Override
+  public ElasticsearchCustomConversions elasticsearchCustomConversions() {
+    return new ElasticsearchCustomConversions(
+      Arrays.asList(new AddressToMap(), new MapToAddress()));       <1>
+  }
+
+  @WritingConverter                                                 <2>
+  static class AddressToMap implements Converter<Address, Map<String, Object>> {
+
+    @Override
+    public Map<String, Object> convert(Address source) {
+
+      LinkedHashMap<String, Object> target = new LinkedHashMap<>();
+      target.put("ciudad", source.getCity());
+      // ...
+
+      return target;
+    }
+  }
+
+  @ReadingConverter                                                 <3>
+  static class MapToAddress implements Converter<Map<String, Object>, Address> {
+
+    @Override
+    public Address convert(Map<String, Object> source) {
+
+      // ...
+      return address;
+    }
+  }
+}
+----
+
+[source,json]
+----
+{
+  "ciudad" : "Los Angeles",
+  "calle" : "2800 East Observatory Road",
+  "localidad" : { "lat" : 34.118347, "lon" : -118.3026284 }
+}
+----
+
+<1> Add `Converter` implementations.
+<2> Set up the `Converter` used for writing `DomainType` to Elasticsearch.
+<3> Set up the `Converter` used for reading `DomainType` from search result.
+====

src/main/antora/modules/ROOT/pages/elasticsearch/reactive-template.adoc

@@ -0,0 +1,65 @@
+[[elasticsearch.reactive.operations]]
+= Reactive Elasticsearch Operations
+
+`ReactiveElasticsearchOperations` is the gateway to executing high level commands against an Elasticsearch cluster using the `ReactiveElasticsearchClient`.
+
+The `ReactiveElasticsearchTemplate` is the default implementation of `ReactiveElasticsearchOperations`.
+
+To get started the `ReactiveElasticsearchOperations` needs to know about the actual client to work with.
+Please see xref:elasticsearch/clients.adoc#elasticsearch.clients.reactiverestclient[Reactive Rest Client] for details on the client and how to configure it.
+
+[[elasticsearch.reactive.operations.usage]]
+== Reactive Operations Usage
+
+`ReactiveElasticsearchOperations` lets you save, find and delete your domain objects and map those objects to documents stored in Elasticsearch.
+
+Consider the following:
+
+.Use the ReactiveElasticsearchOperations
+====
+[source,java]
+----
+@Document(indexName = "marvel")
+public class Person {
+
+  private @Id String id;
+  private String name;
+  private int age;
+  // Getter/Setter omitted...
+}
+----
+
+[source,java]
+----
+
+ReactiveElasticsearchOperations operations;
+
+// ...
+
+operations.save(new Person("Bruce Banner", 42))                    <.>
+  .doOnNext(System.out::println)
+  .flatMap(person -> operations.get(person.id, Person.class))      <.>
+  .doOnNext(System.out::println)
+  .flatMap(person -> operations.delete(person))                    <.>
+  .doOnNext(System.out::println)
+  .flatMap(id -> operations.count(Person.class))                   <.>
+  .doOnNext(System.out::println)
+  .subscribe();                                                    <.>
+----
+
+The above outputs the following sequence on the console.
+
+[source,text]
+----
+> Person(id=QjWCWWcBXiLAnp77ksfR, name=Bruce Banner, age=42)
+> Person(id=QjWCWWcBXiLAnp77ksfR, name=Bruce Banner, age=42)
+> QjWCWWcBXiLAnp77ksfR
+> 0
+----
+
+<.> Insert a new `Person` document into the _marvel_ index . The `id` is generated on server side and set into the instance returned.
+<.> Lookup the `Person` with matching `id` in the _marvel_ index.
+<.> Delete the `Person` with matching `id`, extracted from the given instance, in the _marvel_ index.
+<.> Count the total number of documents in the _marvel_ index.
+<.> Don't forget to _subscribe()_.
+====

src/main/antora/modules/ROOT/pages/elasticsearch/repositories/cdi-integration.adoc

@@ -0,0 +1,35 @@
+[[elasticsearch.cdi]]
+= CDI Integration
+
+The Spring Data Elasticsearch repositories can also be set up using CDI functionality.
+
+.Spring Data Elasticsearch repositories using CDI
+====
+[source,java]
+----
+class ElasticsearchTemplateProducer {
+
+  @Produces
+  @ApplicationScoped
+  public ElasticsearchOperations createElasticsearchTemplate() {
+    // ...                               <1>
+  }
+}
+
+class ProductService {
+
+  private ProductRepository repository;  <2>
+  public Page<Product> findAvailableBookByName(String name, Pageable pageable) {
+    return repository.findByAvailableTrueAndNameStartingWith(name, pageable);
+  }
+  @Inject
+  public void setRepository(ProductRepository repository) {
+    this.repository = repository;
+  }
+}
+----
+
+<1> Create a component by using the same calls as are used in the xref:elasticsearch/template.adoc[Elasticsearch Operations] chapter.
+<2> Let the CDI framework inject the Repository into your class.
+
+====

src/main/antora/modules/ROOT/pages/elasticsearch/repositories/elasticsearch-repositories.adoc

@@ -0,0 +1,197 @@
+[[elasticsearch.repositories]]
+= Elasticsearch Repositories
+
+This chapter includes details of the Elasticsearch repository implementation.
+
+.The sample `Book` entity
+====
+[source,java]
+----
+@Document(indexName="books")
+class Book {
+    @Id
+    private String id;
+
+    @Field(type = FieldType.Text)
+    private String name;
+
+    @Field(type = FieldType.Text)
+    private String summary;
+
+    @Field(type = FieldType.Integer)
+    private Integer price;
+
+	// getter/setter ...
+}
+----
+====
+
+[[elasticsearch.repositories.autocreation]]
+== Automatic creation of indices with the corresponding mapping
+
+The `@Document` annotation has an argument `createIndex`.
+If this argument is set to true - which is the default value - Spring Data Elasticsearch will during bootstrapping the repository support on application startup check if the index defined by the `@Document` annotation exists.
+
+If it does not exist, the index will be created and the mappings derived from the entity's annotations (see xref:elasticsearch/object-mapping.adoc[Elasticsearch Object Mapping]) will be written to the newly created index.
+Details of the index that will be created can be set by using the `@Setting` annotation, refer to xref:elasticsearch/misc.adoc#elasticsearc.misc.index.settings[Index settings] for further information.
+
+
+
+[[elasticsearch.repositories.annotations]]
+== Annotations for repository methods
+
+[[elasticsearch.repositories.annotations.highlight]]
+=== @Highlight
+
+The `@Highlight` annotation on a repository method defines for which fields of the returned entity highlighting should be included.To search for some text in a `Book` 's name or summary and have the found data highlighted, the following repository method can be used:
+
+====
+[source,java]
+----
+interface BookRepository extends Repository<Book, String> {
+
+    @Highlight(fields = {
+        @HighlightField(name = "name"),
+        @HighlightField(name = "summary")
+    })
+    SearchHits<Book> findByNameOrSummary(String text, String summary);
+}
+----
+====
+
+It is possible to define multiple fields to be highlighted like above, and both the `@Highlight` and the `@HighlightField` annotation can further be customized with a `@HighlightParameters` annotation. Check the Javadocs for the possible configuration options.
+
+In the search results the highlight data can be retrieved from the `SearchHit` class.
+
+[[elasticsearch.repositories.annotations.sourcefilters]]
+=== @SourceFilters
+
+Sometimes the user does not need to have all the properties of an entity returned from a search but only a subset.
+Elasticsearch provides source filtering to reduce the amount of data that is transferred across the network to the
+application.
+
+When working with `Query` implementations and the `ElasticsearchOperations` this is easily possible by setting a
+source filter on the query.
+
+When using repository methods there is the `@SourceFilters` annotation:
+
+====
+[source,java]
+----
+interface BookRepository extends Repository<Book, String> {
+
+    @SourceFilters(includes = "name")
+    SearchHits<Book> findByName(String text);
+}
+----
+====
+
+In this example, all the properties of the returned `Book` objects would be `null` except the name.
+
+[[elasticsearch.annotation]]
+== Annotation based configuration
+
+The Spring Data Elasticsearch repositories support can be activated using an annotation through JavaConfig.
+
+.Spring Data Elasticsearch repositories using JavaConfig
+====
+[source,java]
+----
+@Configuration
+@EnableElasticsearchRepositories(                             <1>
+  basePackages = "org.springframework.data.elasticsearch.repositories"
+  )
+static class Config {
+
+  @Bean
+  public ElasticsearchOperations elasticsearchTemplate() {    <2>
+      // ...
+  }
+}
+
+class ProductService {
+
+  private ProductRepository repository;                       <3>
+
+  public ProductService(ProductRepository repository) {
+    this.repository = repository;
+  }
+
+  public Page<Product> findAvailableBookByName(String name, Pageable pageable) {
+    return repository.findByAvailableTrueAndNameStartingWith(name, pageable);
+  }
+}
+----
+
+<1> The `EnableElasticsearchRepositories` annotation activates the Repository support.
+If no base package is configured, it will use the one of the configuration class it is put on.
+<2> Provide a Bean named `elasticsearchTemplate` of type `ElasticsearchOperations` by using one of the configurations shown in the xref:elasticsearch/template.adoc[Elasticsearch Operations] chapter.
+<3> Let Spring inject the Repository bean into your class.
+====
+
+
+[[elasticsearch.namespace]]
+== Spring Namespace
+
+The Spring Data Elasticsearch module contains a custom namespace allowing definition of repository beans as well as elements for instantiating a `ElasticsearchServer` .
+
+Using the `repositories` element looks up Spring Data repositories as described in xref:repositories/create-instances.adoc[].
+
+.Setting up Elasticsearch repositories using Namespace
+====
+[source,xml]
+----
+<?xml version="1.0" encoding="UTF-8"?>
+<beans xmlns="http://www.springframework.org/schema/beans"
+       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+       xmlns:elasticsearch="http://www.springframework.org/schema/data/elasticsearch"
+       xsi:schemaLocation="http://www.springframework.org/schema/beans
+       https://www.springframework.org/schema/beans/spring-beans-3.1.xsd
+       http://www.springframework.org/schema/data/elasticsearch
+       https://www.springframework.org/schema/data/elasticsearch/spring-elasticsearch-1.0.xsd">
+
+  <elasticsearch:repositories base-package="com.acme.repositories" />
+
+</beans>
+----
+====
+
+Using the `Transport Client` or `Rest Client` element registers an instance of `Elasticsearch Server` in the context.
+
+.Transport Client using Namespace
+====
+[source,xml]
+----
+<?xml version="1.0" encoding="UTF-8"?>
+<beans xmlns="http://www.springframework.org/schema/beans"
+       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+       xmlns:elasticsearch="http://www.springframework.org/schema/data/elasticsearch"
+       xsi:schemaLocation="http://www.springframework.org/schema/beans
+       https://www.springframework.org/schema/beans/spring-beans-3.1.xsd
+       http://www.springframework.org/schema/data/elasticsearch
+       https://www.springframework.org/schema/data/elasticsearch/spring-elasticsearch-1.0.xsd">
+
+  <elasticsearch:transport-client id="client" cluster-nodes="localhost:9300,someip:9300" />
+
+</beans>
+----
+====
+
+.Rest Client using Namespace
+====
+[source,xml]
+----
+<?xml version="1.0" encoding="UTF-8"?>
+<beans xmlns="http://www.springframework.org/schema/beans"
+       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+       xmlns:elasticsearch="http://www.springframework.org/schema/data/elasticsearch"
+       xsi:schemaLocation="http://www.springframework.org/schema/data/elasticsearch
+       https://www.springframework.org/schema/data/elasticsearch/spring-elasticsearch.xsd
+       http://www.springframework.org/schema/beans
+       https://www.springframework.org/schema/beans/spring-beans.xsd">
+
+  <elasticsearch:rest-client id="restClient" hosts="http://localhost:9200">
+
+</beans>
+----
+====

src/main/antora/modules/ROOT/pages/elasticsearch/repositories/elasticsearch-repository-queries.adoc

@@ -0,0 +1,592 @@
+[[elasticsearch.query-methods]]
+= Query methods
+
+[[elasticsearch.query-methods.finders]]
+== Query lookup strategies
+
+The Elasticsearch module supports all basic query building feature as string queries, native search queries, criteria based queries or have it being derived from the method name.
+
+[[elasticsearch.query-methods.finders.declared]]
+=== Declared queries
+
+Deriving the query from the method name is not always sufficient and/or may result in unreadable method names.
+In this case one might make use of the `@Query` annotation (see xref:elasticsearch/repositories/elasticsearch-repository-queries.adoc#elasticsearch.query-methods.at-query[Using the @Query Annotation] ).
+
+Another possibility is the use of a search-template, (see xref:elasticsearch/repositories/elasticsearch-repository-queries.adoc#elasticsearch.query-methods.at-searchtemplate-query[Using the @SearchTemplateQuery Annotation] ).
+
+[[elasticsearch.query-methods.criterions]]
+== Query creation
+
+Generally the query creation mechanism for Elasticsearch works as described in xref:repositories/query-methods-details.adoc[].
+Here's a short example of what a Elasticsearch query method translates into:
+
+.Query creation from method names
+====
+[source,java]
+----
+interface BookRepository extends Repository<Book, String> {
+  List<Book> findByNameAndPrice(String name, Integer price);
+}
+----
+====
+
+The method name above will be translated into the following Elasticsearch json query
+
+[source]
+----
+{
+    "query": {
+        "bool" : {
+            "must" : [
+                { "query_string" : { "query" : "?", "fields" : [ "name" ] } },
+                { "query_string" : { "query" : "?", "fields" : [ "price" ] } }
+            ]
+        }
+    }
+}
+----
+
+A list of supported keywords for Elasticsearch is shown below.
+
+[cols="1,2,3",options="header"]
+.Supported keywords inside method names
+|===
+| Keyword
+| Sample
+| Elasticsearch Query String
+
+| `And`
+| `findByNameAndPrice`
+| `{ "query" : {
+"bool" : {
+"must" : [
+{ "query_string" : { "query" : "?", "fields" : [ "name" ] } },
+{ "query_string" : { "query" : "?", "fields" : [ "price" ] } }
+]
+}
+}}`
+
+| `Or`
+| `findByNameOrPrice`
+| `{ "query" : {
+"bool" : {
+"should" : [
+{ "query_string" : { "query" : "?", "fields" : [ "name" ] } },
+{ "query_string" : { "query" : "?", "fields" : [ "price" ] } }
+]
+}
+}}`
+
+| `Is`
+| `findByName`
+| `{ "query" : {
+"bool" : {
+"must" : [
+{ "query_string" : { "query" : "?", "fields" : [ "name" ] } }
+]
+}
+}}`
+
+| `Not`
+| `findByNameNot`
+| `{ "query" : {
+"bool" : {
+"must_not" : [
+{ "query_string" : { "query" : "?", "fields" : [ "name" ] } }
+]
+}
+}}`
+
+| `Between`
+| `findByPriceBetween`
+| `{ "query" : {
+"bool" : {
+"must" : [
+{"range" : {"price" : {"from" : ?, "to" : ?, "include_lower" : true, "include_upper" : true } } }
+]
+}
+}}`
+
+| `LessThan`
+| `findByPriceLessThan`
+| `{ "query" : {
+"bool" : {
+"must" : [
+{"range" : {"price" : {"from" : null, "to" : ?, "include_lower" : true, "include_upper" : false } } }
+]
+}
+}}`
+
+| `LessThanEqual`
+| `findByPriceLessThanEqual`
+| `{ "query" : {
+"bool" : {
+"must" : [
+{"range" : {"price" : {"from" : null, "to" : ?, "include_lower" : true, "include_upper" : true } } }
+]
+}
+}}`
+
+| `GreaterThan`
+| `findByPriceGreaterThan`
+| `{ "query" : {
+"bool" : {
+"must" : [
+{"range" : {"price" : {"from" : ?, "to" : null, "include_lower" : false, "include_upper" : true } } }
+]
+}
+}}`
+
+
+| `GreaterThanEqual`
+| `findByPriceGreaterThanEqual`
+| `{ "query" : {
+"bool" : {
+"must" : [
+{"range" : {"price" : {"from" : ?, "to" : null, "include_lower" : true, "include_upper" : true } } }
+]
+}
+}}`
+
+| `Before`
+| `findByPriceBefore`
+| `{ "query" : {
+"bool" : {
+"must" : [
+{"range" : {"price" : {"from" : null, "to" : ?, "include_lower" : true, "include_upper" : true } } }
+]
+}
+}}`
+
+| `After`
+| `findByPriceAfter`
+| `{ "query" : {
+"bool" : {
+"must" : [
+{"range" : {"price" : {"from" : ?, "to" : null, "include_lower" : true, "include_upper" : true } } }
+]
+}
+}}`
+
+| `Like`
+| `findByNameLike`
+| `{ "query" : {
+"bool" : {
+"must" : [
+{ "query_string" : { "query" : "?*", "fields" : [ "name" ] }, "analyze_wildcard": true }
+]
+}
+}}`
+
+| `StartingWith`
+| `findByNameStartingWith`
+| `{ "query" : {
+"bool" : {
+"must" : [
+{ "query_string" : { "query" : "?*", "fields" : [ "name" ] }, "analyze_wildcard": true }
+]
+}
+}}`
+
+| `EndingWith`
+| `findByNameEndingWith`
+| `{ "query" : {
+"bool" : {
+"must" : [
+{ "query_string" : { "query" : "*?", "fields" : [ "name" ] }, "analyze_wildcard": true }
+]
+}
+}}`
+
+| `Contains/Containing`
+| `findByNameContaining`
+| `{ "query" : {
+"bool" : {
+"must" : [
+{ "query_string" : { "query" : "\*?*", "fields" : [ "name" ] }, "analyze_wildcard": true }
+]
+}
+}}`
+
+| `In` (when annotated as FieldType.Keyword)
+| `findByNameIn(Collection<String>names)`
+| `{ "query" : {
+"bool" : {
+"must" : [
+{"bool" : {"must" : [
+{"terms" : {"name" : ["?","?"]}}
+]
+}
+}
+]
+}
+}}`
+
+
+| `In`
+| `findByNameIn(Collection<String>names)`
+| `{ "query": {"bool": {"must": [{"query_string":{"query": "\"?\" \"?\"", "fields": ["name"]}}]}}}`
+
+| `NotIn`  (when annotated as FieldType.Keyword)
+| `findByNameNotIn(Collection<String>names)`
+| `{ "query" : {
+"bool" : {
+"must" : [
+{"bool" : {"must_not" : [
+{"terms" : {"name" : ["?","?"]}}
+]
+}
+}
+]
+}
+}}`
+
+| `NotIn`
+| `findByNameNotIn(Collection<String>names)`
+| `{"query": {"bool": {"must": [{"query_string": {"query": "NOT(\"?\" \"?\")", "fields": ["name"]}}]}}}`
+
+| `True`
+| `findByAvailableTrue`
+| `{ "query" : {
+"bool" : {
+"must" : [
+{ "query_string" : { "query" : "true", "fields" : [ "available" ] } }
+]
+}
+}}`
+
+| `False`
+| `findByAvailableFalse`
+| `{ "query" : {
+"bool" : {
+"must" : [
+{ "query_string" : { "query" : "false", "fields" : [ "available" ] } }
+]
+}
+}}`
+
+| `OrderBy`
+| `findByAvailableTrueOrderByNameDesc`
+| `{ "query" : {
+"bool" : {
+"must" : [
+{ "query_string" : { "query" : "true", "fields" : [ "available" ] } }
+]
+}
+}, "sort":[{"name":{"order":"desc"}}]
+}`
+
+| `Exists`
+| `findByNameExists`
+| `{"query":{"bool":{"must":[{"exists":{"field":"name"}}]}}}`
+
+| `IsNull`
+| `findByNameIsNull`
+| `{"query":{"bool":{"must_not":[{"exists":{"field":"name"}}]}}}`
+
+| `IsNotNull`
+| `findByNameIsNotNull`
+| `{"query":{"bool":{"must":[{"exists":{"field":"name"}}]}}}`
+
+| `IsEmpty`
+| `findByNameIsEmpty`
+| `{"query":{"bool":{"must":[{"bool":{"must":[{"exists":{"field":"name"}}],"must_not":[{"wildcard":{"name":{"wildcard":"*"}}}]}}]}}}`
+
+| `IsNotEmpty`
+| `findByNameIsNotEmpty`
+| `{"query":{"bool":{"must":[{"wildcard":{"name":{"wildcard":"*"}}}]}}}`
+
+|===
+
+NOTE: Methods names to build Geo-shape queries taking `GeoJson` parameters are not supported.
+Use `ElasticsearchOperations` with `CriteriaQuery` in a custom repository implementation if you need to have such a function in a repository.
+
+[[elasticsearch.query-methods.return-types]]
+== Method return types
+
+Repository methods can be defined to have the following return types for returning multiple Elements:
+
+* `List<T>`
+* `Stream<T>`
+* `SearchHits<T>`
+* `List<SearchHit<T>>`
+* `Stream<SearchHit<T>>`
+* `SearchPage<T>`
+
+[[elasticsearch.query-methods.at-query]]
+== Using the @Query Annotation
+
+.Declare query on the method using the `@Query` annotation.
+====
+The arguments passed to the method can be inserted into placeholders in the query string.
+The placeholders are of the form `?0`, `?1`, `?2` etc. for the first, second, third parameter and so on.
+
+[source,java]
+----
+interface BookRepository extends ElasticsearchRepository<Book, String> {
+    @Query("{\"match\": {\"name\": {\"query\": \"?0\"}}}")
+    Page<Book> findByName(String name,Pageable pageable);
+}
+----
+
+The String that is set as the annotation argument must be a valid Elasticsearch JSON query.
+It will be sent to Easticsearch as value of the query element; if for example the function is called with the parameter _John_, it would produce the following query body:
+
+[source,json]
+----
+{
+  "query": {
+    "match": {
+      "name": {
+        "query": "John"
+      }
+    }
+  }
+}
+----
+====
+
+.`@Query` annotation on a method taking a Collection argument
+====
+A repository method such as
+
+[source,java]
+----
+@Query("{\"ids\": {\"values\": ?0 }}")
+List<SampleEntity> getByIds(Collection<String> ids);
+----
+
+would make an https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-ids-query.html[IDs query] to return all the matching documents.
+So calling the method with a `List` of `["id1", "id2", "id3"]` would produce the query body
+
+[source,json]
+----
+{
+  "query": {
+    "ids": {
+      "values": ["id1", "id2", "id3"]
+    }
+  }
+}
+----
+====
+
+[[elasticsearch.query-methods.at-query.spel]]
+=== Using SpEL Expressions
+
+.Declare query on the method using the `@Query` annotation with SpEL expression.
+====
+https://docs.spring.io/spring-framework/reference/core/expressions.html[SpEL expression] is also supported when defining query in `@Query`.
+
+[source,java]
+----
+interface BookRepository extends ElasticsearchRepository<Book, String> {
+    @Query("""
+        {
+          "bool":{
+            "must":[
+              {
+                "term":{
+                  "name": "#{#name}"
+                }
+              }
+            ]
+          }
+        }
+        """)
+    Page<Book> findByName(String name, Pageable pageable);
+}
+----
+
+If for example the function is called with the parameter _John_, it would produce the following query body:
+
+[source,json]
+----
+{
+  "bool":{
+    "must":[
+      {
+        "term":{
+          "name": "John"
+        }
+      }
+    ]
+  }
+}
+----
+====
+
+.accessing parameter property.
+====
+Supposing that we have the following class as query parameter type:
+
+[source,java]
+----
+public record QueryParameter(String value) {
+}
+----
+
+It's easy to access the parameter by `#` symbol, then reference the property `value` with a simple `.`:
+
+[source,java]
+----
+interface BookRepository extends ElasticsearchRepository<Book, String> {
+    @Query("""
+            {
+              "bool":{
+                "must":[
+                  {
+                    "term":{
+                      "name": "#{#parameter.value}"
+                    }
+                  }
+                ]
+              }
+            }
+            """)
+    Page<Book> findByName(QueryParameter parameter, Pageable pageable);
+}
+----
+
+We can pass `new QueryParameter("John")` as the parameter now, and it will produce the same query string as above.
+====
+
+.accessing bean property.
+====
+https://docs.spring.io/spring-framework/reference/core/expressions/language-ref/bean-references.html[Bean property] is also supported to access.
+Given that there is a bean named `queryParameter` of type `QueryParameter`, we can access the bean with symbol `@` rather than `#`, and there is no need to declare a parameter of type `QueryParameter` in the query method:
+
+[source,java]
+----
+interface BookRepository extends ElasticsearchRepository<Book, String> {
+    @Query("""
+            {
+              "bool":{
+                "must":[
+                  {
+                    "term":{
+                      "name": "#{@queryParameter.value}"
+                    }
+                  }
+                ]
+              }
+            }
+            """)
+    Page<Book> findByName(Pageable pageable);
+}
+----
+====
+
+.SpEL and `Collection` param.
+====
+`Collection` parameter is also supported and is as easy to use as normal `String`, such as the following `terms` query:
+
+[source,java]
+----
+interface BookRepository extends ElasticsearchRepository<Book, String> {
+    @Query("""
+            {
+              "bool":{
+                "must":[
+                  {
+                    "terms":{
+                      "name": #{#names}
+                    }
+                  }
+                ]
+              }
+            }
+            """)
+    Page<Book> findByName(Collection<String> names, Pageable pageable);
+}
+----
+
+NOTE: collection values should not be quoted when declaring the elasticsearch json query.
+
+A collection of `names` like `List.of("name1", "name2")` will produce the following terms query:
+
+[source,json]
+----
+{
+  "bool":{
+    "must":[
+      {
+        "terms":{
+          "name": ["name1", "name2"]
+        }
+      }
+    ]
+  }
+}
+----
+====
+
+.access property in the `Collection` param.
+====
+https://docs.spring.io/spring-framework/reference/core/expressions/language-ref/collection-projection.html[SpEL Collection Projection] is convenient to use when values in the `Collection` parameter is not plain `String`:
+
+[source,java]
+----
+interface BookRepository extends ElasticsearchRepository<Book, String> {
+    @Query("""
+            {
+              "bool":{
+                "must":[
+                  {
+                    "terms":{
+                      "name": #{#parameters.![value]}
+                    }
+                  }
+                ]
+              }
+            }
+            """)
+    Page<Book> findByName(Collection<QueryParameter> parameters, Pageable pageable);
+}
+----
+
+This will extract all the `value` property values as a new `Collection` from `QueryParameter` collection, thus takes the same effect as above.
+====
+
+.alter parameter name by using `@Param`
+====
+When accessing the parameter by SpEL, it's also useful to alter the parameter name to another one by `@Param` annotation in Sping Data:
+
+[source,java]
+----
+interface BookRepository extends ElasticsearchRepository<Book, String> {
+    @Query("""
+            {
+              "bool":{
+                "must":[
+                  {
+                    "terms":{
+                      "name": #{#another.![value]}
+                    }
+                  }
+                ]
+              }
+            }
+            """)
+    Page<Book> findByName(@Param("another") Collection<QueryParameter> parameters, Pageable pageable);
+}
+----
+
+====
+
+[[elasticsearch.query-methods.at-searchtemplate-query]]
+== Using the @SearchTemplateQuery Annotation
+
+When using Elasticsearch search templates - (see xref:elasticsearch/misc.adoc#elasticsearch.misc.searchtemplates [Search Template support]) it is possible to specify that a repository method should use a template by adding the `@SearchTemplateQuery` annotation to that method.
+
+Let's assume that there is a search template stored with the name "book-by-title" and this template need a parameter named "title", then a repository method using that search template can be defined like this:
+
+[source,java]
+----
+interface BookRepository extends ElasticsearchRepository<Book, String> {
+    @SearchTemplateQuery(id = "book-by-title")
+    SearchHits<Book> findByTitle(String title);
+}
+----
+
+The parameters of the repository method are sent to the seacrh template as key/value pairs where the key is the parameter name and the value is taken from the actual value when the method is invoked.

src/main/antora/modules/ROOT/pages/elasticsearch/repositories/reactive-elasticsearch-repositories.adoc

@@ -0,0 +1,128 @@
+[[elasticsearch.reactive.repositories]]
+= Reactive Elasticsearch Repositories
+
+Reactive Elasticsearch repository support builds on the core repository support explained in xref:repositories.adoc[] utilizing operations provided via xref:elasticsearch/reactive-template.adoc[] executed by a xref:elasticsearch/clients.adoc#elasticsearch.clients.reactiverestclient[Reactive REST Client].
+
+Spring Data Elasticsearch reactive repository support uses https://projectreactor.io/[Project Reactor] as its reactive composition library of choice.
+
+There are 3 main interfaces to be used:
+
+* `ReactiveRepository`
+* `ReactiveCrudRepository`
+* `ReactiveSortingRepository`
+
+[[elasticsearch.reactive.repositories.usage]]
+== Usage
+
+To access domain objects stored in a Elasticsearch using a `Repository`, just create an interface for it.
+Before you can actually go on and do that you will need an entity.
+
+.Sample `Person` entity
+====
+[source,java]
+----
+public class Person {
+
+  @Id
+  private String id;
+  private String firstname;
+  private String lastname;
+  private Address address;
+
+  // … getters and setters omitted
+}
+----
+====
+
+NOTE: Please note that the `id` property needs to be of type `String`.
+
+.Basic repository interface to persist Person entities
+====
+[source]
+----
+interface ReactivePersonRepository extends ReactiveSortingRepository<Person, String> {
+
+  Flux<Person> findByFirstname(String firstname);                                   <1>
+
+  Flux<Person> findByFirstname(Publisher<String> firstname);                        <2>
+
+  Flux<Person> findByFirstnameOrderByLastname(String firstname);                    <3>
+
+  Flux<Person> findByFirstname(String firstname, Sort sort);                        <4>
+
+  Flux<Person> findByFirstname(String firstname, Pageable page);                    <5>
+
+  Mono<Person> findByFirstnameAndLastname(String firstname, String lastname);       <6>
+
+  Mono<Person> findFirstByLastname(String lastname);                                <7>
+
+  @Query("{ \"bool\" : { \"must\" : { \"term\" : { \"lastname\" : \"?0\" } } } }")
+  Flux<Person> findByLastname(String lastname);                                     <8>
+
+  Mono<Long> countByFirstname(String firstname)                                     <9>
+
+  Mono<Boolean> existsByFirstname(String firstname)                                 <10>
+
+  Mono<Long> deleteByFirstname(String firstname)                                    <11>
+}
+----
+<1> The method shows a query for all people with the given `lastname`.
+<2> Finder method awaiting input from `Publisher` to bind parameter value for `firstname`.
+<3> Finder method ordering matching documents by `lastname`.
+<4> Finder method ordering matching documents by the expression defined via the `Sort` parameter.
+<5> Use `Pageable` to pass offset and sorting parameters to the database.
+<6> Finder method concating criteria using `And` / `Or` keywords.
+<7> Find the first matching entity.
+<8> The method shows a query for all people with the given `lastname` looked up by running the annotated `@Query` with given
+parameters.
+<9> Count all entities with matching `firstname`.
+<10> Check if at least one entity with matching `firstname` exists.
+<11> Delete all entities with matching `firstname`.
+====
+
+[[elasticsearch.reactive.repositories.configuration]]
+== Configuration
+
+For Java configuration, use the `@EnableReactiveElasticsearchRepositories` annotation. If no base package is configured,
+the infrastructure scans the package of the annotated configuration class.
+
+The following listing shows how to use Java configuration for a repository:
+
+.Java configuration for repositories
+====
+[source,java]
+----
+@Configuration
+@EnableReactiveElasticsearchRepositories
+public class Config extends AbstractReactiveElasticsearchConfiguration {
+
+  @Override
+  public ReactiveElasticsearchClient reactiveElasticsearchClient() {
+    return ReactiveRestClients.create(ClientConfiguration.localhost());
+  }
+}
+----
+====
+
+Because the repository from the previous example extends `ReactiveSortingRepository`, all CRUD operations are available
+as well as methods for sorted access to the entities. Working with the repository instance is a matter of dependency
+injecting it into a client, as the following example shows:
+
+.Sorted access to Person entities
+====
+[source,java]
+----
+public class PersonRepositoryTests {
+
+  @Autowired ReactivePersonRepository repository;
+
+  @Test
+  public void sortsElementsCorrectly() {
+
+    Flux<Person> persons = repository.findAll(Sort.by(new Order(ASC, "lastname")));
+
+    // ...
+  }
+}
+----
+====

src/main/antora/modules/ROOT/pages/elasticsearch/routing.adoc

@@ -0,0 +1,106 @@
+[[elasticsearch.routing]]
+= Routing values
+
+When Elasticsearch stores a document in an index that has multiple shards, it determines the shard to you use based on the _id_ of the document.
+Sometimes it is necessary to predefine that multiple documents should be indexed on the same shard (join-types, faster search for related data).
+For this Elasticsearch offers the possibility to define a routing, which is the value that should be used to calculate the shard from instead of the _id_.
+
+Spring Data Elasticsearch supports routing definitions on storing and retrieving data in the following ways:
+
+[[elasticsearch.routing.join-types]]
+== Routing on join-types
+
+When using join-types (see xref:elasticsearch/join-types.adoc[Join-Type implementation]), Spring Data Elasticsearch will automatically use the `parent` property of the entity's `JoinField` property as the value for the routing.
+
+This is correct for all the use-cases where the parent-child relationship has just one level.
+If it is deeper, like a child-parent-grandparent relationship - like in the above example from _vote_ -> _answer_ -> _question_ - then the routing needs to explicitly specified by using the techniques described in the next section (the _vote_ needs the _question.id_ as routing value).
+
+[[elasticsearch.routing.custom]]
+== Custom routing values
+
+To define a custom routing for an entity, Spring Data Elasticsearch provides a `@Routing` annotation (reusing the `Statement` class from above):
+
+====
+[source,java]
+----
+@Document(indexName = "statements")
+@Routing("routing")                  <.>
+public class Statement {
+    @Id
+    private String id;
+
+    @Field(type = FieldType.Text)
+    private String text;
+
+    @JoinTypeRelations(
+        relations =
+            {
+                @JoinTypeRelation(parent = "question", children = {"answer", "comment"}),
+                @JoinTypeRelation(parent = "answer", children = "vote")
+            }
+    )
+    private JoinField<String> relation;
+
+    @Nullable
+    @Field(type = FieldType.Keyword)
+    private String routing;          <.>
+
+    // getter/setter...
+}
+----
+<.> This defines _"routing"_ as routing specification
+<.> a property with the name _routing_
+====
+
+If the `routing` specification of the annotation is a plain string and not a SpEL expression, it is interpreted as the name of a property of the entity, in the example it's the _routing_ property.
+The value of this property will then be used as the routing value for all requests that use the entity.
+
+It is also possible to us a SpEL expression in the `@Document` annotation like this:
+
+====
+[source,java]
+----
+@Document(indexName = "statements")
+@Routing("@myBean.getRouting(#entity)")
+public class Statement{
+    // all the needed stuff
+}
+----
+====
+
+In this case the user needs to provide a bean with the name _myBean_ that has a method `String getRouting(Object)`. To reference the entity _"#entity"_ must be used in the SpEL expression, and the return value must be `null` or the routing value as a String.
+
+If plain property's names and SpEL expressions are not enough to customize the routing definitions, it is possible to define provide an implementation of the `RoutingResolver` interface. This can then be set on the `ElasticOperations` instance:
+
+====
+[source,java]
+----
+RoutingResolver resolver = ...;
+
+ElasticsearchOperations customOperations= operations.withRouting(resolver);
+
+----
+====
+
+The `withRouting()` functions return a copy of the original `ElasticsearchOperations` instance with the customized routing set.
+
+
+When a routing has been defined on an entity when it is stored in Elasticsearch, the same value must be provided when doing a _get_ or _delete_ operation. For methods that do not use an entity - like `get(ID)` or `delete(ID)` - the `ElasticsearchOperations.withRouting(RoutingResolver)` method can be used like this:
+
+====
+[source,java]
+----
+String id = "someId";
+String routing = "theRoutingValue";
+
+// get an entity
+Statement s = operations
+                .withRouting(RoutingResolver.just(routing))       <.>
+                .get(id, Statement.class);
+
+// delete an entity
+operations.withRouting(RoutingResolver.just(routing)).delete(id);
+
+----
+<.> `RoutingResolver.just(s)` returns a resolver that will just return the given String.
+====

src/main/antora/modules/ROOT/pages/elasticsearch/scripted-and-runtime-fields.adoc

@@ -0,0 +1,228 @@
+[[elasticsearch.misc.scripted-and-runtime-fields]]
+= Scripted and runtime fields
+
+Spring Data Elasticsearch supports scripted fields and runtime fields.
+Please refer to the Elasticsearch documentation about scripting (https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-scripting.html) and runtime fields (https://www.elastic.co/guide/en/elasticsearch/reference/8.9/runtime.html) for detailed information about this.
+In the context of Spring Data Elasticsearch you can use
+
+* scripted fields that are used to return fields that are calculated on the result documents and added to the returned document.
+* runtime fields that are calculated on the stored documents and can be used in a query and/or be returned in the search result.
+
+The following code snippets will show what you can do (these show imperative code, but the reactive implementation works similar).
+
+[[the-person-entity]]
+== The person entity
+
+The enity that is used in these examples is a `Person` entity.
+This entity has a `birthDate` and an `age` property.
+Whereas the birthdate is fix, the age depends on the time when a query is issued and needs to be calculated dynamically.
+
+====
+[source,java]
+----
+import org.jspecify.annotations.Nullable;
+import org.springframework.data.annotation.Id;
+import org.springframework.data.elasticsearch.annotations.DateFormat;
+import org.springframework.data.elasticsearch.annotations.Document;
+import org.springframework.data.elasticsearch.annotations.Field;
+import org.springframework.data.elasticsearch.annotations.ScriptedField;
+
+import java.time.LocalDate;
+import java.time.format.DateTimeFormatter;
+
+import static org.springframework.data.elasticsearch.annotations.FieldType.*;
+
+import java.lang.Integer;
+
+@Document(indexName = "persons")
+public record Person(
+        @Id
+        @Nullable
+        String id,
+        @Field(type = Text)
+        String lastName,
+        @Field(type = Text)
+        String firstName,
+        @Field(type = Keyword)
+        String gender,
+        @Field(type = Date, format = DateFormat.basic_date)
+        LocalDate birthDate,
+        @Nullable
+        @ScriptedField Integer age                   <.>
+) {
+    public Person(String id,String lastName, String firstName, String gender, String birthDate) {
+        this(id,                                     <.>
+            lastName,
+            firstName,
+            LocalDate.parse(birthDate, DateTimeFormatter.ISO_LOCAL_DATE),
+            gender,
+            null);
+    }
+}
+
+----
+
+<.> the `age` property will be calculated and filled in search results.
+<.> a convenience constructor to set up the test data.
+====
+
+Note that the `age` property is annotated with `@ScriptedField`.
+This inhibits the writing of a corresponding entry in the index mapping and marks the property as a target to put a calculated field from a search response.
+
+[[the-repository-interface]]
+== The repository interface
+
+The repository used in this example:
+
+====
+[source,java]
+----
+public interface PersonRepository extends ElasticsearchRepository<Person, String> {
+
+    SearchHits<Person> findAllBy(ScriptedField scriptedField);
+
+    SearchHits<Person> findByGenderAndAgeLessThanEqual(String gender, Integer age, RuntimeField runtimeField);
+}
+
+----
+====
+
+[[the-service-class]]
+== The service class
+
+The service class has a repository injected and an `ElasticsearchOperations` instance to show several ways of populating and using the `age` property.
+We show the code split up in different pieces to put the explanations in
+
+====
+[source,java]
+----
+import org.springframework.data.elasticsearch.core.ElasticsearchOperations;
+import org.springframework.data.elasticsearch.core.SearchHits;
+import org.springframework.data.elasticsearch.core.query.Criteria;
+import org.springframework.data.elasticsearch.core.query.CriteriaQuery;
+import org.springframework.data.elasticsearch.core.query.FetchSourceFilter;
+import org.springframework.data.elasticsearch.core.query.RuntimeField;
+import org.springframework.data.elasticsearch.core.query.ScriptData;
+import org.springframework.data.elasticsearch.core.query.ScriptType;
+import org.springframework.data.elasticsearch.core.query.ScriptedField;
+import org.springframework.data.elasticsearch.core.query.StringQuery;
+import org.springframework.stereotype.Service;
+
+import java.util.List;
+
+@Service
+public class PersonService {
+    private final ElasticsearchOperations operations;
+    private final PersonRepository repository;
+
+    public PersonService(ElasticsearchOperations operations, SaRPersonRepository repository) {
+        this.operations = operations;
+        this.repository = repository;
+    }
+
+    public void save() { <.>
+        List<Person> persons = List.of(
+                new Person("1", "Smith", "Mary", "f", "1987-05-03"),
+                new Person("2", "Smith", "Joshua", "m", "1982-11-17"),
+                new Person("3", "Smith", "Joanna", "f", "2018-03-27"),
+                new Person("4", "Smith", "Alex", "m", "2020-08-01"),
+                new Person("5", "McNeill", "Fiona", "f", "1989-04-07"),
+                new Person("6", "McNeill", "Michael", "m", "1984-10-20"),
+                new Person("7", "McNeill", "Geraldine", "f", "2020-03-02"),
+                new Person("8", "McNeill", "Patrick", "m", "2022-07-04"));
+
+        repository.saveAll(persons);
+    }
+----
+
+<.> a utility method to store some data in Elasticsearch.
+====
+
+[[scripted-fields]]
+=== Scripted fields
+
+The next piece shows how to use a scripted field to calculate and return the age of the persons.
+Scripted fields can only add something to the returned data, the age cannot be used in the query (see runtime fields for that).
+
+====
+[source,java]
+----
+    public SearchHits<Person> findAllWithAge() {
+
+        var scriptedField = ScriptedField.of("age",                               <.>
+                ScriptData.of(b -> b
+                        .withType(ScriptType.INLINE)
+                        .withScript("""
+                                Instant currentDate = Instant.ofEpochMilli(new Date().getTime());
+                                Instant startDate = doc['birth-date'].value.toInstant();
+                                return (ChronoUnit.DAYS.between(startDate, currentDate) / 365);
+                                """)));
+
+        // version 1: use a direct query
+        var query = new StringQuery("""
+                { "match_all": {} }
+                """);
+        query.addScriptedField(scriptedField);                                    <.>
+        query.addSourceFilter(FetchSourceFilter.of(b -> b.withIncludes("*")));    <.>
+
+        var result1 = operations.search(query, Person.class);                     <.>
+
+        // version 2: use the repository
+        var result2 = repository.findAllBy(scriptedField);                        <.>
+
+        return result1;
+    }
+----
+
+<.> define the `ScriptedField` that calculates the age of a person.
+<.> when using a `Query`, add the scripted field to the query.
+<.> when adding a scripted field to a `Query`, an additional source filter is needed to also retrieve the _normal_ fields from the document source.
+<.> get the data where the `Person` entities now have the values set in their `age` property.
+<.> when using the repository, all that needs to be done is adding the scripted field as method parameter.
+====
+
+[[runtime-fields]]
+=== Runtime fields
+
+When using runtime fields, the calculated value can be used in the query itself.
+In the following code this is used to run a query for a given gender and maximum age of persons:
+
+====
+[source,java]
+----
+    public SearchHits<Person> findWithGenderAndMaxAge(String gender, Integer maxAge) {
+
+        var runtimeField = new RuntimeField("age", "long", """                    <.>
+                                Instant currentDate = Instant.ofEpochMilli(new Date().getTime());
+                                Instant startDate = doc['birthDate'].value.toInstant();
+                                emit (ChronoUnit.DAYS.between(startDate, currentDate) / 365);
+                """);
+
+        // variant 1 : use a direct query
+        var query = CriteriaQuery.builder(Criteria
+                        .where("gender").is(gender)
+                        .and("age").lessThanEqual(maxAge))
+                .withRuntimeFields(List.of(runtimeField))                         <.>
+                .withFields("age")                                                <.>
+                .withSourceFilter(FetchSourceFilter.of(b -> b.withIncludes("*"))) <.>
+                .build();
+
+        var result1 = operations.search(query, Person.class);                     <.>
+
+        // variant 2: use the repository                                          <.>
+        var result2 = repository.findByGenderAndAgeLessThanEqual(gender, maxAge, runtimeField);
+
+        return result1;
+    }
+}
+----
+
+<.> define the runtime field that calculates the age of a person. // see https://asciidoctor.org/docs/user-manual/#builtin-attributes for builtin attributes.
+<.> when using `Query`, add the runtime field.
+<.> when adding a scripted field to a `Query`, an additional field parameter is needed to have the calculated value returned.
+<.> when adding a scripted field to a `Query`, an additional source filter is needed to also retrieve the _normal_ fields from the document source.
+<.> get the data filtered with the query and where the returned entites have the age property set.
+<.> when using the repository, all that needs to be done is adding the runtime field as method parameter.
+====
+
+In addition to define a runtime fields on a query, they can also be defined in the index by setting the `runtimeFieldsPath` property of the `@Mapping` annotation to point to a JSON file that contains the runtime field definitions.

src/main/antora/modules/ROOT/pages/elasticsearch/template.adoc

@@ -0,0 +1,241 @@
+[[elasticsearch.operations]]
+= Elasticsearch Operations
+
+Spring Data Elasticsearch uses several interfaces to define the operations that can be called against an Elasticsearch index (for a description of the reactive interfaces see xref:elasticsearch/reactive-template.adoc[]).
+
+* javadoc:org.springframework.data.elasticsearch.core.IndexOperations[] defines actions on index level like creating or deleting an index.
+* javadoc:org.springframework.data.elasticsearch.core.DocumentOperations[] defines actions to store, update and retrieve entities based on their id.
+* javadoc:org.springframework.data.elasticsearch.core.SearchOperations[] define the actions to search for multiple entities using queries
+* javadoc:org.springframework.data.elasticsearch.core.ElasticsearchOperations[] combines the `DocumentOperations` and `SearchOperations` interfaces.
+
+These interfaces correspond to the structuring of the https://www.elastic.co/guide/en/elasticsearch/reference/current/rest-apis.html[Elasticsearch API].
+
+The default implementations of the interfaces offer:
+
+* index management functionality.
+* Read/Write mapping support for domain types.
+* A rich query and criteria api.
+* Resource management and Exception translation.
+
+[NOTE]
+====
+.Index management and automatic creation of indices and mappings.
+The `IndexOperations` interface and the provided implementation which can be obtained from an `ElasticsearchOperations` instance - for example with a call to `operations.indexOps(clazz)`- give the user the ability to create indices, put mappings or store template and alias information in the Elasticsearch cluster.
+Details of the index that will be created can be set by using the `@Setting` annotation, refer to xref:elasticsearch/misc.adoc#elasticsearc.misc.index.settings[Index settings] for further information.
+
+**None of these operations are done automatically** by the implementations of `IndexOperations` or `ElasticsearchOperations`.
+It is the user's responsibility to call the methods.
+
+There is support for automatic creation of indices and writing the mappings when using Spring Data Elasticsearch repositories, see xref:elasticsearch/repositories/elasticsearch-repositories.adoc#elasticsearch.repositories.autocreation[Automatic creation of indices with the corresponding mapping]
+
+====
+
+[[elasticsearch.operations.usage]]
+== Usage examples
+
+The example shows how to use an injected `ElasticsearchOperations` instance in a Spring REST controller.
+The example assumes that `Person` is a class that is annotated with `@Document`, `@Id` etc (see xref:elasticsearch/object-mapping.adoc#elasticsearch.mapping.meta-model.annotations[Mapping Annotation Overview]).
+
+.ElasticsearchOperations usage
+====
+[source,java]
+----
+@RestController
+@RequestMapping("/")
+public class TestController {
+
+  private  ElasticsearchOperations elasticsearchOperations;
+
+  public TestController(ElasticsearchOperations elasticsearchOperations) { <.>
+    this.elasticsearchOperations = elasticsearchOperations;
+  }
+
+  @PostMapping("/person")
+  public String save(@RequestBody Person person) {                         <.>
+    Person savedEntity = elasticsearchOperations.save(person);
+    return savedEntity.getId();
+  }
+
+  @GetMapping("/person/{id}")
+  public Person findById(@PathVariable("id")  Long id) {                   <.>
+    Person person = elasticsearchOperations.get(id.toString(), Person.class);
+    return person;
+  }
+}
+
+----
+
+<.> Let Spring inject the provided `ElasticsearchOperations` bean in the constructor.
+<.> Store some entity in the Elasticsearch cluster.
+The id is read from the returned entity, as it might have been null in the `person` object and been created by Elasticsearch.
+<.> Retrieve the entity with a get by id.
+====
+
+To see the full possibilities of `ElasticsearchOperations` please refer to the API documentation.
+
+
+[[elasticsearch.operations.searchresulttypes]]
+== Search Result Types
+
+When a document is retrieved with the methods of the  `DocumentOperations` interface, just the found entity will be returned.
+When searching with the methods of the `SearchOperations` interface, additional information is available for each entity, for example the _score_ or the _sortValues_ of the found entity.
+
+In order to return this information, each entity is wrapped in a `SearchHit` object that contains this entity-specific additional information.
+These `SearchHit` objects themselves are returned within a `SearchHits` object which additionally contains informations about the whole search like the _maxScore_ or requested aggregations or the execution duration it took to complete the request.
+The following classes and interfaces are now available:
+
+.SearchHit<T>
+Contains the following information:
+
+* Id
+* Score
+* Sort Values
+* Highlight fields
+* Inner hits (this is an embedded `SearchHits` object containing eventually returned inner hits)
+* The retrieved entity of type <T>
+
+.SearchHits<T>
+Contains the following information:
+
+* Number of total hits
+* Total hits relation
+* Maximum score
+* A list of `SearchHit<T>` objects
+* Returned aggregations
+* Returned suggest results
+
+.SearchPage<T>
+Defines a Spring Data `Page` that contains a `SearchHits<T>` element and can be used for paging access using repository methods.
+
+.SearchScrollHits<T>
+Returned by the low level scroll API functions in `ElasticsearchRestTemplate`, it enriches a `SearchHits<T>` with the Elasticsearch scroll id.
+
+.SearchHitsIterator<T>
+An Iterator returned by the streaming functions of the `SearchOperations` interface.
+
+.ReactiveSearchHits
+`ReactiveSearchOperations` has methods returning a `Mono<ReactiveSearchHits<T>>`, this contains the same information as a `SearchHits<T>` object, but will provide the contained `SearchHit<T>` objects as a `Flux<SearchHit<T>>` and not as a list.
+
+[[elasticsearch.operations.queries]]
+== Queries
+
+Almost all of the methods defined in the `SearchOperations` and `ReactiveSearchOperations` interface take a `Query` parameter that defines the query to execute for searching. `Query` is an interface and Spring Data Elasticsearch provides three implementations: `CriteriaQuery`, `StringQuery` and `NativeQuery`.
+
+[[elasticsearch.operations.criteriaquery]]
+=== CriteriaQuery
+
+`CriteriaQuery` based queries allow the creation of queries to search for data without knowing the syntax or basics of Elasticsearch queries.
+They allow the user to build queries by simply chaining and combining `Criteria` objects that specify the criteria the searched documents must fulfill.
+
+NOTE: when talking about AND or OR when combining criteria keep in mind, that in Elasticsearch AND are converted to a **must** condition and OR to a **should**
+
+`Criteria` and their usage are best explained by example (let's assume we have a `Book` entity with a `price` property):
+
+.Get books with a given price
+====
+[source,java]
+----
+Criteria criteria = new Criteria("price").is(42.0);
+Query query = new CriteriaQuery(criteria);
+----
+====
+
+Conditions for the same field can be chained, they will be combined with a logical AND:
+
+.Get books with a given price
+====
+[source,java]
+----
+Criteria criteria = new Criteria("price").greaterThan(42.0).lessThan(34.0);
+Query query = new CriteriaQuery(criteria);
+----
+====
+
+When chaining `Criteria`, by default a AND logic is used:
+
+.Get all persons with first name _James_ and last name _Miller_:
+====
+[source,java]
+----
+Criteria criteria = new Criteria("lastname").is("Miller") <1>
+  .and("firstname").is("James")                           <2>
+Query query = new CriteriaQuery(criteria);
+----
+
+<1> the first `Criteria`
+<2> the and() creates a new `Criteria` and chaines it to the first one.
+====
+
+If you want to create nested queries, you need to use subqueries for this.
+Let's assume we want to find all persons with a last name of _Miller_ and a first name of either _Jack_ or _John_:
+
+.Nested subqueries
+====
+[source,java]
+----
+Criteria miller = new Criteria("lastName").is("Miller")  <.>
+  .subCriteria(                                          <.>
+    new Criteria().or("firstName").is("John")            <.>
+      .or("firstName").is("Jack")                        <.>
+  );
+Query query = new CriteriaQuery(criteria);
+----
+
+<.> create a first `Criteria` for the last name
+<.> this is combined with AND to a subCriteria
+<.> This sub Criteria is an OR combination for the first name _John_
+<.> and the first name Jack
+====
+
+Please refer to the API documentation of the `Criteria` class for a complete overview of the different available operations.
+
+[[elasticsearch.operations.stringquery]]
+=== StringQuery
+
+This class takes an Elasticsearch query as JSON String.
+The following code shows a query that searches for persons having the first name "Jack":
+
+====
+[source,java]
+----
+
+Query query = new StringQuery("{ \"match\": { \"firstname\": { \"query\": \"Jack\" } } } ");
+SearchHits<Person> searchHits = operations.search(query, Person.class);
+
+----
+====
+
+Using `StringQuery` may be appropriate if you already have an Elasticsearch query to use.
+
+[[elasticsearch.operations.nativequery]]
+=== NativeQuery
+
+`NativeQuery` is the class to use when you have a complex query, or a query that cannot be expressed by using the `Criteria` API, for example when building queries and using aggregates.
+It allows to use all the different `co.elastic.clients.elasticsearch._types.query_dsl.Query` implementations from the Elasticsearch library therefore named "native".
+
+The following code shows how to search for persons with a given `firstName` and for the found documents have a terms aggregation that counts the number of occurrences of the `lastName` for these persons:
+
+====
+[source,java]
+----
+Query query = NativeQuery.builder()
+	.withAggregation("lastNames", Aggregation.of(a -> a
+		.terms(ta -> ta.field("lastName").size(10))))
+	.withQuery(q -> q
+		.match(m -> m
+			.field("firstName")
+			.query(firstName)
+		)
+	)
+	.withPageable(pageable)
+	.build();
+
+SearchHits<Person> searchHits = operations.search(query, Person.class);
+----
+====
+
+[[elasticsearch.operations.searchtemplatequery]]
+=== SearchTemplateQuery
+
+This is a special implementation of the `Query` interface to be used in combination with a stored search template.
+See xref:elasticsearch/misc.adoc#elasticsearch.misc.searchtemplates[Search Template support] for further information.

src/main/antora/modules/ROOT/pages/elasticsearch/versions.adoc

@@ -0,0 +1,27 @@
+[[preface.versions]]
+= Versions
+
+The following table shows the Elasticsearch and Spring versions that are used by Spring Data release trains and the version of Spring Data Elasticsearch included in that.
+
+[cols="^,^,^,^",options="header"]
+|===
+| Spring Data Release Train | Spring Data Elasticsearch | Elasticsearch | Spring Framework
+| 2025.1 (in development) | 6.0.x | 9.0.4 | 7.0.x
+| 2025.0 | 5.5.x | 8.18.1 | 6.2.x
+| 2024.1 | 5.4.x | 8.15.5 | 6.1.x
+| 2024.0 | 5.3.xfootnote:oom[Out of maintenance] | 8.13.4 | 6.1.x
+| 2023.1 (Vaughan) | 5.2.xfootnote:oom[] | 8.11.1 | 6.1.x
+| 2023.0 (Ullmann) | 5.1.xfootnote:oom[] | 8.7.1 | 6.0.x
+| 2022.0 (Turing) | 5.0.xfootnote:oom[] | 8.5.3 | 6.0.x
+| 2021.2 (Raj) | 4.4.xfootnote:oom[] | 7.17.3 | 5.3.x
+| 2021.1 (Q) | 4.3.xfootnote:oom[] | 7.15.2 | 5.3.x
+| 2021.0 (Pascal) | 4.2.xfootnote:oom[] | 7.12.0 | 5.3.x
+| 2020.0 (Ockham) | 4.1.xfootnote:oom[] | 7.9.3 | 5.3.2
+| Neumann | 4.0.xfootnote:oom[] | 7.6.2 | 5.2.12
+| Moore | 3.2.xfootnote:oom[] |6.8.12 | 5.2.12
+| Lovelace | 3.1.xfootnote:oom[] | 6.2.2 | 5.1.19
+| Kay | 3.0.xfootnote:oom[] | 5.5.0 | 5.0.13
+| Ingalls | 2.1.xfootnote:oom[] | 2.4.0 | 4.3.25
+|===
+
+Support for upcoming versions of Elasticsearch is being tracked and general compatibility should be given assuming the usage of the xref:elasticsearch/template.adoc[ElasticsearchOperations interface].

src/main/antora/modules/ROOT/pages/index.adoc

@@ -0,0 +1,22 @@
+[[spring-data-elasticsearch-reference-documentation]]
+= Spring Data Elasticsearch
+:revnumber: {version}
+:revdate: {localdate}
+:feature-scroll: true
+
+_Spring Data Elasticsearch provides repository support for the Elasticsearch database.
+It eases development of applications with a consistent programming model that need to access Elasticsearch data sources._
+
+[horizontal]
+xref:elasticsearch/versions.adoc[Versions] :: Version Compatibility Matrix
+xref:elasticsearch/clients.adoc[Clients] :: Elasticsearch Client Configuration
+xref:elasticsearch.adoc[Elasticsearch] :: Elasticsearch support
+xref:repositories.adoc[Repositories] :: Elasticsearch Repositories
+xref:migration-guides.adoc[Migration] :: Migration Guides
+https://github.com/spring-projects/spring-data-commons/wiki[Wiki] :: What's New, Upgrade Notes, Supported Versions, additional cross-version information.
+
+BioMed Central Development Team; Oliver Drotbohm; Greg Turnquist; Christoph Strobl; Peter-Josef Meisch
+
+(C) 2008-{copyright-year} VMware, Inc.
+
+Copies of this document may be made for your own use and for distribution to others, provided that you do not charge any fee for such copies and further provided that each copy contains this Copyright Notice, whether distributed in print or electronically.

src/main/antora/modules/ROOT/pages/migration-guides.adoc

@@ -0,0 +1,8 @@
+[[elasticsearch.migration]]
+= Migration Guides
+:page-section-summary-toc: 1
+
+This section contains version-specific migration guides explaining how to upgrade across versions.
+
+
+

src/main/antora/modules/ROOT/pages/migration-guides/migration-guide-3.2-4.0.adoc

@@ -0,0 +1,144 @@
+[[elasticsearch-migration-guide-3.2-4.0]]
+= Upgrading from 3.2.x to 4.0.x
+
+This section describes breaking changes from version 3.2.x to 4.0.x and how removed features can be replaced by new introduced features.
+
+[[elasticsearch-migration-guide-3.2-4.0.jackson-removal]]
+== Removal of the used Jackson Mapper
+
+One of the changes in version 4.0.x is that Spring Data Elasticsearch does not use the Jackson Mapper anymore to map an entity to the JSON representation needed for Elasticsearch (see xref:elasticsearch/object-mapping.adoc[Elasticsearch Object Mapping]).
+In version 3.2.x the Jackson Mapper was the default that was used.
+It was possible to switch to the meta-model based converter (named `ElasticsearchEntityMapper`) by explicitly configuring it (xref:elasticsearch/object-mapping.adoc#elasticsearch.mapping.meta-model[Meta Model Object Mapping]).
+
+In version 4.0.x the meta-model based converter is the only one that is available and does not need to be configured explicitly.
+If you had a custom configuration to enable the meta-model converter by providing a bean like this:
+
+[source,java]
+----
+@Bean
+@Override
+public EntityMapper entityMapper() {
+
+  ElasticsearchEntityMapper entityMapper = new ElasticsearchEntityMapper(
+    elasticsearchMappingContext(), new DefaultConversionService()
+  );
+  entityMapper.setConversions(elasticsearchCustomConversions());
+
+  return entityMapper;
+}
+----
+
+You now have to remove this bean, the `ElasticsearchEntityMapper` interface has been removed.
+
+.Entity configuration
+Some users had custom Jackson annotations on the entity class, for example in order to define a custom name for the mapped document in Elasticsearch or to configure date conversions.
+These are not taken into account anymore.
+The needed functionality is now provided with Spring Data Elasticsearch's `@Field` annotation.
+Please see xref:elasticsearch/object-mapping.adoc#elasticsearch.mapping.meta-model.annotations[Mapping Annotation Overview] for detailed information.
+
+[[elasticsearch-migration-guide-3.2-4.0.implicit-index-name]]
+== Removal of implicit index name from query objects
+
+In 3.2.x the different query classes like `IndexQuery` or `SearchQuery` had properties that were taking the index name or index names that they were operating upon.If these were not set, the passed in entity was inspected to retrieve the index name that was set in the `@Document` annotation. +
+In 4.0.x the index name(s) must now be provided in an additional parameter of type `IndexCoordinates`.By separating this, it now is possible to use one query object against different indices.
+
+So for example the following code:
+
+[source,java]
+----
+IndexQuery indexQuery = new IndexQueryBuilder()
+  .withId(person.getId().toString())
+  .withObject(person)
+  .build();
+
+String documentId = elasticsearchOperations.index(indexQuery);
+----
+
+must be changed to:
+
+[source,java]
+----
+IndexCoordinates indexCoordinates = elasticsearchOperations.getIndexCoordinatesFor(person.getClass());
+
+IndexQuery indexQuery = new IndexQueryBuilder()
+  .withId(person.getId().toString())
+  .withObject(person)
+  .build();
+
+String documentId = elasticsearchOperations.index(indexQuery, indexCoordinates);
+----
+
+To make it easier to work with entities and use the index name that is contained in the entitie's `@Document` annotation, new methods have been added like `DocumentOperations.save(T entity)`;
+
+[[elasticsearch-migration-guide-3.2-4.0.new-operations]]
+== The new Operations interfaces
+
+In version 3.2 there was the `ElasticsearchOperations` interface that defined all the methods for the `ElasticsearchTemplate` class. In version 4 the functions have been split into different interfaces, aligning these interfaces with the Elasticsearch API:
+
+* `DocumentOperations` are the functions related documents like saving, or deleting
+* `SearchOperations` contains the functions to search in Elasticsearch
+* `IndexOperations` define the functions to operate on indexes, like index creation or mappings creation.
+
+`ElasticsearchOperations` now extends `DocumentOperations` and `SearchOperations` and has methods get access to an `IndexOperations` instance.
+
+NOTE: All the functions from the `ElasticsearchOperations` interface in version 3.2 that are now moved to the `IndexOperations` interface are still available, they are marked as deprecated and have default implementations that delegate to the new implementation:
+
+[source,java]
+----
+/**
+ * Create an index for given indexName.
+ *
+ * @param indexName the name of the index
+ * @return {@literal true} if the index was created
+ * @deprecated since 4.0, use {@link IndexOperations#create()}
+ */
+@Deprecated
+default boolean createIndex(String indexName) {
+	return indexOps(IndexCoordinates.of(indexName)).create();
+}
+----
+
+[[elasticsearch-migration-guide-3.2-4.0.deprecations]]
+== Deprecations
+
+[[elasticsearch-migration-guide-3.2-4.0.deprecations.methods-classes]]
+=== Methods and classes
+
+Many functions and classes have been deprecated. These functions still work, but the Javadocs show with what they should be replaced.
+
+.Example from ElasticsearchOperations
+[source,java]
+----
+/*
+ * Retrieves an object from an index.
+ *
+ * @param query the query defining the id of the object to get
+ * @param clazz the type of the object to be returned
+ * @return the found object
+ * @deprecated since 4.0, use {@link #get(String, Class, IndexCoordinates)}
+ */
+@Deprecated
+@Nullable
+<T> T queryForObject(GetQuery query, Class<T> clazz);
+----
+
+[[elasticsearch-migration-guide-3.2-4.0.deprecations.elasticsearch]]
+=== Elasticsearch deprecations
+
+Since version 7 the Elasticsearch `TransportClient` is deprecated, it will be removed with Elasticsearch version 8. Spring Data Elasticsearch deprecates the `ElasticsearchTemplate` class which uses the `TransportClient` in version 4.0.
+
+Mapping types were removed from Elasticsearch 7, they still exist as deprecated values in the Spring Data `@Document` annotation and the `IndexCoordinates` class but they are not used anymore internally.
+
+[[elasticsearch-migration-guide-3.2-4.0.removal]]
+== Removals
+
+* As already described, the `ElasticsearchEntityMapper` interface has been removed.
+
+* The `SearchQuery` interface has been merged into it's base interface `Query`, so it's occurrences can just be replaced with `Query`.
+
+* The method `org.springframework.data.elasticsearch.core.ElasticsearchOperations.query(SearchQuery query, ResultsExtractor<T> resultsExtractor);` and the `org.springframework.data.elasticsearch.core.ResultsExtractor` interface have been removed.
+These could be used to parse the result from Elasticsearch for cases in which the response mapping done with the Jackson based mapper was not enough.
+Since version 4.0, there are the new xref:elasticsearch/template.adoc#elasticsearch.operations.searchresulttypes[Search Result Types]  to return the information from an Elasticsearch response, so there is no need to expose this low level functionality.
+
+* The low level methods `startScroll`, `continueScroll` and `clearScroll` have been removed from the `ElasticsearchOperations` interface.
+For low level scroll API access, there now are `searchScrollStart`, `searchScrollContinue` and `searchScrollClear` methods on the `ElasticsearchRestTemplate` class.

src/main/antora/modules/ROOT/pages/migration-guides/migration-guide-4.0-4.1.adoc

@@ -0,0 +1,48 @@
+[[elasticsearch-migration-guide-4.0-4.1]]
+= Upgrading from 4.0.x to 4.1.x
+
+This section describes breaking changes from version 4.0.x to 4.1.x and how removed features can be replaced by new introduced features.
+
+[[elasticsearch-migration-guide-4.0-4.1.deprecations]]
+== Deprecations
+
+.Definition of the id property
+It is possible to define a property of en entity as the id property by naming it either `id` or  `document`.
+This behaviour is now deprecated and will produce a warning.
+Please use the `@Id` annotation to mark a property as being the id property.
+
+.Index mappings
+In the `ReactiveElasticsearchClient.Indices` interface the `updateMapping` methods are deprecated in favour of the `putMapping` methods.
+They do the same, but `putMapping` is consistent with the naming in the Elasticsearch API:
+
+.Alias handling
+In the `IndexOperations` interface the methods `addAlias(AliasQuery)`, `removeAlias(AliasQuery)` and `queryForAlias()` have been deprecated.
+The new methods `alias(AliasAction)`, `getAliases(String...)` and `getAliasesForIndex(String...)` offer more functionality and a cleaner API.
+
+.Parent-ID
+Usage of a parent-id has been removed from Elasticsearch since version 6. We now deprecate the corresponding fields and methods.
+
+[[elasticsearch-migration-guide-4.0-4.1.removal]]
+== Removals
+
+.Type mappings
+The _type mappings_ parameters of the `@Document` annotation and the `IndexCoordinates` object were removed.
+They had been deprecated in Spring Data Elasticsearch 4.0 and their values weren't used anymore.
+
+[[elasticsearch-migration-guide-4.0-4.1.breaking-changes]]
+== Breaking Changes
+
+[[elasticsearch-migration-guide-4.0-4.1.breaking-changes.returntypes-1]]
+=== Return types of ReactiveElasticsearchClient.Indices methods
+
+The methods in the `ReactiveElasticsearchClient.Indices` were not used up to now.
+With the introduction of the `ReactiveIndexOperations` it became necessary to change some of the return types:
+
+* the `createIndex`  variants now return a `Mono<Boolean>` instead of a `Mono<Void>` to signal successful index creation.
+* the `updateMapping`  variants now return a `Mono<Boolean>` instead of a `Mono<Void>` to signal successful mappings storage.
+
+[[elasticsearch-migration-guide-4.0-4.1.breaking-changes.returntypes-2]]
+=== Return types of DocumentOperations.bulkIndex methods
+
+These methods were returning a `List<String>` containing the ids of the new indexed records.
+Now they return a `List<IndexedObjectInformation>`; these objects contain the id and information about optimistic locking (seq_no and primary_term)

src/main/antora/modules/ROOT/pages/migration-guides/migration-guide-4.1-4.2.adoc

@@ -0,0 +1,74 @@
+[[elasticsearch-migration-guide-4.1-4.2]]
+= Upgrading from 4.1.x to 4.2.x
+
+This section describes breaking changes from version 4.1.x to 4.2.x and how removed features can be replaced by new introduced features.
+
+[[elasticsearch-migration-guide-4.1-4.2.deprecations]]
+== Deprecations
+
+[[elasticsearch-migration-guide-4.1-4.2.deprecations.document]]
+=== @Document parameters
+
+The parameters of the `@Document` annotation that are relevant for  the index settings (`useServerConfiguration`, `shards`. `replicas`, `refreshIntervall` and `indexStoretype`) have been moved to the `@Setting` annotation. Use in `@Document` is still possible but deprecated.
+
+[[elasticsearch-migration-guide-4.1-4.2.removal]]
+== Removals
+
+The `@Score` annotation that was used to set the score return value in an entity was deprecated in version 4.0 and has been removed.
+Score values are returned in the `SearchHit` instances that encapsulate the returned entities.
+
+The `org.springframework.data.elasticsearch.ElasticsearchException` class has been removed.
+The remaining usages have been replaced with `org.springframework.data.mapping.MappingException` and `org.springframework.dao.InvalidDataAccessApiUsageException`.
+
+The deprecated `ScoredPage`, `ScrolledPage` `@AggregatedPage` and implementations has been removed.
+
+The deprecated `GetQuery` and `DeleteQuery` have been removed.
+
+The deprecated `find` methods from `ReactiveSearchOperations` and `ReactiveDocumentOperations` have been removed.
+
+[[elasticsearch-migration-guide-4.1-4.2.breaking-changes]]
+== Breaking Changes
+
+[[elasticsearch-migration-guide-4.1-4.2.breaking-changes.refresh-policy]]
+=== RefreshPolicy
+
+[[elasticsearch-migration-guide-4.1-4.2.breaking-changes.refresh-policy.enum]]
+==== Enum package changed
+
+It was possible in 4.1 to configure the refresh policy for the `ReactiveElasticsearchTemplate` by overriding the method `AbstractReactiveElasticsearchConfiguration.refreshPolicy()` in a custom configuration class.
+The return value of this method was an instance of the class `org.elasticsearch.action.support.WriteRequest.RefreshPolicy`.
+
+Now the configuration must return `org.springframework.data.elasticsearch.core.RefreshPolicy`.
+This enum has the same values and triggers the same behaviour as before, so only the `import` statement has to be adjusted.
+
+[[elasticsearch-migration-guide-4.1-4.2.breaking-changes.refresh-policy.behaviour]]
+==== Refresh behaviour
+
+`ElasticsearchOperations` and `ReactiveElasticsearchOperations` now explicitly use the `RefreshPolicy` set on the template for write requests if not null.
+If the refresh policy is null, then nothing special is done, so the cluster defaults are used. `ElasticsearchOperations` was always using the cluster default before this version.
+
+The provided implementations for `ElasticsearchRepository` and `ReactiveElasticsearchRepository` will do an explicit refresh when the refresh policy is null.
+This is the same behaviour as in previous versions.
+If a refresh policy is set, then it will be used by the repositories as well.
+
+[[elasticsearch-migration-guide-4.1-4.2.breaking-changes.refresh-policy.configuration]]
+==== Refresh configuration
+
+When configuring Spring Data Elasticsearch like described in xref:elasticsearch/clients.adoc[Elasticsearch Clients] by using `ElasticsearchConfigurationSupport`, `AbstractElasticsearchConfiguration` or `AbstractReactiveElasticsearchConfiguration` the refresh policy will be initialized to `null`.
+Previously the reactive code initialized this to `IMMEDIATE`, now reactive and non-reactive code show the same behaviour.
+
+[[elasticsearch-migration-guide-4.1-4.2.breaking-changes.method-return-types]]
+=== Method return types
+
+[[elasticsearch-migration-guide-4.1-4.2.breaking-changes.method-return-types.delete]]
+==== delete methods that take a Query
+
+The reactive methods previously returned a `Mono<Long>` with the number of deleted documents, the non reactive versions were void. They now return a `Mono<ByQueryResponse>` which contains much more detailed information about the deleted documents and errors that might have occurred.
+
+[[elasticsearch-migration-guide-4.1-4.2.breaking-changes.method-return-types.multiget]]
+==== multiget methods
+
+The implementations of _multiget_ previousl only returned the found entities in a `List<T>` for non-reactive implementations and in a `Flux<T>` for reactive implementations. If the request contained ids that were not found, the information that these are missing was not available. The user needed to compare the returned ids to the requested ones to find
+which ones were missing.
+
+Now the `multiget` methods return a `MultiGetItem` for every requested id. This contains information about failures (like non existing indices) and the information if the item existed (then it is contained in the `MultiGetItem) or not.

src/main/antora/modules/ROOT/pages/migration-guides/migration-guide-4.2-4.3.adoc

@@ -0,0 +1,87 @@
+[[elasticsearch-migration-guide-4.2-4.3]]
+= Upgrading from 4.2.x to 4.3.x
+
+This section describes breaking changes from version 4.2.x to 4.3.x and how removed features can be replaced by new introduced features.
+
+[NOTE]
+====
+Elasticsearch is working on a new Client that will replace the `RestHighLevelClient` because the `RestHighLevelClient` uses code from Elasticsearch core libraries which are not Apache 2 licensed anymore.
+Spring Data Elasticsearch is preparing for this change as well.
+This means that internally the implementations for the `*Operations` interfaces need to change - which should be no problem if users program against the interfaces like `ElasticsearchOperations` or `ReactiveElasticsearchOperations`.
+If you are using the implementation classes like `ElasticsearchRestTemplate` directly, you will need to adapt to these changes.
+
+Spring Data Elasticsearch also removes or replaces the use of classes from the `org.elasticsearch` packages in it's API classes and methods, only using them in the implementation where the access to Elasticsearch is implemented.
+For the user that means, that some enum classes that were used are replaced by enums that live in `org.springframework.data.elasticsearch` with the same values, these are internally mapped onto the Elasticsearch ones.
+
+Places where classes are used that cannot easily be replaced, this usage is marked as deprecated, we are working on replacements.
+
+Check the sections on xref:migration-guides/migration-guide-4.2-4.3.adoc#elasticsearch-migration-guide-4.2-4.3.deprecations[Deprecations] and xref:migration-guides/migration-guide-4.2-4.3.adoc#elasticsearch-migration-guide-4.2-4.3.breaking-changes[Breaking Changes] for further details.
+====
+
+[[elasticsearch-migration-guide-4.2-4.3.deprecations]]
+== Deprecations
+
+[[elasticsearch-migration-guide-4.2-4.3.deprecations.suggest]]
+=== suggest methods
+
+In `SearchOperations`, and so in `ElasticsearchOperations` as well, the `suggest` methods taking a `org.elasticsearch.search.suggest.SuggestBuilder` as argument and returning a `org.elasticsearch.action.search.SearchResponse` have been deprecated.
+Use `SearchHits<T> search(Query query, Class<T> clazz)` instead, passing in a `NativeSearchQuery` which can contain a `SuggestBuilder` and read the suggest results from the returned `SearchHit<T>`.
+
+In `ReactiveSearchOperations` the new `suggest` methods return a `Mono<org.springframework.data.elasticsearch.core.suggest.response.Suggest>` now.
+Here as well the old methods are deprecated.
+
+[[elasticsearch-migration-guide-4.2-4.3.breaking-changes]]
+== Breaking Changes
+
+[[elasticsearch-migration-guide-4.2-4.3.breaking-changes.1]]
+=== Removal of `org.elasticsearch` classes from the API.
+
+* In the `org.springframework.data.elasticsearch.annotations.CompletionContext` annotation the property `type()` has changed from `org.elasticsearch.search.suggest.completion.context.ContextMapping.Type` to `org.springframework.data.elasticsearch.annotations.CompletionContext.ContextMappingType`, the available enum values are the same.
+* In the `org.springframework.data.elasticsearch.annotations.Document` annotation the `versionType()` property has changed to `org.springframework.data.elasticsearch.annotations.Document.VersionType`, the available enum values are the same.
+* In the `org.springframework.data.elasticsearch.core.query.Query` interface the `searchType()` property has changed to `org.springframework.data.elasticsearch.core.query.Query.SearchType`, the available enum values are the same.
+* In the `org.springframework.data.elasticsearch.core.query.Query` interface the return value of  `timeout()` was changed to `java.time.Duration`.
+* The `SearchHits<T>`class does not contain the `org.elasticsearch.search.aggregations.Aggregations` anymore.
+Instead it now contains an instance of the `org.springframework.data.elasticsearch.core.AggregationsContainer<T>` class where `T` is the concrete aggregations type from the underlying client that is used.
+Currently this will be a `org
+.springframework.data.elasticsearch.core.clients.elasticsearch7.ElasticsearchAggregations` object; later different implementations will be available.
+The same change has been done to the `ReactiveSearchOperations.aggregate()` functions, the now return a `Flux<AggregationContainer<?>>`.
+Programs using the aggregations need to be changed to cast the returned value to the appropriate class to further proces it.
+* methods that might have thrown a `org.elasticsearch.ElasticsearchStatusException` now will throw `org.springframework.data.elasticsearch.RestStatusException` instead.
+
+[[elasticsearch-migration-guide-4.2-4.3.breaking-changes.2]]
+=== Handling of field and sourceFilter properties of Query
+
+Up to version 4.2 the `fields` property of a `Query` was interpreted and added to the include list of the `sourceFilter`.
+This was not correct, as these are different things for Elasticsearch.
+This has been corrected.
+As a consequence code might not work anymore that relies on using `fields` to specify which fields should be returned from the document's `_source' and should be changed to use the `sourceFilter`.
+
+[[elasticsearch-migration-guide-4.2-4.3.breaking-changes.3]]
+=== search_type default value
+
+The default value for the `search_type` in Elasticsearch is `query_then_fetch`.
+This now is also set as default value in the `Query` implementations, it was previously set to `dfs_query_then_fetch`.
+
+[[elasticsearch-migration-guide-4.2-4.3.breaking-changes.4]]
+=== BulkOptions changes
+
+Some properties of the `org.springframework.data.elasticsearch.core.query.BulkOptions` class have changed their type:
+
+* the type of the `timeout` property has been changed to `java.time.Duration`.
+* the type of the`refreshPolicy` property has been changed to `org.springframework.data.elasticsearch.core.RefreshPolicy`.
+
+[[elasticsearch-migration-guide-4.2-4.3.breaking-changes.5]]
+=== IndicesOptions change
+
+Spring Data Elasticsearch now uses `org.springframework.data.elasticsearch.core.query.IndicesOptions` instead of `org.elasticsearch.action.support.IndicesOptions`.
+
+[[elasticsearch-migration-guide-4.2-4.3.breaking-changes.6]]
+=== Completion classes
+
+The classes from the package `org.springframework.data.elasticsearch.core.completion` have been moved to `org.springframework.data.elasticsearch.core.suggest`.
+
+[[elasticsearch-migration-guide-4.2-4.3.breaking-changes.7]]
+=== Other renamings
+
+The `org.springframework.data.elasticsearch.core.mapping.ElasticsearchPersistentPropertyConverter` interface has been renamed to `org.springframework.data.elasticsearch.core.mapping.PropertyValueConverter`.
+Likewise the implementations classes named _XXPersistentPropertyConverter_ have been renamed to _XXPropertyValueConverter_.

src/main/antora/modules/ROOT/pages/migration-guides/migration-guide-4.3-4.4.adoc

@@ -0,0 +1,183 @@
+[[elasticsearch-migration-guide-4.3-4.4]]
+= Upgrading from 4.3.x to 4.4.x
+
+This section describes breaking changes from version 4.3.x to 4.4.x and how removed features can be replaced by new introduced features.
+
+[[elasticsearch-migration-guide-4.3-4.4.deprecations]]
+== Deprecations
+
+[[elasticsearch-migration-guide-4.3-4.4.deprecations.reactive-operations]]
+=== org.springframework.data.elasticsearch.core.ReactiveElasticsearchOperations
+
+The method `<T> Publisher<T> execute(ClientCallback<Publisher<T>> callback)` has been deprecated.
+As there now are multiple implementations using different client libraries the `execute` method is still available in the different implementations, but there is no more method in the interface, because there is no common callback interface for the different clients.
+
+[[elasticsearch-migration-guide-4.3-4.4.breaking-changes]]
+== Breaking Changes
+
+[[elasticsearch-migration-guide-4.3-4.4.breaking-changes.1]]
+=== Removal of deprecated classes
+
+[[org-springframework-data-elasticsearch-core-elasticsearchtemplate-has-been-removed]]
+==== `org.springframework.data.elasticsearch.core.ElasticsearchTemplate` has been removed
+
+As of version 4.4 Spring Data Elasticsearch does not use the `TransportClient` from Elasticsearch anymore (which itself is deprecated since Elasticsearch 7.0).
+This means that the `org.springframework.data.elasticsearch.core.ElasticsearchTemplate` class which was deprecated since Spring Data Elasticsearch 4.0 has been removed.
+This was the implementation of the `ElasticsearchOperations` interface that was using the `TransportClient`.
+Connections to Elasticsearch must be made using either the imperative `ElasticsearchRestTemplate` or the reactive `ReactiveElasticsearchTemplate`.
+
+[[elasticsearch-migration-guide-4.3-4.4.breaking-changes.2]]
+=== Package changes
+
+In 4.3 two classes (`ElasticsearchAggregations` and `ElasticsearchAggregation`) had been moved to the `org.springframework.data.elasticsearch.core.clients.elasticsearch7` package in preparation for the integration of the new Elasticsearch client.
+The were moved back to the `org.springframework.data.elasticsearch.core` package as we keep the classes use the old Elasticsearch client where they were.
+
+[[elasticsearch-migration-guide-4.3-4.4.breaking-changes.3]]
+=== Behaviour change
+
+The `ReactiveElasticsearchTemplate`, when created directly or by Spring Boot configuration had a default refresh policy of IMMEDIATE.
+This could cause performance issues on heavy indexing and was different than the default behaviour of Elasticsearch.
+This has been changed to that now the default refresh policy is NONE.
+When the
+`ReactiveElasticsearchTemplate` was provided by using the configuration like described in xref:elasticsearch/clients.adoc#elasticsearch.clients.reactiverestclient[Reactive REST Client] the default refresh policy already was set to NONE.
+
+[[elasticsearch-migration-guide-4.3-4.4.new-clients]]
+== New Elasticsearch client
+
+Elasticsearch has introduced it's new `ElasticsearchClient` and has deprecated the previous `RestHighLevelClient`.
+Spring Data Elasticsearch 4.4 still uses the old client as the default client for the following reasons:
+
+* The new client forces applications to use the `jakarta.json.spi.JsonProvider` package whereas Spring Boot will stick to `javax.json.spi.JsonProvider` until version 3. So switching the default implementaiton in Spring Data Elasticsearch can only come with Spring Data Elasticsearch 5 (Spring Data 3, Spring 6).
+* There are still some bugs in the Elasticsearch client which need to be resolved
+* The implementation using the new client in Spring Data Elasticsearch is not yet complete, due to limited resources working on that - remember Spring Data Elasticsearch is a community driven project that lives from public contributions.
+
+[[elasticsearch-migration-guide-4.3-4.4.new-clients.how-to]]
+=== How to use the new client
+
+CAUTION: The implementation using the new client is not complete, some operations will throw a `java.lang.UnsupportedOperationException` or might throw NPE (for example when the Elasticsearch cannot parse a response from the server, this still happens sometimes) +
+Use the new client to test the implementations but do not use it in productive code yet!
+
+In order to try and use the new client the following steps are necessary:
+
+[[elasticsearch-migration-guide-4.3-4.4.new-clients.how-to.not]]
+==== Make sure not to configure the existing default client
+
+If using Spring Boot, exclude Spring Data Elasticsearch from the autoconfiguration
+
+====
+[source,java]
+----
+@SpringBootApplication(exclude = ElasticsearchDataAutoConfiguration.class)
+public class SpringdataElasticTestApplication {
+	// ...
+}
+
+----
+====
+
+Remove Spring Data Elasticsearch related properties from your application configuration.
+If Spring Data Elasticsearch was configured using a programmatic configuration (see xref:elasticsearch/clients.adoc[Elasticsearch Clients]), remove these beans from the Spring application context.
+
+[[elasticsearch-migration-guide-4.3-4.4.new-clients.how-to.dependencies]]
+==== Add dependencies
+
+The dependencies for the new Elasticsearch client are still optional in Spring Data Elasticsearch so they need to be added explicitly:
+
+====
+[source,xml]
+----
+<dependencies>
+    <dependency>
+        <groupId>co.elastic.clients</groupId>
+        <artifactId>elasticsearch-java</artifactId>
+        <version>7.17.3</version>
+        <exclusions>
+            <exclusion>
+                <groupId>commons-logging</groupId>
+                <artifactId>commons-logging</artifactId>
+            </exclusion>
+        </exclusions>
+    </dependency>
+    <dependency>
+        <groupId>org.elasticsearch.client</groupId>
+        <artifactId>elasticsearch-rest-client</artifactId> <!-- is Apache 2-->
+        <version>7.17.3</version>
+        <exclusions>
+            <exclusion>
+                <groupId>commons-logging</groupId>
+                <artifactId>commons-logging</artifactId>
+            </exclusion>
+        </exclusions>
+    </dependency>
+</dependencies>
+----
+====
+
+When using Spring Boot, it is necessary to set the following property in the _pom.xml_.
+
+====
+[source,xml]
+----
+<properties>
+    <jakarta-json.version>2.0.1</jakarta-json.version>
+</properties>
+----
+====
+
+[[elasticsearch-migration-guide-4.3-4.4.new-clients.how-to.configuration]]
+==== New configuration classes
+
+[[elasticsearch-migration-guide-4.3-4.4.new-clients.how-to.configuration.imperative]]
+===== Imperative style
+
+In order configure Spring Data Elasticsearch to use the new client, it is necessary to create a configuration bean that derives from `org.springframework.data.elasticsearch.client.elc.ElasticsearchConfiguration`:
+
+====
+[source,java]
+----
+@Configuration
+public class NewRestClientConfig extends ElasticsearchConfiguration {
+
+	@Override
+	public ClientConfiguration clientConfiguration() {
+		return ClientConfiguration.builder() //
+			.connectedTo("localhost:9200") //
+			.build();
+	}
+}
+----
+====
+
+The configuration is done in the same way as with the old client, but it is not necessary anymore to create more than the configuration bean.
+With this configuration, the following beans will be available in the Spring application context:
+
+* a `RestClient` bean, that is the configured low level `RestClient` that is used by the Elasticsearch client
+* an `ElasticsearchClient` bean, this is the new client that uses the `RestClient`
+* an `ElasticsearchOperations` bean, available with the bean names _elasticsearchOperations_ and _elasticsearchTemplate_, this uses the `ElasticsearchClient`
+
+[[elasticsearch-migration-guide-4.3-4.4.new-clients.how-to.configuration.reactive]]
+===== Reactive style
+
+To use the new client in a reactive environment the only difference is the class from which to derive the configuration:
+
+====
+[source,java]
+----
+@Configuration
+public class NewRestClientConfig extends ReactiveElasticsearchConfiguration {
+
+	@Override
+	public ClientConfiguration clientConfiguration() {
+		return ClientConfiguration.builder() //
+			.connectedTo("localhost:9200") //
+			.build();
+	}
+}
+----
+====
+
+With this configuration, the following beans will be available in the Spring application context:
+
+* a `RestClient` bean, that is the configured low level `RestClient` that is used by the Elasticsearch client
+* an `ReactiveElasticsearchClient` bean, this is the new reactive client that uses the `RestClient`
+* an `ReactiveElasticsearchOperations` bean, available with the bean names _reactiveElasticsearchOperations_ and _reactiveElasticsearchTemplate_, this uses the `ReactiveElasticsearchClient`

src/main/antora/modules/ROOT/pages/migration-guides/migration-guide-4.4-5.0.adoc

@@ -0,0 +1,167 @@
+[[elasticsearch-migration-guide-4.4-5.0]]
+= Upgrading from 4.4.x to 5.0.x
+
+This section describes breaking changes from version 4.4.x to 5.0.x and how removed features can be replaced by new introduced features.
+
+[[elasticsearch-migration-guide-4.4-4.5.deprecations]]
+== Deprecations
+
+[[custom-trace-level-logging]]
+=== Custom trace level logging
+
+Logging by setting the property `logging.level.org.springframework.data.elasticsearch.client.WIRE=trace` is deprecated now, the Elasticsearch `RestClient` provides a better solution that can be activated by setting the logging level of the `tracer` package to "trace".
+
+[[elasticsearch-migration-guide-4.4-4.5.deprecations.package]]
+=== `org.springframework.data.elasticsearch.client.erhlc` package
+
+See xref:migration-guides/migration-guide-4.4-5.0.adoc#elasticsearch-migration-guide-4.4-5.0.breaking-changes-packages[Package changes], all classes in this package have been deprecated, as the default client implementations to use are the ones based on the new Java Client from Elasticsearch, see xref:migration-guides/migration-guide-4.4-5.0.adoc#elasticsearch-migration-guide-4.4-5.0.new-clients[New Elasticsearch client]
+
+[[elasticsearch-migration-guide-4.4-4.5.deprecations.code]]
+=== Removal of deprecated code
+
+`DateFormat.none` and `DateFormat.custom` had been deprecated since version 4.2 and have been removed.
+
+The properties of `@Document` that were deprecated since 4.2 have been removed.
+Use the `@Settings` annotation for these.
+
+`@DynamicMapping` and `@DynamicMappingValue` have been removed.
+Use `@Document.dynamic` or `@Field.dynamic` instead.
+
+[[elasticsearch-migration-guide-4.4-5.0.breaking-changes]]
+== Breaking Changes
+
+[[elasticsearch-migration-guide-4.4-5.0.breaking-changes.deprecated-calls]]
+=== Removal of deprecated calls
+
+[[elasticsearch-migration-guide-4.4-5.0.breaking-changes.deprecated-calls.1]]
+==== suggest calls in operations interfaces have been removed
+
+Both `SearchOperations` and `ReactiveSearchOperations` had deprecated calls that were using Elasticsearch classes as parameters.
+These now have been removed and so the dependency on Elasticsearch classes in these APIs has been cleaned.
+
+[[elasticsearch-migration-guide-4.4-5.0.breaking-changes-packages]]
+=== Package changes
+
+All the classes that are using or depend on the deprecated Elasticsearch `RestHighLevelClient` have been moved to the package `org.springframework.data.elasticsearch.client.erhlc`.
+By this change we now have a clear separation of code using the old deprecated Elasticsearch libraries, code using the new Elasticsearch client and code that is independent of the client implementation.
+Also the reactive implementation that was provided up to now has been moved here, as this implementation contains code that was copied and adapted from Elasticsearch libraries.
+
+If you are using `ElasticsearchRestTemplate` directly and not the `ElasticsearchOperations` interface you'll need to adjust your imports as well.
+
+When working with the `NativeSearchQuery` class, you'll need to switch to the `NativeQuery` class, which can take a
+`Query` instance coming from the new Elasticsearch client libraries.
+You'll find plenty of examples in the test code.
+
+[[elasticsearch-migration-guide-4.4-5.0.breaking-changes-records]]
+=== Conversion to Java 17 records
+
+The following classes have been converted to `Record`, you might need to adjust the use of getter methods from
+`getProp()` to `prop()`:
+
+* `org.springframework.data.elasticsearch.core.AbstractReactiveElasticsearchTemplate.IndexResponseMetaData`
+* `org.springframework.data.elasticsearch.core.ActiveShardCount`
+* `org.springframework.data.elasticsearch.support.Version`
+* `org.springframework.data.elasticsearch.support.ScoreDoc`
+* `org.springframework.data.elasticsearch.core.query.ScriptData`
+* `org.springframework.data.elasticsearch.core.query.SeqNoPrimaryTerm`
+
+[[elasticsearch-migration-guide-4.4-5.0.breaking-changes-http-headers]]
+=== New HttpHeaders class
+
+Until version 4.4 the client configuration used the `HttpHeaders` class from the `org.springframework:spring-web`
+project.
+This introduces a dependency on that artifact.
+Users that do not use spring-web then face an error as this class cannot be found.
+
+In version 5.0 we introduce our own `HttpHeaders` to configure the clients.
+
+So if you are using headers in the client configuration, you need to replace `org.springframework.http.HttpHeaders`
+with `org.springframework.data.elasticsearch.support.HttpHeaders`.
+
+Hint: You can pass a `org.springframework.http
+.HttpHeaders` to the `addAll()` method of `org.springframework.data.elasticsearch.support.HttpHeaders`.
+
+[[elasticsearch-migration-guide-4.4-5.0.new-clients]]
+== New Elasticsearch client
+
+Spring Data Elasticsearch now uses the new `ElasticsearchClient` and has deprecated the use of the previous `RestHighLevelClient`.
+
+[[elasticsearch-migration-guide-4.4-5.0.new-clients.imperative]]
+=== Imperative style configuration
+
+To configure Spring Data Elasticsearch to use the new client, it is necessary to create a configuration bean that derives from `org.springframework.data.elasticsearch.client.elc.ElasticsearchConfiguration`:
+
+====
+[source,java]
+----
+@Configuration
+public class NewRestClientConfig extends ElasticsearchConfiguration {
+
+	@Override
+	public ClientConfiguration clientConfiguration() {
+		return ClientConfiguration.builder() //
+			.connectedTo("localhost:9200") //
+			.build();
+	}
+}
+----
+====
+
+The configuration is done in the same way as with the old client, but it is not necessary anymore to create more than the configuration bean.
+With this configuration, the following beans will be available in the Spring application context:
+
+* a `RestClient` bean, that is the configured low level `RestClient` that is used by the Elasticsearch client
+* an `ElasticsearchClient` bean, this is the new client that uses the `RestClient`
+* an `ElasticsearchOperations` bean, available with the bean names _elasticsearchOperations_ and _elasticsearchTemplate_, this uses the `ElasticsearchClient`
+
+[[elasticsearch-migration-guide-4.4-5.0.new-clients.reactive]]
+=== Reactive style configuration
+
+To use the new client in a reactive environment the only difference is the class from which to derive the configuration:
+
+====
+[source,java]
+----
+@Configuration
+public class NewRestClientConfig extends ReactiveElasticsearchConfiguration {
+
+	@Override
+	public ClientConfiguration clientConfiguration() {
+		return ClientConfiguration.builder() //
+			.connectedTo("localhost:9200") //
+			.build();
+	}
+}
+----
+====
+
+With this configuration, the following beans will be available in the Spring application context:
+
+* a `RestClient` bean, that is the configured low level `RestClient` that is used by the Elasticsearch client
+* an `ReactiveElasticsearchClient` bean, this is the new reactive client that uses the `RestClient`
+* an `ReactiveElasticsearchOperations` bean, available with the bean names _reactiveElasticsearchOperations_ and _reactiveElasticsearchTemplate_, this uses the `ReactiveElasticsearchClient`
+
+[[elasticsearch-migration-guide-4.4-5.0.old-client]]
+=== Still want to use the old client?
+
+The old deprecated `RestHighLevelClient` can still be used, but you will need to add the dependency explicitly to your application as Spring Data Elasticsearch does not pull it in automatically anymore:
+
+====
+[source,xml]
+----
+<!-- include the RHLC, specify version explicitly	-->
+<dependency>
+	<groupId>org.elasticsearch.client</groupId>
+	<artifactId>elasticsearch-rest-high-level-client</artifactId>
+	<version>7.17.5</version>
+	<exclusions>
+		<exclusion>
+			<groupId>commons-logging</groupId>
+			<artifactId>commons-logging</artifactId>
+		</exclusion>
+	</exclusions>
+</dependency>
+----
+====
+
+Make sure to specify the version 7.17.6 explicitly, otherwise maven will resolve to 8.5.0, and this does not exist.

src/main/antora/modules/ROOT/pages/migration-guides/migration-guide-5.0-5.1.adoc

@@ -0,0 +1,27 @@
+[[elasticsearch-migration-guide-5.0-5.1]]
+= Upgrading from 5.0.x to 5.1.x
+
+This section describes breaking changes from version 5.0.x to 5.1.x and how removed features can be replaced by new introduced features.
+
+[[elasticsearch-migration-guide-5.0-5.1.breaking-changes]]
+== Breaking Changes
+
+In the `org.springframework.data.elasticsearch.core.index.AliasData` class, which is used for alias information returned from Elasticsearch, the property `filter` (of type `Document`) is replaced by `filterQuery` which is of type
+`org.springframework.data.elasticsearch.core.query.Query`.
+
+`org.springframework.data.elasticsearch.annotations.Similarity` was an enum class until 5.1. This enum was used in the `@Field` annotation to specify a similarity value.
+But besides the values defined by the enum, it is possible to have similarities with custom names in Elasticsearch.
+Therefore, the annotation property was changed from the type of the enum to a simple `String`.
+The previous enum values like `Similarity.Default` do still exist as String constants, so existing code will compile unmodified.
+Adaptions are necessary when this enum was used at other places than as a property of the `@Field` annotation.
+
+[[elasticsearch-migration-guide-5.0-5.1.deprecations]]
+== Deprecations
+
+[[template-functions]]
+=== template functions
+
+The functions in the `IndexOperations` and `ReactiverIndexOperations` to manage index templates that were introduced in Spring Data Elasticsearch 4.1
+have been deprecated. They were using the old Elasticsearch API that was deprecated in Elasticsearch version 7.8. 
+
+Please use the new functions that are based on the composable index template API instead.

src/main/antora/modules/ROOT/pages/migration-guides/migration-guide-5.1-5.2.adoc

@@ -0,0 +1,40 @@
+[[elasticsearch-migration-guide-5.1-5.2]]
+= Upgrading from 5.1.x to 5.2.x
+
+This section describes breaking changes from version 5.1.x to 5.2.x and how removed features can be replaced by new introduced features.
+
+[[elasticsearch-migration-guide-5.1-5.2.breaking-changes]]
+== Breaking Changes
+
+[[bulk-failures]]
+=== Bulk failures
+In the `org.springframework.data.elasticsearch.BulkFailureException` class, the return type of the `getFailedDocuments` is changed from `Map<String, String>`
+to `Map<String, FailureDetails>`, which allows to get additional details about failure reasons.
+
+The definition of the `FailureDetails` class (inner to `BulkFailureException`):
+[source,java]
+public record FailureDetails(Integer status, String errorMessage) {
+}
+
+[[scripted-and-runtime-fields]]
+=== scripted and runtime fields
+
+The classes `org.springframework.data.elasticsearch.core.RuntimeField` and `org.springframework.data.elasticsearch.core.query.ScriptType` have been moved to the subpackage `org.springframework.data.elasticsearch.core.query`.
+
+The `type` parameter of the `ScriptData` constructor is not nullable any longer.
+
+[[elasticsearch-migration-guide-5.1-5.2.deprecations]]
+== Deprecations
+
+[[removal-of-deprecated-code]]
+=== Removal of deprecated code
+
+* All the code using the old deprecated `RestHighLevelClient` has been removed.
+The default Elasticsearch client used since version 5.0 is the (not so) new Elasticsearch Java client.
+* The `org.springframework.data.elasticsearch.client.ClientLogger` class has been removed.
+This logger was configured with the `org.springframework.data.elasticsearch.client.WIRE` setting, but was not working with all clients.
+From version 5 on, use the trace logger available in the Elasticsearch Java client, see xref:elasticsearch/clients.adoc#elasticsearch.clients.logging[Client Logging].
+* The method `org.springframework.data.elasticsearch.core.ElasticsearchOperations.stringIdRepresentation(Object)` has been removed, use the `convertId(Object)` method defined in the same interface instead.
+* The class `org.springframework.data.elasticsearch.core.Range` has been removed, use `org.springframework.data.domain.Range` instead.
+* The methods `org.springframework.data.elasticsearch.core.query.IndexQuery.getParentId() and `setParentId(String)` have been removed, they weren't used anymore and were no-ops.
+It has been removed from the `org.springframework.data.elasticsearch.core.query.IndexQuery` class as well.

src/main/antora/modules/ROOT/pages/migration-guides/migration-guide-5.2-5.3.adoc

@@ -0,0 +1,21 @@
+[[elasticsearch-migration-guide-5.2-5.3]]
+= Upgrading from 5.2.x to 5.3.x
+
+This section describes breaking changes from version 5.2.x to 5.3.x and how removed features can be replaced by new introduced features.
+
+[[elasticsearch-migration-guide-5.2-5.3.breaking-changes]]
+== Breaking Changes
+
+During the parameter replacement in `@Query` annotated repository methods previous versions wrote the String `"null"` into the query that was sent to Elasticsearch when the actual parameter value was `null`.
+As Elasticsearch does not store `null` values, this behaviour could lead to problems, for example whent the fields to be searched contains the string `"null"`.
+In Version 5.3 a `null` value in a parameter will cause a `ConversionException` to be thrown.
+If you are using `"null"` as the
+`null_value` defined in a field mapping, then pass that string into the query instead of a Java `null`.
+
+[[elasticsearch-migration-guide-5.2-5.3.deprecations]]
+== Deprecations
+
+=== Removals
+
+The deprecated classes `org.springframework.data.elasticsearch.ELCQueries`
+and `org.springframework.data.elasticsearch.client.elc.QueryBuilders` have been removed, use `org.springframework.data.elasticsearch.client.elc.Queries` instead.

src/main/antora/modules/ROOT/pages/migration-guides/migration-guide-5.3-5.4.adoc

@@ -0,0 +1,23 @@
+[[elasticsearch-migration-guide-5.3-5.4]]
+= Upgrading from 5.3.x to 5.4.x
+
+This section describes breaking changes from version 5.3.x to 5.4.x and how removed features can be replaced by new introduced features.
+
+[[elasticsearch-migration-guide-5.3-5.4.breaking-changes]]
+== Breaking Changes
+
+[[elasticsearch-migration-guide-5.3-5.4.breaking-changes.knn-search]]
+=== knn search
+The `withKnnQuery` method in `NativeQueryBuilder` has been replaced with `withKnnSearches` to build a `NativeQuery` with knn search.
+
+`KnnQuery` and `KnnSearch` are two different classes in elasticsearch java client and are used for different queries, with different parameters supported:
+
+- `KnnSearch`: is https://www.elastic.co/guide/en/elasticsearch/reference/8.13/search-search.html#search-api-knn[the top level `knn` query] in the elasticsearch request;
+- `KnnQuery`: is https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-knn-query.html[the `knn` query inside `query` clause];
+
+If `KnnQuery` is still preferable, please be sure to construct it inside `query` clause manually, by means of `withQuery(co.elastic.clients.elasticsearch._types.query_dsl.Query query)` clause in `NativeQueryBuilder`.
+
+[[elasticsearch-migration-guide-5.3-5.4.deprecations]]
+== Deprecations
+
+=== Removals

src/main/antora/modules/ROOT/pages/migration-guides/migration-guide-5.4-5.5.adoc

@@ -0,0 +1,30 @@
+[[elasticsearch-migration-guide-5.4-5.5]]
+= Upgrading from 5.4.x to 5.5.x
+
+This section describes breaking changes from version 5.4.x to 5.5.x and how removed features can be replaced by new introduced features.
+
+[[elasticsearch-migration-guide-5.4-5.5.breaking-changes]]
+== Breaking Changes
+
+[[elasticsearch-migration-guide-5.4-5.5.deprecations]]
+== Deprecations
+
+Some classes that probably are not used by a library user have been renamed, the classes with the old names are still there, but are deprecated:
+
+|===
+|old name|new name
+
+|ElasticsearchPartQuery|RepositoryPartQuery
+|ElasticsearchStringQuery|RepositoryStringQuery
+|ReactiveElasticsearchStringQuery|ReactiveRepositoryStringQuery
+|===
+
+=== Removals
+
+The following methods that had been deprecated since release 5.3 have been removed:
+```
+DocumentOperations.delete(Query, Class<?>)
+DocumentOperations.delete(Query, Class<?>, IndexCoordinates)
+ReactiveDocumentOperations.delete(Query, Class<?>)
+ReactiveDocumentOperations.delete(Query, Class<?>, IndexCoordinates)
+```

src/main/antora/modules/ROOT/pages/migration-guides/migration-guide-5.5-6.0.adoc

@@ -0,0 +1,27 @@
+[[elasticsearch-migration-guide-5.5-6.0]]
+= Upgrading from 5.5.x to 6.0.x
+
+This section describes breaking changes from version 5.5.x to 6.0.x and how removed features can be replaced by new introduced features.
+
+[[elasticsearch-migration-guide-5.5-6.0.breaking-changes]]
+== Breaking Changes
+
+From version 6.0 on, Spring Data Elasticsearch uses the Elasticsearch 9 libraries and as default the new `Rest5Client` provided by these libraries. It is still possible to use the old `RestClient`, check xref:elasticsearch/clients.adoc[Elasticsearch clients] for information. The configuration callbacks for this `RestClient` have been moved from `org.springframework.data.elasticsearch.client.elc.ElasticsearchClients` to the `org.springframework.data.elasticsearch.client.elc.rest_client.RestClients` class.
+
+In the `org.springframework.data.elasticsearch.core.query.UpdateQuery` class the type of the two fields `ifSeqNo` and `ifPrimaryTerm` has changed from `Integer` to `Long` to align with the normal query and the underlying Elasticsearch client.
+
+[[elasticsearch-migration-guide-5.5-6.0.deprecations]]
+== Deprecations
+
+All the code using the old `RestClient` has been moved to the `org.springframework.data.elasticsearch.client.elc.rest_client` package and has been deprecated. Users should switch to the classes from the `org.springframework.data.elasticsearch.client.elc.rest5_client` package.
+
+
+=== Removals
+
+The `org.springframework.data.elasticsearch.core.query.ScriptType` enum has been removed. To distinguish between an inline and a stored script set the appropriate values in the `org.springframework.data.elasticsearch.core.query.ScriptData` record.
+
+These methods have been removed because the Elasticsearch Client 9 does not support them anymore:
+```
+org.springframework.data.elasticsearch.client.elc.ReactiveElasticsearchIndicesClient.unfreeze(UnfreezeRequest)
+org.springframework.data.elasticsearch.client.elc.ReactiveElasticsearchIndicesClient.unfreeze(Function<UnfreezeRequest.Builder, ObjectBuilder<UnfreezeRequest>>)
+```

src/main/antora/modules/ROOT/pages/repositories.adoc

@@ -0,0 +1,8 @@
+[[elasticsearch.repositories]]
+= Repositories
+:page-section-summary-toc: 1
+
+This chapter explains the basic foundations of Spring Data repositories and Elasticsearch specifics.
+Before continuing to the Elasticsearch specifics, make sure you have a sound understanding of the basic concepts.
+
+The goal of the Spring Data repository abstraction is to significantly reduce the amount of boilerplate code required to implement data access layers for various persistence stores.

src/main/antora/modules/ROOT/pages/repositories/core-concepts.adoc

@@ -0,0 +1,4 @@
+include::{commons}@data-commons::page$repositories/core-concepts.adoc[]
+
+[[elasticsearch.entity-persistence.state-detection-strategies]]
+include::{commons}@data-commons::page$is-new-state-detection.adoc[leveloffset=+1]

src/main/antora/modules/ROOT/pages/repositories/core-domain-events.adoc

@@ -0,0 +1 @@
+include::{commons}@data-commons::page$repositories/core-domain-events.adoc[]

src/main/antora/modules/ROOT/pages/repositories/core-extensions.adoc

@@ -0,0 +1 @@
+include::{commons}@data-commons::page$repositories/core-extensions.adoc[]

src/main/antora/modules/ROOT/pages/repositories/create-instances.adoc

@@ -0,0 +1 @@
+include::{commons}@data-commons::page$repositories/create-instances.adoc[]

src/main/antora/modules/ROOT/pages/repositories/custom-implementations.adoc

@@ -0,0 +1 @@
+include::{commons}@data-commons::page$repositories/custom-implementations.adoc[]

src/main/antora/modules/ROOT/pages/repositories/definition.adoc

@@ -0,0 +1 @@
+include::{commons}@data-commons::page$repositories/definition.adoc[]

src/main/antora/modules/ROOT/pages/repositories/null-handling.adoc

@@ -0,0 +1 @@
+include::{commons}@data-commons::page$repositories/null-handling.adoc[]

src/main/antora/modules/ROOT/pages/repositories/projections.adoc

@@ -0,0 +1,4 @@
+[[elasticsearch.projections]]
+= Projections
+
+include::{commons}@data-commons::page$repositories/projections.adoc[leveloffset=+1]

src/main/antora/modules/ROOT/pages/repositories/query-keywords-reference.adoc

@@ -0,0 +1 @@
+include::{commons}@data-commons::page$repositories/query-keywords-reference.adoc[]

src/main/antora/modules/ROOT/pages/repositories/query-methods-details.adoc

@@ -0,0 +1 @@
+include::{commons}@data-commons::page$repositories/query-methods-details.adoc[]

src/main/antora/modules/ROOT/pages/repositories/query-return-types-reference.adoc

@@ -0,0 +1 @@
+include::{commons}@data-commons::page$repositories/query-return-types-reference.adoc[]

src/main/antora/resources/antora-resources/antora.yml

@@ -0,0 +1,21 @@
+version: ${antora-component.version}
+prerelease: ${antora-component.prerelease}
+
+asciidoc:
+  attributes:
+    copyright-year: ${current.year}
+    version: ${project.version}
+    springversionshort: ${spring.short}
+    springversion: ${spring}
+    attribute-missing: 'warn'
+    commons: ${springdata.commons.docs}
+    include-xml-namespaces: false
+    spring-data-commons-docs-url: https://docs.spring.io/spring-data/commons/reference
+    spring-data-commons-javadoc-base: https://docs.spring.io/spring-data/commons/docs/${springdata.commons}/api/
+    springdocsurl: https://docs.spring.io/spring-framework/reference/{springversionshort}
+    springjavadocurl: https://docs.spring.io/spring-framework/docs/${spring}/javadoc-api
+    spring-framework-docs: '{springdocsurl}'
+    spring-framework-javadoc: '{springjavadocurl}'
+    springhateoasversion: ${spring-hateoas}
+    releasetrainversion: ${releasetrain}
+    store: Elasticsearch

src/main/asciidoc/index.adoc

@@ -1,36 +0,0 @@
-= Spring Data Elasticsearch
-BioMed Central Development Team
-:revnumber: {version}
-:revdate: {localdate}
-:toc:
-:toc-placement!:
-:spring-data-commons-docs: ../../../../spring-data-commons/src/main/asciidoc
-
-(C) 2013-2015 The original author(s).
-
-NOTE: Copies of this document may be made for your own use and for distribution to others, provided that you do not charge any fee for such copies and further provided that each copy contains this Copyright Notice, whether distributed in print or electronically.
-
-toc::[]
-
-include::preface.adoc[]
-:leveloffset: +1
-include::{spring-data-commons-docs}/repositories.adoc[]
-:leveloffset: -1
-
-[[reference]]
-= Reference Documentation
-
-:leveloffset: +1
-include::reference/data-elasticsearch.adoc[]
-include::reference/elasticsearch-misc.adoc[]
-:leveloffset: -1
-
-[[appendix]]
-= Appendix
-:numbered!:
-:leveloffset: +1
-include::{spring-data-commons-docs}/repository-namespace-reference.adoc[]
-include::{spring-data-commons-docs}/repository-populator-namespace-reference.adoc[]
-include::{spring-data-commons-docs}/repository-query-keywords-reference.adoc[]
-include::{spring-data-commons-docs}/repository-query-return-types-reference.adoc[]
-:leveloffset: -1

src/main/asciidoc/preface.adoc

@@ -1,20 +0,0 @@
-= Preface
-
-The Spring Data Elasticsearch project applies core Spring concepts to the development of solutions using the Elasticsearch Search Engine. We have povided a "template" as a high-level abstraction for storing,querying,sorting and faceting documents. You will notice similarities to the Spring data solr and mongodb support in the Spring Framework.
-
-[[project]]
-[preface]
-== Project Metadata
-
-* Version Control - https://github.com/spring-projects/spring-data-elasticsearch
-* Bugtracker - https://jira.spring.io/browse/DATAES
-* Release repository - https://repo.spring.io/libs-release
-* Milestone repository - https://repo.spring.io/libs-milestone
-* Snapshot repository - https://repo.spring.io/libs-snapshot
-
-[[requirements]]
-[preface]
-== Requirements
-
-Requires http://www.elasticsearch.org/download/[Elasticsearch] 0.20.2 and above or optional dependency or not even that if you are using Embedded Node Client
-

src/main/asciidoc/reference/data-elasticsearch.adoc

@@ -1,288 +0,0 @@
-[[elasticsearch.repositories]]
-= Elasticsearch Repositories
-
-This chapter includes details of the Elasticsearch repository implementation.
-
-[[elasticsearch.introduction]]
-== Introduction
-
-[[elasticsearch.namespace]]
-=== Spring Namespace
-
-The Spring Data Elasticsearch module contains a custom namespace allowing definition of repository beans as well as elements for instantiating a `ElasticsearchServer` .
-
-Using the `repositories` element looks up Spring Data repositories as described in <<repositories.create-instances>> .
-
-.Setting up Elasticsearch repositories using Namespace
-====
-[source,xml]
-----
-<?xml version="1.0" encoding="UTF-8"?>
-<beans xmlns="http://www.springframework.org/schema/beans"
-xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-xmlns:elasticsearch="http://www.springframework.org/schema/data/elasticsearch"
-xsi:schemaLocation="http://www.springframework.org/schema/beans
-http://www.springframework.org/schema/beans/spring-beans-3.1.xsd
-http://www.springframework.org/schema/data/elasticsearch
-http://www.springframework.org/schema/data/elasticsearch/spring-elasticsearch-1.0.xsd">
-
-    <elasticsearch:repositories base-package="com.acme.repositories" />
-    
-</beans>
-----
-====
-
-Using the `Transport Client` or `Node Client` element registers an instance of `Elasticsearch Server` in the context. 
-
-.Transport Client using Namespace
-====
-[source,xml]
-----
-<?xml version="1.0" encoding="UTF-8"?>
-<beans xmlns="http://www.springframework.org/schema/beans"
-xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-xmlns:elasticsearch="http://www.springframework.org/schema/data/elasticsearch"
-xsi:schemaLocation="http://www.springframework.org/schema/beans
-http://www.springframework.org/schema/beans/spring-beans-3.1.xsd
-http://www.springframework.org/schema/data/elasticsearch
-http://www.springframework.org/schema/data/elasticsearch/spring-elasticsearch-1.0.xsd">
-
-    <elasticsearch:transport-client id="client" cluster-nodes="localhost:9300,someip:9300" />
-    
-</beans> 
-----
-====
-
-.Node Client using Namespace
-====
-[source,xml]
-----
-<?xml version="1.0" encoding="UTF-8"?>
-<beans xmlns="http://www.springframework.org/schema/beans"
-xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-xmlns:elasticsearch="http://www.springframework.org/schema/data/elasticsearch"
-xsi:schemaLocation="http://www.springframework.org/schema/beans
-http://www.springframework.org/schema/beans/spring-beans-3.1.xsd
-http://www.springframework.org/schema/data/elasticsearch
-http://www.springframework.org/schema/data/elasticsearch/spring-elasticsearch-1.0.xsd">
-
-    <elasticsearch:node-client id="client" local="true"" />
-    
-</beans> 
-----
-====
-
-[[elasticsearch.annotation]]
-=== Annotation based configuration
-
-The Spring Data Elasticsearch repositories support cannot only be activated through an XML namespace but also using an annotation through JavaConfig.
-
-.Spring Data Elasticsearch repositories using JavaConfig
-====
-[source,java]
-----
-@Configuration
-@EnableElasticsearchRepositories(basePackages = "org/springframework/data/elasticsearch/repositories")
-static class Config {
-
-    @Bean
-    public ElasticsearchOperations elasticsearchTemplate() {
-        return new ElasticsearchTemplate(nodeBuilder().local(true).node().client());
-    }
-}                
-----
-====
-
-The configuration above sets up an `Embedded Elasticsearch Server` which is used by the `ElasticsearchTemplate` . Spring Data Elasticsearch Repositories are activated using the `@EnableElasticsearchRepositories` annotation, which essentially carries the same attributes as the XML namespace does. If no base package is configured, it will use the one the configuration class resides in.
-
-[[elasticsearch.cdi]]
-=== Elasticsearch Repositores using CDI
-
-The Spring Data Elasticsearch repositories can also be set up using CDI functionality.
-
-.Spring Data Elasticsearch repositories using JavaConfig
-====
-[source,java]
-----
-class ElasticsearchTemplateProducer {
-
-    @Produces
-    @ApplicationScoped
-    public ElasticsearchOperations createElasticsearchTemplate() {
-        return new ElasticsearchTemplate(nodeBuilder().local(true).node().client());
-    }
-}
-
-class ProductService {
-
-    private ProductRepository repository;
-
-    public Page<Product> findAvailableBookByName(String name, Pageable pageable) {
-        return repository.findByAvailableTrueAndNameStartingWith(name, pageable);
-    }
-
-    @Inject
-    public void setRepository(ProductRepository repository) {
-        this.repository = repository;
-    }
-}                
-----
-====
-
-[[elasticsearch.query-methods]]
-== Query methods
-
-[[elasticsearch.query-methods.finders]]
-=== Query lookup strategies
-
-The Elasticsearch module supports all basic query building  feature as String,Abstract,Criteria or have it being derived from the method name.
-
-==== Declared queries
-
-Deriving the query from the method name is not always sufficient and/or may result in unreadable method names. In this case one might make either use of `@Query` annotation (see <<elasticsearch.query-methods.at-query>> ).
-
-[[elasticsearch.query-methods.criterions]]
-=== Query creation
-
-Generally the query creation mechanism for Elasticsearch works as described in <<repositories.query-methods>> . Here's a short example of what a Elasticsearch query method translates into: 
-
-.Query creation from method names
-====
-[source,java]
-----
-public interface BookRepository extends Repository<Book, String>
-{
-    List<Book> findByNameAndPrice(String name, Integer price);
-}                
-----
-====
-
-The method name above will be translated into the following Elasticsearch json query
-
-[source]
-----
-{ "bool" :
-    { "must" :
-        [
-            { "field" : {"name" : "?"} },
-            { "field" : {"price" : "?"} }
-        ] 
-    }
-}                    
-----
-
-A list of supported keywords for Elasticsearch is shown below. 
-
-[cols="1,2,3", options="header"]
-.Supported keywords inside method names
-|===
-| Keyword
-| Sample
-| Elasticsearch Query String| `And`
-| `findByNameAndPrice`
-| `{"bool" : {"must" : [ {"field" : {"name" : "?"}},
-                                        {"field" : {"price" : "?"}} ]}}`
-
-| `Or`
-| `findByNameOrPrice`
-| `{"bool" : {"should" : [ {"field" : {"name" : "?"}},
-                                        {"field" : {"price" : "?"}} ]}}`
-
-| `Is`
-| `findByName`
-| `{"bool" : {"must" : {"field" : {"name" : "?"}}}}`
-
-| `Not`
-| `findByNameNot`
-| `{"bool" : {"must_not" : {"field" : {"name" : "?"}}}}`
-
-| `Between`
-| `findByPriceBetween`
-| `{"bool" : {"must" : {"range" : {"price" : {"from" :
-                                        ?,"to" : ?,"include_lower" : true,"include_upper" : true}}}}}`
-
-| `LessThanEqual`
-| `findByPriceLessThan`
-| `{"bool" : {"must" : {"range" : {"price" : {"from" :
-                                        null,"to" : ?,"include_lower" : true,"include_upper" :
-                                        true}}}}}`
-
-| `GreaterThanEqual`
-| `findByPriceGreaterThan`
-| `{"bool" : {"must" : {"range" : {"price" : {"from" :
-                                        ?,"to" : null,"include_lower" : true,"include_upper" :
-                                        true}}}}}`
-
-| `Before`
-| `findByPriceBefore`
-| `{"bool" : {"must" : {"range" : {"price" : {"from" :
-                                        null,"to" : ?,"include_lower" : true,"include_upper" :
-                                        true}}}}}`
-
-| `After`
-| `findByPriceAfter`
-| `{"bool" : {"must" : {"range" : {"price" : {"from" :
-                                        ?,"to" : null,"include_lower" : true,"include_upper" :
-                                        true}}}}}`
-
-| `Like`
-| `findByNameLike`
-| `{"bool" : {"must" : {"field" : {"name" : {"query" :
-                                        "?*","analyze_wildcard" : true}}}}}`
-
-| `StartingWith`
-| `findByNameStartingWith`
-| `{"bool" : {"must" : {"field" : {"name" : {"query" :
-                                        "?*","analyze_wildcard" : true}}}}}`
-
-| `EndingWith`
-| `findByNameEndingWith`
-| `{"bool" : {"must" : {"field" : {"name" : {"query" :
-                                        "*?","analyze_wildcard" : true}}}}}`
-
-| `Contains/Containing`
-| `findByNameContaining`
-| `{"bool" : {"must" : {"field" : {"name" : {"query" :
-                                        "*?*","analyze_wildcard" : true}}}}}`
-
-| `In`
-| `findByNameIn(Collection<String>names)`
-| `{"bool" : {"must" : {"bool" : {"should" : [ {"field" :
-                                        {"name" : "?"}}, {"field" : {"name" : "?"}} ]}}}}`
-
-| `NotIn`
-| `findByNameNotIn(Collection<String>names)`
-| `{"bool" : {"must_not" : {"bool" : {"should" : {"field" :
-                                        {"name" : "?"}}}}}}`
-
-| `Near`
-| `findByStoreNear`
-| `Not Supported Yet !`
-
-| `True`
-| `findByAvailableTrue`
-| `{"bool" : {"must" : {"field" : {"available" : true}}}}`
-
-| `False`
-| `findByAvailableFalse`
-| `{"bool" : {"must" : {"field" : {"available" : false}}}}`
-
-| `OrderBy`
-| `findByAvailableTrueOrderByNameDesc`
-| `{"sort" : [{ "name" : {"order" : "desc"} }],"bool" :
-                                        {"must" : {"field" : {"available" : true}}}}`
-|===
-
-[[elasticsearch.query-methods.at-query]]
-=== Using @Query Annotation
-
-.Declare query at the method using the `@Query` annotation.
-====
-[source,java]
-----
-public interface BookRepository extends ElasticsearchRepository<Book, String> {
-    @Query("{"bool" : {"must" : {"field" : {"name" : "?0"}}}}")
-    Page<Book> findByName(String name,Pageable pageable);
-}                
-----
-====

src/main/asciidoc/reference/elasticsearch-misc.adoc

@@ -1,72 +0,0 @@
-[[elasticsearch.misc]]
-= Miscellaneous Elasticsearch Operation Support
-
-This chapter covers additional support for Elasticsearch operations that cannot be directly accessed via the repository interface. It is recommended to add those operations as custom implementation as described in <<repositories.custom-implementations>> .
-
-[[elasticsearch.misc.filter]]
-== Filter Builder
-
-Filter Builder improves query speed.
-
-====
-[source,java]
-----
-private ElasticsearchTemplate elasticsearchTemplate;
-
-SearchQuery searchQuery = new NativeSearchQueryBuilder()
-    .withQuery(matchAllQuery())
-    .withFilter(boolFilter().must(termFilter("id", documentId)))
-    .build();
-    
-Page<SampleEntity> sampleEntities =
-    elasticsearchTemplate.queryForPage(searchQuery,SampleEntity.class);            
-----
-====
-
-[[elasticsearch.scan.and.scroll]]
-== Using Scan And Scroll For Big Result Set
-
-Elasticsearch has scan and scroll feature for getting big result set in chunks. `ElasticsearchTemplate` has scan and scroll methods that can be used as below.
-
-.Using Scan and Scroll
-====
-[source,java]
-----
-SearchQuery searchQuery = new NativeSearchQueryBuilder()
-    .withQuery(matchAllQuery())
-    .withIndices("test-index")
-    .withTypes("test-type")
-    .withPageable(new PageRequest(0,1))
-    .build();
-String scrollId = elasticsearchTemplate.scan(searchQuery,1000,false);
-List<SampleEntity> sampleEntities = new ArrayList<SampleEntity>();
-boolean hasRecords = true;
-while (hasRecords){
-    Page<SampleEntity> page = elasticsearchTemplate.scroll(scrollId, 5000L , new ResultsMapper<SampleEntity>()
-    {
-        @Override
-        public Page<SampleEntity> mapResults(SearchResponse response) {
-            List<SampleEntity> chunk = new ArrayList<SampleEntity>();
-            for(SearchHit searchHit : response.getHits()){
-                if(response.getHits().getHits().length <= 0) {
-                    return null;
-                }
-                SampleEntity user = new SampleEntity();
-                user.setId(searchHit.getId());
-                user.setMessage((String)searchHit.getSource().get("message"));
-                chunk.add(user);
-            }
-            return new PageImpl<SampleEntity>(chunk);
-        }
-    });
-    if(page != null) {
-        sampleEntities.addAll(page.getContent());
-        hasRecords = page.hasNextPage();
-    }
-    else{
-        hasRecords = false;
-    }
-    }
-}            
-----
-====

src/main/java/org/springframework/data/elasticsearch/BulkFailureException.java

@@ -0,0 +1,47 @@
+/*
+ * Copyright 2020-2025 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.springframework.data.elasticsearch;
+
+import org.springframework.dao.DataRetrievalFailureException;
+
+import java.util.Map;
+
+/**
+ * @author Peter-Josef Meisch
+ * @author Illia Ulianov
+ * @since 4.1
+ */
+public class BulkFailureException extends DataRetrievalFailureException {
+	private final Map<String, FailureDetails> failedDocuments;
+
+	public BulkFailureException(String msg, Map<String, FailureDetails> failedDocuments) {
+		super(msg);
+		this.failedDocuments = failedDocuments;
+	}
+
+	public Map<String, FailureDetails> getFailedDocuments() {
+		return failedDocuments;
+	}
+
+	/**
+	 * Details about a document saving failure.
+	 *
+	 * @author Illia Ulianov
+	 * @since 5.2
+	 */
+	public record FailureDetails(Integer status, String errorMessage) {
+	}
+}

src/main/java/org/springframework/data/elasticsearch/ElasticsearchErrorCause.java

@@ -0,0 +1,78 @@
+/*
+ * Copyright 2022-2025 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.springframework.data.elasticsearch;
+
+import java.util.List;
+
+import org.jspecify.annotations.Nullable;
+
+/**
+ * Object describing an Elasticsearch error
+ *
+ * @author Peter-Josef Meisch
+ * @since 4.4
+ */
+public class ElasticsearchErrorCause {
+	@Nullable private final String type;
+
+	private final String reason;
+
+	@Nullable private final String stackTrace;
+
+	@Nullable private final ElasticsearchErrorCause causedBy;
+
+	private final List<ElasticsearchErrorCause> rootCause;
+
+	private final List<ElasticsearchErrorCause> suppressed;
+
+	public ElasticsearchErrorCause(@Nullable String type, String reason, @Nullable String stackTrace,
+			@Nullable ElasticsearchErrorCause causedBy, List<ElasticsearchErrorCause> rootCause,
+			List<ElasticsearchErrorCause> suppressed) {
+		this.type = type;
+		this.reason = reason;
+		this.stackTrace = stackTrace;
+		this.causedBy = causedBy;
+		this.rootCause = rootCause;
+		this.suppressed = suppressed;
+	}
+
+	@Nullable
+	public String getType() {
+		return type;
+	}
+
+	public String getReason() {
+		return reason;
+	}
+
+	@Nullable
+	public String getStackTrace() {
+		return stackTrace;
+	}
+
+	@Nullable
+	public ElasticsearchErrorCause getCausedBy() {
+		return causedBy;
+	}
+
+	public List<ElasticsearchErrorCause> getRootCause() {
+		return rootCause;
+	}
+
+	public List<ElasticsearchErrorCause> getSuppressed() {
+		return suppressed;
+	}
+}

src/main/java/org/springframework/data/elasticsearch/ElasticsearchException.java

@@ -1,51 +0,0 @@
-/*
- * Copyright 2013 the original author or authors.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package org.springframework.data.elasticsearch;
-
-import java.util.Map;
-
-/**
- * ElasticsearchException
- *
- * @author Rizwan Idrees
- * @author Mohsin Husen
- */
-public class ElasticsearchException extends RuntimeException {
-
-	private Map<String, String> failedDocuments;
-
-	public ElasticsearchException(String message) {
-		super(message);
-	}
-
-	public ElasticsearchException(String message, Throwable cause) {
-		super(message, cause);
-	}
-
-	public ElasticsearchException(String message, Throwable cause, Map<String, String> failedDocuments) {
-		super(message, cause);
-		this.failedDocuments = failedDocuments;
-	}
-
-	public ElasticsearchException(String message, Map<String, String> failedDocuments) {
-		super(message);
-		this.failedDocuments = failedDocuments;
-	}
-
-	public Map<String, String> getFailedDocuments() {
-		return failedDocuments;
-	}
-}

src/main/java/org/springframework/data/elasticsearch/NoSuchIndexException.java

@@ -0,0 +1,44 @@
+/*
+ * Copyright 2019-2025 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.springframework.data.elasticsearch;
+
+import org.springframework.dao.NonTransientDataAccessResourceException;
+
+/**
+ * @author Christoph Strobl
+ * @since 3.2
+ */
+public class NoSuchIndexException extends NonTransientDataAccessResourceException {
+
+	private final String index;
+
+	/**
+	 * @since 4.4
+	 */
+	public NoSuchIndexException(String index) {
+		super(String.format("Index %s not found.", index));
+		this.index = index;
+	}
+
+	public NoSuchIndexException(String index, Throwable cause) {
+		super(String.format("Index %s not found.", index), cause);
+		this.index = index;
+	}
+
+	public String getIndex() {
+		return index;
+	}
+}

src/main/java/org/springframework/data/elasticsearch/ResourceFailureException.java

@@ -0,0 +1,31 @@
+/*
+ * Copyright 2021-2025 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.springframework.data.elasticsearch;
+
+import org.springframework.core.NestedRuntimeException;
+
+/**
+ * @author Peter-Josef Meisch
+ */
+public class ResourceFailureException extends NestedRuntimeException {
+	public ResourceFailureException(String msg) {
+		super(msg);
+	}
+
+	public ResourceFailureException(String msg, Throwable cause) {
+		super(msg, cause);
+	}
+}

src/main/java/org/springframework/data/elasticsearch/ResourceNotFoundException.java

@@ -0,0 +1,29 @@
+/*
+ * Copyright 2022-2025 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.springframework.data.elasticsearch;
+
+import org.springframework.dao.NonTransientDataAccessResourceException;
+
+/**
+ * @author Peter-Josef Meisch
+ * @since 5.1
+ */
+public class ResourceNotFoundException extends NonTransientDataAccessResourceException {
+
+	public ResourceNotFoundException(String msg) {
+		super(msg);
+	}
+}

src/main/java/org/springframework/data/elasticsearch/RestStatusException.java

@@ -0,0 +1,49 @@
+/*
+ * Copyright 2021-2025 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.springframework.data.elasticsearch;
+
+import org.springframework.dao.DataAccessException;
+
+/**
+ * Exception class for REST status exceptions independent from the used client/backend.
+ *
+ * @author Peter-Josef Meisch
+ * @since 4.3
+ */
+public class RestStatusException extends DataAccessException {
+
+	// we do not use a dedicated status class from Elasticsearch, OpenSearch, Spring web or webflux here
+	private final int status;
+
+	public RestStatusException(int status, String msg) {
+		super(msg);
+		this.status = status;
+	}
+
+	public RestStatusException(int status, String msg, Throwable cause) {
+		super(msg, cause);
+		this.status = status;
+	}
+
+	public int getStatus() {
+		return status;
+	}
+
+	@Override
+	public String toString() {
+		return "RestStatusException{" + "status=" + status + "} " + super.toString();
+	}
+}

src/main/java/org/springframework/data/elasticsearch/UncategorizedElasticsearchException.java

@@ -0,0 +1,71 @@
+/*
+ * Copyright 2020-2025 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.springframework.data.elasticsearch;
+
+import org.jspecify.annotations.Nullable;
+import org.springframework.dao.UncategorizedDataAccessException;
+
+/**
+ * @author Peter-Josef Meisch
+ * @since 4.0
+ */
+public class UncategorizedElasticsearchException extends UncategorizedDataAccessException {
+
+	/**
+	 * the response status code from Elasticsearch if available
+	 *
+	 * @since 4.4
+	 */
+	@Nullable private final Integer statusCode;
+
+	/**
+	 * The response body from Elasticsearch if available
+	 *
+	 * @since 4.4
+	 */
+	@Nullable final String responseBody;
+
+	public UncategorizedElasticsearchException(String msg) {
+		this(msg, null);
+	}
+
+	public UncategorizedElasticsearchException(String msg, @Nullable Throwable cause) {
+		this(msg, null, null, cause);
+	}
+
+	public UncategorizedElasticsearchException(String msg, @Nullable Integer statusCode, @Nullable String responseBody,
+			@Nullable Throwable cause) {
+		super(msg, cause);
+		this.statusCode = statusCode;
+		this.responseBody = responseBody;
+	}
+
+	/**
+	 * @since 4.4
+	 */
+	@Nullable
+	public Integer getStatusCode() {
+		return statusCode;
+	}
+
+	/**
+	 * @since 4.4
+	 */
+	@Nullable
+	public String getResponseBody() {
+		return responseBody;
+	}
+}

src/main/java/org/springframework/data/elasticsearch/VersionConflictException.java

@@ -0,0 +1,34 @@
+/*
+ * Copyright 2023-2025 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.springframework.data.elasticsearch;
+
+import org.springframework.dao.DataIntegrityViolationException;
+
+/**
+ * Exception that is thrown when a version conflict from the server is detected.
+ *
+ * @author Peter-Josef Meisch
+ * @since 5.2
+ */
+public class VersionConflictException extends DataIntegrityViolationException {
+	public VersionConflictException(String msg) {
+		super(msg);
+	}
+
+	public VersionConflictException(String msg, Throwable cause) {
+		super(msg, cause);
+	}
+}

src/main/java/org/springframework/data/elasticsearch/annotations/Alias.java

@@ -0,0 +1,79 @@
+/*
+ * Copyright 2024-2025 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.springframework.data.elasticsearch.annotations;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Inherited;
+import java.lang.annotation.Repeatable;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+import org.springframework.core.annotation.AliasFor;
+
+/**
+ * Identifies an alias for the index.
+ *
+ * @author Youssef Aouichaoui
+ * @since 5.4
+ */
+@Inherited
+@Retention(RetentionPolicy.RUNTIME)
+@Target({ ElementType.TYPE })
+@Repeatable(Aliases.class)
+public @interface Alias {
+	/**
+	 * @return Index alias name. Alias for {@link #alias}.
+	 */
+	@AliasFor("alias")
+	String value() default "";
+
+	/**
+	 * @return Index alias name. Alias for {@link #value}.
+	 */
+	@AliasFor("value")
+	String alias() default "";
+
+	/**
+	 * @return Query used to limit documents the alias can access.
+	 */
+	Filter filter() default @Filter;
+
+	/**
+	 * @return Used to route indexing operations to a specific shard.
+	 */
+	String indexRouting() default "";
+
+	/**
+	 * @return Used to route indexing and search operations to a specific shard.
+	 */
+	String routing() default "";
+
+	/**
+	 * @return Used to route search operations to a specific shard.
+	 */
+	String searchRouting() default "";
+
+	/**
+	 * @return Is the alias hidden?
+	 */
+	boolean isHidden() default false;
+
+	/**
+	 * @return Is it the 'write index' for the alias?
+	 */
+	boolean isWriteIndex() default false;
+}

src/main/java/org/springframework/data/elasticsearch/annotations/Aliases.java

@@ -0,0 +1,36 @@
+/*
+ * Copyright 2024-2025 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.springframework.data.elasticsearch.annotations;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Inherited;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * Container annotation that aggregates several {@link Alias} annotations.
+ *
+ * @author Youssef Aouichaoui
+ * @see Alias
+ * @since 5.4
+ */
+@Inherited
+@Retention(RetentionPolicy.RUNTIME)
+@Target({ ElementType.TYPE })
+public @interface Aliases {
+	Alias[] value();
+}

src/main/java/org/springframework/data/elasticsearch/annotations/CompletionContext.java

@@ -0,0 +1,61 @@
+/*
+ * Copyright 2019-2025 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.springframework.data.elasticsearch.annotations;
+
+import java.lang.annotation.Documented;
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Inherited;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * Based on reference doc - https://www.elastic.co/guide/en/elasticsearch/reference/current/suggester-context.html
+ *
+ * @author Robert Gruendler
+ * @author Peter-Josef Meisch
+ */
+@Retention(RetentionPolicy.RUNTIME)
+@Target(ElementType.FIELD)
+@Documented
+@Inherited
+public @interface CompletionContext {
+
+	String name();
+
+	ContextMappingType type();
+
+	String precision() default "";
+
+	String path() default "";
+
+	/**
+	 * @since 4.3
+	 */
+	enum ContextMappingType {
+		CATEGORY("category"), GEO("geo");
+
+		private final String mappedName;
+
+		ContextMappingType(String mappedName) {
+			this.mappedName = mappedName;
+		}
+
+		public String getMappedName() {
+			return mappedName;
+		}
+	}
+}

src/main/java/org/springframework/data/elasticsearch/annotations/CompletionContextType.java

@@ -0,0 +1,12 @@
+package org.springframework.data.elasticsearch.annotations;
+
+/**
+ * Based on reference doc - https://www.elastic.co/guide/en/elasticsearch/reference/current/suggester-context.html
+ *
+ * @author Robert Gruendler
+ */
+public enum CompletionContextType {
+
+	CATEGORY, GEO
+
+}

src/main/java/org/springframework/data/elasticsearch/annotations/CompletionField.java

@@ -1,11 +1,11 @@
 /*
- * Copyright 2013 the original author or authors.
+ * Copyright 2013-2025 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
- *      http://www.apache.org/licenses/LICENSE-2.0
+ *      https://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
@@ -15,15 +15,23 @@
  */
 package org.springframework.data.elasticsearch.annotations;
 
-import java.lang.annotation.*;
+import java.lang.annotation.Documented;
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Inherited;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
 
 /**
- * Based on the reference doc - http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-suggesters-completion.html
+ * Based on the reference doc -
+ * https://www.elastic.co/guide/en/elasticsearch/reference/current/search-suggesters-completion.html
  *
  * @author Mewes Kochheim
+ * @author Robert Gruendler
+ * @author Peter-Josef Meisch
  */
 @Retention(RetentionPolicy.RUNTIME)
-@Target(ElementType.FIELD)
+@Target({ ElementType.FIELD, ElementType.ANNOTATION_TYPE })
 @Documented
 @Inherited
 public @interface CompletionField {
@@ -32,11 +40,11 @@ public @interface CompletionField {
 
 	String analyzer() default "simple";
 
-	boolean payloads() default false;
-
 	boolean preserveSeparators() default true;
 
 	boolean preservePositionIncrements() default true;
 
 	int maxInputLength() default 50;
+
+	CompletionContext[] contexts() default {};
 }

src/main/java/org/springframework/data/elasticsearch/annotations/CountQuery.java

@@ -0,0 +1,39 @@
+/*
+ * Copyright 2021-2025 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.springframework.data.elasticsearch.annotations;
+
+import java.lang.annotation.Documented;
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+import org.springframework.core.annotation.AliasFor;
+
+/**
+ * Alias for a @Query annotation with the count parameter set to true.
+ *
+ * @author Peter-Josef Meisch
+ */
+@Retention(RetentionPolicy.RUNTIME)
+@Target({ ElementType.METHOD, ElementType.ANNOTATION_TYPE })
+@Documented
+@Query(count = true)
+public @interface CountQuery {
+
+	@AliasFor(annotation = Query.class)
+	String value() default "";
+}

src/main/java/org/springframework/data/elasticsearch/annotations/DateFormat.java

@@ -1,11 +1,11 @@
 /*
- * Copyright 2014 the original author or authors.
+ * Copyright 2014-2025 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
- *      http://www.apache.org/licenses/LICENSE-2.0
+ *      https://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
@@ -16,16 +16,207 @@
 package org.springframework.data.elasticsearch.annotations;
 
 /**
+ * Values based on <a href="https://www.elastic.co/guide/reference/mapping/date-format/">Elasticsearch reference
+ * documentation</a>. The patterns are taken from this documentation and slightly adapted so that a Java
+ * {@link java.time.format.DateTimeFormatter} produces the same values as the Elasticsearch formatter. Use
+ * <code>format = {}</code> to disable built-in date formats in the {@link Field} annotation. If you want to use only a
+ * custom date format pattern, you must set the <code>format</code> property to empty <code>{}</code>.
+ *
  * @author Jakub Vavrik
- *         Values based on reference doc - http://www.elasticsearch.org/guide/reference/mapping/date-format/
+ * @author Tim te Beek
+ * @author Peter-Josef Meisch
+ * @author Sascha Woo
  */
 public enum DateFormat {
-	none, custom, basic_date, basic_date_time, basic_date_time_no_millis, basic_ordinal_date, basic_ordinal_date_time,
-	basic_ordinal_date_time_no_millis, basic_time, basic_time_no_millis, basic_t_time, basic_t_time_no_millis,
-	basic_week_date, basic_week_date_time, basic_week_date_time_no_millis, date, date_hour, date_hour_minute,
-	date_hour_minute_second, date_hour_minute_second_fraction, date_hour_minute_second_millis, date_optional_time,
-	date_time, date_time_no_millis, hour, hour_minute, hour_minute_second, hour_minute_second_fraction,
-	hour_minute_second_millis, ordinal_date, ordinal_date_time, ordinal_date_time_no_millis, time, time_no_millis,
-	t_time, t_time_no_millis, week_date, week_date_time, weekDateTimeNoMillis, week_year, weekyearWeek,
-	weekyearWeekDay, year, year_month, year_month_day
+	basic_date("uuuuMMdd"), //
+	basic_date_time("uuuuMMdd'T'HHmmss.SSSXXX"), //
+	basic_date_time_no_millis("uuuuMMdd'T'HHmmssXXX"), //
+	basic_ordinal_date("uuuuDDD"), //
+	basic_ordinal_date_time("yyyyDDD'T'HHmmss.SSSXXX"), //
+	basic_ordinal_date_time_no_millis("yyyyDDD'T'HHmmssXXX"), //
+	basic_time("HHmmss.SSSXXX"), //
+	basic_time_no_millis("HHmmssXXX"), //
+	basic_t_time("'T'HHmmss.SSSXXX"), //
+	basic_t_time_no_millis("'T'HHmmssXXX"), //
+	basic_week_date("YYYY'W'wwe"), // week-based-year!
+	/**
+	 * @since 5.3
+	 */
+	strict_basic_week_date("YYYY'W'wwe"), // week-based-year!
+	basic_week_date_time("YYYY'W'wwe'T'HHmmss.SSSX"), // here Elasticsearch uses a different zone format
+	/**
+	 * @since 5.3
+	 */
+	strict_basic_week_date_time("YYYY'W'wwe'T'HHmmss.SSSX"), // here Elasticsearch uses a different zone format
+	basic_week_date_time_no_millis("YYYY'W'wwe'T'HHmmssX"), //
+	/**
+	 * @since 5.3
+	 */
+	strict_basic_week_date_time_no_millis("YYYY'W'wwe'T'HHmmssX"), //
+	date("uuuu-MM-dd"), //
+	/**
+	 * @since 5.3
+	 */
+	strict_date("uuuu-MM-dd"), //
+	date_hour("uuuu-MM-dd'T'HH"), //
+	/**
+	 * @since 5.3
+	 */
+	strict_date_hour("uuuu-MM-dd'T'HH"), //
+	date_hour_minute("uuuu-MM-dd'T'HH:mm"), //
+	/**
+	 * @since 5.3
+	 */
+	strict_date_hour_minute("uuuu-MM-dd'T'HH:mm"), //
+	date_hour_minute_second("uuuu-MM-dd'T'HH:mm:ss"), //
+	/**
+	 * @since 5.3
+	 */
+	strict_date_hour_minute_second("uuuu-MM-dd'T'HH:mm:ss"), //
+	date_hour_minute_second_fraction("uuuu-MM-dd'T'HH:mm:ss.SSS"), //
+	/**
+	 * @since 5.3
+	 */
+	strict_date_hour_minute_second_fraction("uuuu-MM-dd'T'HH:mm:ss.SSS"), //
+	date_hour_minute_second_millis("uuuu-MM-dd'T'HH:mm:ss.SSS"), //
+	/**
+	 * @since 5.3
+	 */
+	strict_date_hour_minute_second_millis("uuuu-MM-dd'T'HH:mm:ss.SSS"), //
+	date_optional_time("uuuu-MM-dd['T'HH:mm:ss.SSSXXX]"), //
+	/**
+	 * @since 5.3
+	 */
+	strict_date_optional_time("uuuu-MM-dd['T'HH:mm:ss.SSSXXX]"), //
+	strict_date_optional_time_nanos("uuuu-MM-dd['T'HH:mm:ss.SSSSSSXXX]"), //
+	date_time("uuuu-MM-dd'T'HH:mm:ss.SSSXXX"), //
+	/**
+	 * @since 5.3
+	 */
+	strict_date_time("uuuu-MM-dd'T'HH:mm:ss.SSSXXX"), //
+	date_time_no_millis("uuuu-MM-dd'T'HH:mm:ssVV"), // here Elasticsearch uses the zone-id in its implementation
+	/**
+	 * @since 5.3
+	 */
+	strict_date_time_no_millis("uuuu-MM-dd'T'HH:mm:ssVV"), // here Elasticsearch uses the zone-id in its implementation
+	epoch_millis("epoch_millis"), //
+	epoch_second("epoch_second"), //
+	hour("HH"), //
+	/**
+	 * @since 5.3
+	 */
+	strict_hour("HH"), //
+	hour_minute("HH:mm"), //
+	/**
+	 * @since 5.3
+	 */
+	strict_hour_minute("HH:mm"), //
+	hour_minute_second("HH:mm:ss"), //
+	/**
+	 * @since 5.3
+	 */
+	strict_hour_minute_second("HH:mm:ss"), //
+	hour_minute_second_fraction("HH:mm:ss.SSS"), //
+	/**
+	 * @since 5.3
+	 */
+	strict_hour_minute_second_fraction("HH:mm:ss.SSS"), //
+	hour_minute_second_millis("HH:mm:ss.SSS"), //
+	/**
+	 * @since 5.3
+	 */
+	strict_hour_minute_second_millis("HH:mm:ss.SSS"), //
+	ordinal_date("uuuu-DDD"), //
+	/**
+	 * @since 5.3
+	 */
+	strict_ordinal_date("uuuu-DDD"), //
+	ordinal_date_time("uuuu-DDD'T'HH:mm:ss.SSSXXX"), //
+	/**
+	 * @since 5.3
+	 */
+	strict_ordinal_date_time("uuuu-DDD'T'HH:mm:ss.SSSXXX"), //
+	ordinal_date_time_no_millis("uuuu-DDD'T'HH:mm:ssXXX"), //
+	/**
+	 * @since 5.3
+	 */
+	strict_ordinal_date_time_no_millis("uuuu-DDD'T'HH:mm:ssXXX"), //
+	time("HH:mm:ss.SSSXXX"), //
+	/**
+	 * @since 5.3
+	 */
+	strict_time("HH:mm:ss.SSSXXX"), //
+	time_no_millis("HH:mm:ssXXX"), //
+	/**
+	 * @since 5.3
+	 */
+	strict_time_no_millis("HH:mm:ssXXX"), //
+	t_time("'T'HH:mm:ss.SSSXXX"), //
+	/**
+	 * @since 5.3
+	 */
+	strict_t_time("'T'HH:mm:ss.SSSXXX"), //
+	t_time_no_millis("'T'HH:mm:ssXXX"), //
+	/**
+	 * @since 5.3
+	 */
+	strict_t_time_no_millis("'T'HH:mm:ssXXX"), //
+	week_date("YYYY-'W'ww-e"), //
+	/**
+	 * @since 5.3
+	 */
+	strict_week_date("YYYY-'W'ww-e"), //
+	week_date_time("YYYY-'W'ww-e'T'HH:mm:ss.SSSXXX"), //
+	/**
+	 * @since 5.3
+	 */
+	strict_week_date_time("YYYY-'W'ww-e'T'HH:mm:ss.SSSXXX"), //
+	week_date_time_no_millis("YYYY-'W'ww-e'T'HH:mm:ssXXX"), //
+	/**
+	 * @since 5.3
+	 */
+	strict_week_date_time_no_millis("YYYY-'W'ww-e'T'HH:mm:ssXXX"), //
+	weekyear(""), // no TemporalAccessor available for these 3
+	/**
+	 * @since 5.3
+	 */
+	strict_weekyear(""), // no TemporalAccessor available for these 3
+	weekyear_week(""), //
+	/**
+	 * @since 5.3
+	 */
+	strict_weekyear_week(""), //
+	weekyear_week_day(""), //
+	/**
+	 * @since 5.3
+	 */
+	strict_strict_weekyear_week_day(""), //
+	year("uuuu"), //
+	/**
+	 * @since 5.3
+	 */
+	strict_year("uuuu"), //
+	year_month("uuuu-MM"), //
+	/**
+	 * @since 5.3
+	 */
+	strict_year_month("uuuu-MM"), //
+	year_month_day("uuuu-MM-dd"), //
+	/**
+	 * @since 5.3
+	 */
+	strict_year_month_day("uuuu-MM-dd"); //
+
+	private final String pattern;
+
+	DateFormat(String pattern) {
+		this.pattern = pattern;
+	}
+
+	/**
+	 * @since 4.2
+	 */
+	public String getPattern() {
+		return pattern;
+	}
 }

src/main/java/org/springframework/data/elasticsearch/annotations/Document.java

@@ -1,51 +1,132 @@
-/*
- * Copyright 2013 the original author or authors.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package org.springframework.data.elasticsearch.annotations;
-
-import java.lang.annotation.*;
-
-import org.springframework.data.annotation.Persistent;
-
-/**
- * Document
- *
- * @author Rizwan Idrees
- * @author Mohsin Husen
- * @author Mason Chan
- */
-
-@Persistent
-@Inherited
-@Retention(RetentionPolicy.RUNTIME)
-@Target({ElementType.TYPE})
-public @interface Document {
-
-	String indexName();
-
-	String type() default "";
-
-	boolean useServerConfiguration() default false;
-
-	short shards() default 5;
-
-	short replicas() default 1;
-
-	String refreshInterval() default "1s";
-
-	String indexStoreType() default "fs";
-
-	boolean createIndex() default true;
-}
+/*
+ * Copyright 2013-2025 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.springframework.data.elasticsearch.annotations;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Inherited;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+import org.springframework.data.annotation.Persistent;
+
+/**
+ * Identifies a domain object to be persisted to Elasticsearch.
+ *
+ * @author Rizwan Idrees
+ * @author Mohsin Husen
+ * @author Mason Chan
+ * @author Ivan Greene
+ * @author Mark Paluch
+ * @author Peter-Josef Meisch
+ * @author Sascha Woo
+ */
+@Persistent
+@Inherited
+@Retention(RetentionPolicy.RUNTIME)
+@Target({ ElementType.TYPE })
+public @interface Document {
+
+	/**
+	 * Name of the Elasticsearch index.
+	 * <ul>
+	 * <li>Lowercase only</li>
+	 * <li>Cannot include \, /, *, ?, ", &gt;, &lt;, |, ` ` (space character), ,, #</li>
+	 * <li>Cannot start with -, _, +</li>
+	 * <li>Cannot be . or ..</li>
+	 * <li>Cannot be longer than 255 bytes (note it is bytes, so multi-byte characters will count towards the 255 limit
+	 * faster)</li>
+	 * </ul>
+	 */
+	String indexName();
+
+	/**
+	 * Configuration whether to create an index on repository bootstrapping.
+	 */
+	boolean createIndex() default true;
+
+	/**
+	 * If true, the index mapping will be written on repository bootstrapping even when the index already exists. This
+	 * allows for automatically updating the mapping with new properties. Changes on existing properties will lead to an
+	 * error from the Elasticsearch server.
+	 */
+	boolean alwaysWriteMapping() default false;
+
+	/**
+	 * Configuration of version management.
+	 */
+	VersionType versionType() default VersionType.EXTERNAL;
+
+	/**
+	 * Defines if type hints should be written. {@see WriteTypeHint}.
+	 *
+	 * @since 4.3
+	 */
+	WriteTypeHint writeTypeHint() default WriteTypeHint.DEFAULT;
+
+	/**
+	 * Controls how Elasticsearch dynamically adds fields to the document.
+	 *
+	 * @since 4.3
+	 */
+	Dynamic dynamic() default Dynamic.INHERIT;
+
+	/**
+	 * Specifies if the id property should also be stored in the Elasticsearch document source. Default value is
+	 * {@literal true}
+	 *
+	 * @since 5.1
+	 */
+	boolean storeIdInSource() default true;
+
+	/**
+	 * Specifies if the version property should also be stored in the Elasticsearch document source. Default value is
+	 * true.
+	 *
+	 * @since 5.1
+	 */
+	boolean storeVersionInSource() default true;
+
+	/**
+	 * Aliases for the index.
+	 *
+	 * @since 5.4
+	 */
+	Alias[] aliases() default {};
+
+	/**
+	 * @since 4.3
+	 */
+	enum VersionType {
+		INTERNAL("internal"), //
+		EXTERNAL("external"), //
+		EXTERNAL_GTE("external_gte"), //
+		/**
+		 * @since 4.4
+		 */
+		FORCE("force");
+
+		private final String esName;
+
+		VersionType(String esName) {
+			this.esName = esName;
+		}
+
+		public String getEsName() {
+			return esName;
+		}
+	}
+}

src/main/java/org/springframework/data/elasticsearch/annotations/Dynamic.java

@@ -0,0 +1,60 @@
+/*
+ * Copyright 2021-2025 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.springframework.data.elasticsearch.annotations;
+
+/**
+ * Values for the {@code dynamic} mapping parameter.
+ *
+ * @author Sascha Woo
+ * @since 4.3
+ */
+public enum Dynamic {
+	/**
+	 * New fields are added to the mapping.
+	 */
+	TRUE("true"),
+	/**
+	 * New fields are added to the mapping as
+	 * <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/runtime.html">runtime fields</a>. These
+	 * fields are not indexed, and are loaded from {@code _source} at query time.
+	 */
+	RUNTIME("runtime"),
+	/**
+	 * New fields are ignored. These fields will not be indexed or searchable, but will still appear in the
+	 * {@code _source} field of returned hits. These fields will not be added to the mapping, and new fields must be added
+	 * explicitly.
+	 */
+	FALSE("false"),
+	/**
+	 * If new fields are detected, an exception is thrown and the document is rejected. New fields must be explicitly
+	 * added to the mapping.
+	 */
+	STRICT("strict"),
+	/**
+	 * Inherit the dynamic setting from their parent object or from the mapping type.
+	 */
+	INHERIT("inherit");
+
+	private final String mappedName;
+
+	Dynamic(String mappedName) {
+		this.mappedName = mappedName;
+	}
+
+	public String getMappedName() {
+		return mappedName;
+	}
+}

src/main/java/org/springframework/data/elasticsearch/annotations/DynamicTemplates.java

@@ -0,0 +1,25 @@
+package org.springframework.data.elasticsearch.annotations;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Inherited;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+import org.springframework.data.annotation.Persistent;
+
+/**
+ * Elasticsearch dynamic templates mapping. This annotation is handy if you prefer apply dynamic templates on fields
+ * with annotation e.g. {@link Field} with type = FieldType.Object etc. instead of static mapping on Document via
+ * {@link Mapping} annotation. DynamicTemplates annotation is omitted if {@link Mapping} annotation is used.
+ *
+ * @author Petr Kukral
+ */
+@Persistent
+@Inherited
+@Retention(RetentionPolicy.RUNTIME)
+@Target({ ElementType.TYPE })
+public @interface DynamicTemplates {
+
+	String mappingPath() default "";
+}

src/main/java/org/springframework/data/elasticsearch/annotations/Field.java

@@ -1,56 +1,255 @@
-/*
- * Copyright 2013 the original author or authors.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package org.springframework.data.elasticsearch.annotations;
-
-import java.lang.annotation.Documented;
-import java.lang.annotation.ElementType;
-import java.lang.annotation.Inherited;
-import java.lang.annotation.Retention;
-import java.lang.annotation.RetentionPolicy;
-import java.lang.annotation.Target;
-
-/**
- * @author Rizwan Idrees
- * @author Mohsin Husen
- * @author Artur Konczak
- * @author Jonathan Yan
- * @author Jakub Vavrik
- * @author Kevin Leturc
- */
-@Retention(RetentionPolicy.RUNTIME)
-@Target(ElementType.FIELD)
-@Documented
-@Inherited
-public @interface Field {
-
-	FieldType type() default FieldType.Auto;
-
-	FieldIndex index() default FieldIndex.analyzed;
-
-	DateFormat format() default DateFormat.none;
-
-	String pattern() default "";
-
-	boolean store() default false;
-
-	String searchAnalyzer() default "";
-
-	String analyzer() default "";
-
-	String[] ignoreFields() default {};
-
-	boolean includeInParent() default false;
-}
+/*
+ * Copyright 2013-2025 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.springframework.data.elasticsearch.annotations;
+
+import java.lang.annotation.Documented;
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Inherited;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+import org.springframework.core.annotation.AliasFor;
+
+/**
+ * @author Rizwan Idrees
+ * @author Mohsin Husen
+ * @author Artur Konczak
+ * @author Jonathan Yan
+ * @author Jakub Vavrik
+ * @author Kevin Leturc
+ * @author Peter-Josef Meisch
+ * @author Xiao Yu
+ * @author Aleksei Arsenev
+ * @author Brian Kimmig
+ * @author Morgan Lutz
+ * @author Sascha Woo
+ * @author Haibo Liu
+ * @author Andriy Redko
+ */
+@Retention(RetentionPolicy.RUNTIME)
+@Target({ ElementType.FIELD, ElementType.ANNOTATION_TYPE, ElementType.METHOD })
+@Documented
+@Inherited
+public @interface Field {
+
+	/**
+	 * Alias for {@link #name}.
+	 *
+	 * @since 3.2
+	 */
+	@AliasFor("name")
+	String value() default "";
+
+	/**
+	 * The <em>name</em> to be used to store the field inside the document. If not set, the name of the annotated property
+	 * is used.
+	 *
+	 * @since 3.2
+	 */
+	@AliasFor("value")
+	String name() default "";
+
+	FieldType type() default FieldType.Auto;
+
+	boolean index() default true;
+
+	DateFormat[] format() default { DateFormat.date_optional_time, DateFormat.epoch_millis };
+
+	String[] pattern() default {};
+
+	boolean store() default false;
+
+	boolean fielddata() default false;
+
+	String searchAnalyzer() default "";
+
+	String analyzer() default "";
+
+	String normalizer() default "";
+
+	String[] ignoreFields() default {};
+
+	boolean includeInParent() default false;
+
+	String[] copyTo() default {};
+
+	/**
+	 * @since 4.0
+	 */
+	int ignoreAbove() default -1;
+
+	/**
+	 * @since 4.0
+	 */
+	boolean coerce() default true;
+
+	/**
+	 * @since 4.0
+	 */
+	boolean docValues() default true;
+
+	/**
+	 * @since 4.0
+	 */
+	boolean ignoreMalformed() default false;
+
+	/**
+	 * @since 4.0
+	 */
+	IndexOptions indexOptions() default IndexOptions.none;
+
+	/**
+	 * @since 4.0
+	 */
+	boolean indexPhrases() default false;
+
+	/**
+	 * implemented as array to enable the empty default value
+	 *
+	 * @since 4.0
+	 */
+	IndexPrefixes[] indexPrefixes() default {};
+
+	/**
+	 * @since 4.0
+	 */
+	boolean norms() default true;
+
+	/**
+	 * NOte that null_value setting are not supported in Elasticsearch for all types. For example setting a null_value on
+	 * a field with type text will throw an exception in the server when the mapping is written to Elasticsearch. Alas,
+	 * the Elasticsearch documentation does not specify on which types it is allowed on which it is not.
+	 *
+	 * @since 4.0
+	 */
+	String nullValue() default "";
+
+	/**
+	 * @since 4.0
+	 */
+	int positionIncrementGap() default -1;
+
+	/**
+	 * @since 4.0
+	 */
+	String similarity() default Similarity.Default;
+
+	/**
+	 * @since 4.0
+	 */
+	TermVector termVector() default TermVector.none;
+
+	/**
+	 * @since 4.0
+	 */
+	double scalingFactor() default 1;
+
+	/**
+	 * @since 4.0
+	 */
+	int maxShingleSize() default -1;
+
+	/**
+	 * if true, the field will be stored in Elasticsearch even if it has a null value
+	 *
+	 * @since 4.1
+	 */
+	boolean storeNullValue() default false;
+
+	/**
+	 * to be used in combination with {@link FieldType#Rank_Feature}
+	 *
+	 * @since 4.1
+	 */
+	boolean positiveScoreImpact() default true;
+
+	/**
+	 * to be used in combination with {@link FieldType#Object}
+	 *
+	 * @since 4.1
+	 */
+	boolean enabled() default true;
+
+	/**
+	 * @since 4.1
+	 */
+	boolean eagerGlobalOrdinals() default false;
+
+	/**
+	 * @since 4.1
+	 */
+	NullValueType nullValueType() default NullValueType.String;
+
+	/**
+	 * to be used in combination with {@link FieldType#Dense_Vector}
+	 *
+	 * @since 4.2
+	 */
+	int dims() default -1;
+
+	/**
+	 * to be used in combination with {@link FieldType#Dense_Vector}
+	 *
+	 * @since 5.4
+	 */
+	String elementType() default FieldElementType.DEFAULT;
+
+	/**
+	 * to be used in combination with {@link FieldType#Dense_Vector}
+	 *
+	 * @since 5.4
+	 */
+	KnnSimilarity knnSimilarity() default KnnSimilarity.DEFAULT;
+
+	/**
+	 * to be used in combination with {@link FieldType#Dense_Vector}
+	 *
+	 * @since 5.4
+	 */
+	KnnIndexOptions[] knnIndexOptions() default {};
+
+	/**
+	 * Controls how Elasticsearch dynamically adds fields to the inner object within the document.<br>
+	 * To be used in combination with {@link FieldType#Object} or {@link FieldType#Nested}
+	 *
+	 * @since 4.3
+	 */
+	Dynamic dynamic() default Dynamic.INHERIT;
+
+	/**
+	 * marks this field to be excluded from the _source in Elasticsearch
+	 * (https://www.elastic.co/guide/en/elasticsearch/reference/7.15/mapping-source-field.html#include-exclude)
+	 *
+	 * @since 4.3
+	 */
+	boolean excludeFromSource() default false;
+
+	/**
+	 * when this field is a {{@link String}}, a {{@link java.util.Collection}} or a {{@link java.util.Map}} that is empty
+	 * this property controlls whether the empty value is sent to Elasticsearch.
+	 *
+	 * @since 5.1
+	 */
+	boolean storeEmptyValue() default true;
+
+	/**
+	 * overrides the field type in the mapping which otherwise will be taken from corresponding {@link FieldType}
+	 *
+	 * @since 5.4
+	 */
+	String mappedTypeName() default "";
+}

src/main/java/org/springframework/data/elasticsearch/annotations/FieldElementType.java

@@ -0,0 +1,26 @@
+/*
+ * Copyright 2024-2025 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.springframework.data.elasticsearch.annotations;
+
+/**
+ * @author Haibo Liu
+ * @since 5.4
+ */
+public final class FieldElementType {
+	public final static String DEFAULT = "";
+	public final static String FLOAT = "float";
+	public final static String BYTE = "byte";
+}

src/main/java/org/springframework/data/elasticsearch/annotations/FieldType.java

@@ -1,11 +1,11 @@
 /*
- * Copyright 2013 the original author or authors.
+ * Copyright 2013-2025 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
- *      http://www.apache.org/licenses/LICENSE-2.0
+ *      https://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
@@ -19,7 +19,82 @@ package org.springframework.data.elasticsearch.annotations;
  * @author Rizwan Idrees
  * @author Mohsin Husen
  * @author Artur Konczak
+ * @author Zeng Zetang
+ * @author Peter-Josef Meisch
+ * @author Aleksei Arsenev
+ * @author Brian Kimmig
+ * @author Morgan Lutz
  */
 public enum FieldType {
-	String, Integer, Long, Date, Float, Double, Boolean, Object, Auto, Nested, Ip, Attachment
+	Auto("auto"), //
+	Text("text"), //
+	Keyword("keyword"), //
+	Long("long"), //
+	Integer("integer"), //
+	Short("short"), //
+	Byte("byte"), //
+	Double("double"), //
+	Float("float"), //
+	Half_Float("half_float"), //
+	Scaled_Float("scaled_float"), //
+	Date("date"), //
+	Date_Nanos("date_nanos"), //
+	Boolean("boolean"), //
+	Binary("binary"), //
+	Integer_Range("integer_range"), //
+	Float_Range("float_range"), //
+	Long_Range("long_range"), //
+	Double_Range("double_range"), //
+	Date_Range("date_range"), //
+	Ip_Range("ip_range"), //
+	Object("object"), //
+	Nested("nested"), //
+	Ip("ip"), //
+	TokenCount("token_count"), //
+	Percolator("percolator"), //
+	Flattened("flattened"), //
+	Search_As_You_Type("search_as_you_type"), //
+	/** @since 4.1 */
+	Rank_Feature("rank_feature"), //
+	/** @since 4.1 */
+	Rank_Features("rank_features"), //
+	/** since 4.2 */
+	Wildcard("wildcard"), //
+	/** @since 4.2 */
+	Dense_Vector("dense_vector"), //
+	/**
+	 * @since 5.2
+	 */
+	Constant_Keyword("constant_keyword"), //
+	/**
+	 * @since 5.2
+	 */
+	Alias("alias"), //
+	/**
+	 * @since 5.2
+	 */
+	Version("version"), //
+	/**
+	 * @since 5.2
+	 */
+	Murmur3("murmur3"), //
+	/**
+	 * @since 5.2
+	 */
+	Match_Only_Text("match_only_text"), //
+	/**
+	 * @since 5.2
+	 */
+	Annotated_Text("annotated_text") //
+	;
+
+	private final String mappedName;
+
+	FieldType(String mappedName) {
+		this.mappedName = mappedName;
+	}
+
+	public String getMappedName() {
+		return mappedName;
+	}
 }

src/main/java/org/springframework/data/elasticsearch/annotations/Filter.java

@@ -0,0 +1,38 @@
+/*
+ * Copyright 2024-2025 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.springframework.data.elasticsearch.annotations;
+
+import org.springframework.core.annotation.AliasFor;
+
+/**
+ * Query used to limit documents.
+ *
+ * @author Youssef Aouichaoui
+ * @since 5.4
+ */
+public @interface Filter {
+	/**
+	 * @return Query used to limit documents. Alias for {@link #query}.
+	 */
+	@AliasFor("query")
+	String value() default "";
+
+	/**
+	 * @return Query used to limit documents. Alias for {@link #value}.
+	 */
+	@AliasFor("value")
+	String query() default "";
+}

src/main/java/org/springframework/data/elasticsearch/annotations/GeoPointField.java

@@ -1,11 +1,11 @@
 /*
- * Copyright 2013 the original author or authors.
+ * Copyright 2013-2025 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
- *      http://www.apache.org/licenses/LICENSE-2.0
+ *      https://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
@@ -25,8 +25,4 @@ import java.lang.annotation.*;
 @Documented
 public @interface GeoPointField {
 
-        boolean geoHashPrefix() default false;
-
-        String geoHashPrecision() default "0";
-
 }