repositories
- element looks up Spring Data repositories as described in
- Transport Client
- or
- Node Client
- element registers an instance of
- Elasticsearch Server
- in the context.
-
- jpa
- in favor of
- e.g.
- mongodb
- .
- query-lookup-strategy
- attribute. However, It might be the
- case that some of the strategies are not supported for specific
- datastores. Here are your options:
- CREATE
- and
- USE_DECLARED_QUERY
- . It will try to lookup a
- declared query first but create a custom method name based query if
- no declared query was found. This is the default lookup strategy and
- thus will be used if you don't configure anything explicitly. It
- allows quick query definition by method names but also custom
- tuning
- of these queries by introducing declared queries as needed.
- findBy
- ,
- find
- ,
- readBy
- ,
- read
- ,
- getBy
- as well as
- get
- from the method and
- start parsing the rest of it. At a very basic level you can define
- conditions on entity properties and concatenate them with
- AND
- and
- OR
- .
- x.address.zipCode
- . The resolution algorithm starts with
- interpreting the entire part (
- addressZip
- property as well. Then our algorithm would match in the first
- split
- round already and essentially choose the wrong property and finally
- fail (as the type of
- Pageable
- instance to the query method to dynamically add paging to your
- statically defined query.
- Sorting
- options are handed via
- the
- Sort
- parameter to your method.
- As you also can see, simply returning a
- userRepository
- . The
- base-package
- attribute allows the use of wildcards, so that you can have a
- pattern
- of scanned packages.
- <include-filter />
- and
- <exclude-filter />
- elements inside
- <repositories />
- . The semantics are exactly
- equivalent to the elements in Spring's context namespace. For
- details see
- repository-impl-postfix
- to the classname. This suffix
- defaults to
- Impl
- .
- <repositories
- />
- namespace is to provide an implementation for all
- interfaces that fall under the
- base-package
- . This means
- that if left in it's current state, an implementation instance of
- base-package
- .
- factory-class
- attribute of the Spring
- namespace to tell the repository infrastructure to use your custom
- factory implementation.
- ${qualifier}_
- . So a method signature like
- this:
- foo_page
- and
- bar_page
- and the according subproperties.
- _class
- attribute of the JSON document. We will
- eventually select the appropriate repository being able to handle the
- object just deserialized.
-
-
- Authors
- -
- 
-
-
- Authors
- -format = {} 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 format property to empty {}.
+ *
+ * @author Jakub Vavrik
+ * @author Tim te Beek
+ * @author Peter-Josef Meisch
+ * @author Sascha Woo
+ */
+public enum DateFormat {
+ 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;
+ }
+}
diff --git a/src/main/java/org/springframework/data/elasticsearch/annotations/Document.java b/src/main/java/org/springframework/data/elasticsearch/annotations/Document.java
index 4299759f4e..1131b2cd59 100644
--- a/src/main/java/org/springframework/data/elasticsearch/annotations/Document.java
+++ b/src/main/java/org/springframework/data/elasticsearch/annotations/Document.java
@@ -1,46 +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 org.springframework.data.annotation.Persistent;
-
-import java.lang.annotation.*;
-
-/**
- * Document
- *
- * @author Rizwan Idrees
- * @author Mohsin Husen
- */
-
-@Persistent
-@Inherited
-@Retention(RetentionPolicy.RUNTIME)
-@Target({ ElementType.TYPE })
-public @interface Document {
-
- String indexName();
-
- String type() default "";
-
- short shards() default 5;
-
- short replicas() default 1;
-
- String refreshInterval() default "1s";
-
- String indexStoreType() default "fs";
-}
+/*
+ * 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.
+ * -
+ *
- Lowercase only + *
- Cannot include \, /, *, ?, ", >, <, |, ` ` (space character), ,, # + *
- Cannot start with -, _, + + *
- Cannot be . or .. + *
- Cannot be longer than 255 bytes (note it is bytes, so multi-byte characters will count towards the 255 limit + * faster) + *
+ * 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 ""; +} diff --git a/src/main/java/org/springframework/data/elasticsearch/annotations/FieldElementType.java b/src/main/java/org/springframework/data/elasticsearch/annotations/FieldElementType.java new file mode 100644 index 0000000000..49271764ba --- /dev/null +++ b/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"; +} diff --git a/src/main/java/org/springframework/data/elasticsearch/annotations/FieldIndex.java b/src/main/java/org/springframework/data/elasticsearch/annotations/FieldIndex.java deleted file mode 100644 index 6031c59225..0000000000 --- a/src/main/java/org/springframework/data/elasticsearch/annotations/FieldIndex.java +++ /dev/null @@ -1,7 +0,0 @@ -package org.springframework.data.elasticsearch.annotations; - -/** - */ -public enum FieldIndex { - not_analyzed, analyzed -} diff --git a/src/main/java/org/springframework/data/elasticsearch/annotations/FieldType.java b/src/main/java/org/springframework/data/elasticsearch/annotations/FieldType.java index ef982b6017..f701948d6d 100644 --- a/src/main/java/org/springframework/data/elasticsearch/annotations/FieldType.java +++ b/src/main/java/org/springframework/data/elasticsearch/annotations/FieldType.java @@ -1,7 +1,100 @@ +/* + * 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; /** + * @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 + 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; + } } diff --git a/src/main/java/org/springframework/data/elasticsearch/annotations/Filter.java b/src/main/java/org/springframework/data/elasticsearch/annotations/Filter.java new file mode 100644 index 0000000000..7f07df55d1 --- /dev/null +++ b/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 ""; +} diff --git a/src/test/java/org/springframework/data/elasticsearch/repositories/DoubleIDRepository.java b/src/main/java/org/springframework/data/elasticsearch/annotations/GeoPointField.java similarity index 56% rename from src/test/java/org/springframework/data/elasticsearch/repositories/DoubleIDRepository.java rename to src/main/java/org/springframework/data/elasticsearch/annotations/GeoPointField.java index d6a2968236..05695abc98 100644 --- a/src/test/java/org/springframework/data/elasticsearch/repositories/DoubleIDRepository.java +++ b/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, @@ -13,11 +13,16 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -package org.springframework.data.elasticsearch.repositories; +package org.springframework.data.elasticsearch.annotations; -import org.springframework.data.elasticsearch.DoubleIDEntity; -import org.springframework.data.elasticsearch.repository.ElasticsearchRepository; +import java.lang.annotation.*; -public interface DoubleIDRepository extends ElasticsearchRepository
+ * This can not be used to specify the index where an entity should be written to.
+ *
+ * @author Peter-Josef Meisch
+ * @since 5.1
+ */
+@Retention(RetentionPolicy.RUNTIME)
+@Target({ ElementType.FIELD, ElementType.ANNOTATION_TYPE })
+@Documented
+@Field(type = FieldType.Auto) // prevents the property being written to the index mapping
+public @interface IndexedIndexName {
+}
diff --git a/src/main/java/org/springframework/data/elasticsearch/annotations/InnerField.java b/src/main/java/org/springframework/data/elasticsearch/annotations/InnerField.java
new file mode 100644
index 0000000000..651bf5a825
--- /dev/null
+++ b/src/main/java/org/springframework/data/elasticsearch/annotations/InnerField.java
@@ -0,0 +1,182 @@
+/*
+ * 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
+ *
+ * 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.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * @author Artur Konczak
+ * @author Mohsin Husen
+ * @author Sascha Woo
+ * @author Xiao Yu
+ * @author Peter-Josef Meisch
+ * @author Aleksei Arsenev
+ * @author Brian Kimmig
+ * @author Morgan Lutz
+ * @author Haibo Liu
+ * @author Andriy Redko
+ */
+@Retention(RetentionPolicy.RUNTIME)
+@Target(ElementType.ANNOTATION_TYPE)
+public @interface InnerField {
+
+ String suffix();
+
+ FieldType type();
+
+ 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 "";
+
+ /**
+ * @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;
+
+ /**
+ * @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;
+
+ /**
+ * to be used in combination with {@link FieldType#Rank_Feature}
+ *
+ * @since 4.1
+ */
+ boolean positiveScoreImpact() 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 {};
+
+ /**
+ * overrides the field type in the mapping which otherwise will be taken from corresponding {@link FieldType}
+ *
+ * @since 5.4
+ */
+ String mappedTypeName() default "";
+}
diff --git a/src/main/java/org/springframework/data/elasticsearch/annotations/JoinTypeRelation.java b/src/main/java/org/springframework/data/elasticsearch/annotations/JoinTypeRelation.java
new file mode 100644
index 0000000000..eb2e1e4623
--- /dev/null
+++ b/src/main/java/org/springframework/data/elasticsearch/annotations/JoinTypeRelation.java
@@ -0,0 +1,36 @@
+/*
+ * 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.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;
+
+/**
+ * @author Subhobrata Dey
+ * @since 4.1
+ */
+@Documented
+@Retention(RetentionPolicy.RUNTIME)
+@Target(ElementType.ANNOTATION_TYPE)
+public @interface JoinTypeRelation {
+
+ String parent();
+
+ String[] children();
+}
diff --git a/src/main/java/org/springframework/data/elasticsearch/annotations/JoinTypeRelations.java b/src/main/java/org/springframework/data/elasticsearch/annotations/JoinTypeRelations.java
new file mode 100644
index 0000000000..2004200cf2
--- /dev/null
+++ b/src/main/java/org/springframework/data/elasticsearch/annotations/JoinTypeRelations.java
@@ -0,0 +1,36 @@
+/*
+ * 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.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 Subhobrata Dey
+ * @since 4.1
+ */
+@Documented
+@Retention(RetentionPolicy.RUNTIME)
+@Target(ElementType.FIELD)
+@Inherited
+public @interface JoinTypeRelations {
+
+ JoinTypeRelation[] relations();
+}
diff --git a/src/main/java/org/springframework/data/elasticsearch/annotations/KnnAlgorithmType.java b/src/main/java/org/springframework/data/elasticsearch/annotations/KnnAlgorithmType.java
new file mode 100644
index 0000000000..6110e54be8
--- /dev/null
+++ b/src/main/java/org/springframework/data/elasticsearch/annotations/KnnAlgorithmType.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;
+
+/**
+ * @author Haibo Liu
+ * @since 5.4
+ */
+public enum KnnAlgorithmType {
+ HNSW("hnsw"),
+ INT8_HNSW("int8_hnsw"),
+ FLAT("flat"),
+ INT8_FLAT("int8_flat"),
+ DEFAULT("");
+
+ private final String type;
+
+ KnnAlgorithmType(String type) {
+ this.type = type;
+ }
+
+ public String getType() {
+ return type;
+ }
+}
diff --git a/src/main/java/org/springframework/data/elasticsearch/annotations/KnnIndexOptions.java b/src/main/java/org/springframework/data/elasticsearch/annotations/KnnIndexOptions.java
new file mode 100644
index 0000000000..56d871d3b5
--- /dev/null
+++ b/src/main/java/org/springframework/data/elasticsearch/annotations/KnnIndexOptions.java
@@ -0,0 +1,40 @@
+/*
+ * 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 @interface KnnIndexOptions {
+
+ KnnAlgorithmType type() default KnnAlgorithmType.DEFAULT;
+
+ /**
+ * Only applicable to {@link KnnAlgorithmType#HNSW} and {@link KnnAlgorithmType#INT8_HNSW} index types.
+ */
+ int m() default -1;
+
+ /**
+ * Only applicable to {@link KnnAlgorithmType#HNSW} and {@link KnnAlgorithmType#INT8_HNSW} index types.
+ */
+ int efConstruction() default -1;
+
+ /**
+ * Only applicable to {@link KnnAlgorithmType#INT8_HNSW} and {@link KnnAlgorithmType#INT8_FLAT} index types.
+ */
+ float confidenceInterval() default -1F;
+}
diff --git a/src/main/java/org/springframework/data/elasticsearch/annotations/KnnSimilarity.java b/src/main/java/org/springframework/data/elasticsearch/annotations/KnnSimilarity.java
new file mode 100644
index 0000000000..d03c42a6fd
--- /dev/null
+++ b/src/main/java/org/springframework/data/elasticsearch/annotations/KnnSimilarity.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;
+
+/**
+ * @author Haibo Liu
+ * @since 5.4
+ */
+public enum KnnSimilarity {
+ L2_NORM("l2_norm"),
+ DOT_PRODUCT("dot_product"),
+ COSINE("cosine"),
+ MAX_INNER_PRODUCT("max_inner_product"),
+ DEFAULT("");
+
+ private final String similarity;
+
+ KnnSimilarity(String similarity) {
+ this.similarity = similarity;
+ }
+
+ public String getSimilarity() {
+ return similarity;
+ }
+}
diff --git a/src/main/java/org/springframework/data/elasticsearch/annotations/Mapping.java b/src/main/java/org/springframework/data/elasticsearch/annotations/Mapping.java
new file mode 100644
index 0000000000..c2d48c3884
--- /dev/null
+++ b/src/main/java/org/springframework/data/elasticsearch/annotations/Mapping.java
@@ -0,0 +1,87 @@
+/*
+ * 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
+ *
+ * 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;
+
+/**
+ * Elasticsearch Mapping
+ *
+ * @author Mohsin Husen
+ * @author Peter-Josef Meisch
+ */
+@Persistent
+@Inherited
+@Retention(RetentionPolicy.RUNTIME)
+@Target({ ElementType.TYPE, ElementType.FIELD })
+public @interface Mapping {
+
+ String mappingPath() default "";
+
+ /**
+ * whether mappings are enabled
+ *
+ * @since 4.2
+ */
+ boolean enabled() default true;
+
+ /**
+ * whether date_detection is enabled
+ *
+ * @since 4.3
+ */
+ Detection dateDetection() default Detection.DEFAULT;
+
+ /**
+ * whether numeric_detection is enabled
+ *
+ * @since 4.3
+ */
+ Detection numericDetection() default Detection.DEFAULT;
+
+ /**
+ * custom dynamic date formats
+ *
+ * @since 4.3
+ */
+ String[] dynamicDateFormats() default {};
+
+ /**
+ * classpath to a JSON file containing the values for a runtime mapping definition. The file must contain the JSON
+ * object that is written as the value of the runtime property. {@see elasticsearch doc}
+ *
+ * @since 4.3
+ */
+ String runtimeFieldsPath() default "";
+
+ /**
+ * field alias definitions to be written to the index mapping
+ *
+ * @since 5.3
+ */
+ MappingAlias[] aliases() default {};
+
+ enum Detection {
+ DEFAULT, TRUE, FALSE
+ }
+}
diff --git a/src/main/java/org/springframework/data/elasticsearch/annotations/MappingAlias.java b/src/main/java/org/springframework/data/elasticsearch/annotations/MappingAlias.java
new file mode 100644
index 0000000000..791659e9d5
--- /dev/null
+++ b/src/main/java/org/springframework/data/elasticsearch/annotations/MappingAlias.java
@@ -0,0 +1,45 @@
+/*
+ * 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.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;
+
+/**
+ * Defines a field alias in the index mapping.
+ *
+ * @author Peter-Josef Meisch
+ * @since 5.3
+ */
+@Retention(RetentionPolicy.RUNTIME)
+@Target(ElementType.FIELD)
+@Documented
+@Inherited
+public @interface MappingAlias {
+ /**
+ * the name of the alias.
+ */
+ String name();
+
+ /**
+ * the path of the alias.
+ */
+ String path();
+}
diff --git a/src/main/java/org/springframework/data/elasticsearch/annotations/MultiField.java b/src/main/java/org/springframework/data/elasticsearch/annotations/MultiField.java
index fa3ccff0d9..9dff38c1f1 100644
--- a/src/main/java/org/springframework/data/elasticsearch/annotations/MultiField.java
+++ b/src/main/java/org/springframework/data/elasticsearch/annotations/MultiField.java
@@ -1,19 +1,40 @@
+/*
+ * 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
+ *
+ * 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.*;
+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;
/**
* @author Rizwan Idrees
* @author Mohsin Husen
* @author Artur Konczak
* @author Jonathan Yan
+ * @author Xiao Yu
+ * @author Peter-Josef Meisch
*/
@Retention(RetentionPolicy.RUNTIME)
-@Target(ElementType.FIELD)
+@Target({ ElementType.FIELD, ElementType.ANNOTATION_TYPE, ElementType.METHOD })
@Documented
public @interface MultiField {
- public Field mainField();
+ Field mainField();
- public NestedField[] otherFields() default {};
+ InnerField[] otherFields() default {};
}
diff --git a/src/main/java/org/springframework/data/elasticsearch/annotations/NestedField.java b/src/main/java/org/springframework/data/elasticsearch/annotations/NestedField.java
deleted file mode 100644
index 9cd36b06a0..0000000000
--- a/src/main/java/org/springframework/data/elasticsearch/annotations/NestedField.java
+++ /dev/null
@@ -1,26 +0,0 @@
-package org.springframework.data.elasticsearch.annotations;
-
-import java.lang.annotation.ElementType;
-import java.lang.annotation.Retention;
-import java.lang.annotation.RetentionPolicy;
-import java.lang.annotation.Target;
-
-/**
- *
- */
-@Retention(RetentionPolicy.RUNTIME)
-@Target(ElementType.FIELD)
-public @interface NestedField {
-
- String dotSuffix();
-
- FieldType type();
-
- FieldIndex index() default FieldIndex.analyzed;
-
- boolean store() default false;
-
- String searchAnalyzer() default "";
-
- String indexAnalyzer() default "";
-}
diff --git a/src/main/java/org/springframework/data/elasticsearch/annotations/NullValueType.java b/src/main/java/org/springframework/data/elasticsearch/annotations/NullValueType.java
new file mode 100644
index 0000000000..a131b12a8e
--- /dev/null
+++ b/src/main/java/org/springframework/data/elasticsearch/annotations/NullValueType.java
@@ -0,0 +1,24 @@
+/*
+ * 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.annotations;
+
+/**
+ * @author Peter-Josef Meisch
+ * @since 4.1
+ */
+public enum NullValueType {
+ String, Integer, Long, Double
+}
diff --git a/src/main/java/org/springframework/data/elasticsearch/annotations/Query.java b/src/main/java/org/springframework/data/elasticsearch/annotations/Query.java
index cc78366f5a..9f1b755c35 100644
--- a/src/main/java/org/springframework/data/elasticsearch/annotations/Query.java
+++ b/src/main/java/org/springframework/data/elasticsearch/annotations/Query.java
@@ -1,46 +1,62 @@
-/*
- * 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.*;
-
-/**
- * Query
- *
- * @author Rizwan Idrees
- * @author Mohsin Husen
- */
-
-@Retention(RetentionPolicy.RUNTIME)
-@Target(ElementType.METHOD)
-@Documented
-public @interface Query {
-
- /**
- * Elasticsearch query to be used when executing query. May contain placeholders eg. ?0
- *
- * @return
- */
- String value() default "";
-
- /**
- * Named Query Named looked up by repository.
- *
- * @return
- */
- String name() default "";
-
-}
+/*
+ * 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.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+import org.springframework.core.annotation.AliasFor;
+import org.springframework.data.annotation.QueryAnnotation;
+
+/**
+ * Query
+ *
+ * @author Rizwan Idrees
+ * @author Mohsin Husen
+ * @author Peter-Josef Meisch
+ * @author Steven Pearce
+ */
+
+@Retention(RetentionPolicy.RUNTIME)
+@Target({ ElementType.METHOD, ElementType.ANNOTATION_TYPE })
+@Documented
+@QueryAnnotation
+public @interface Query {
+
+ /**
+ * @return Elasticsearch query to be used when executing query. May contain placeholders eg. ?0. Alias for query.
+ */
+ @AliasFor("query")
+ String value() default "";
+
+ /**
+ * @return Elasticsearch query to be used when executing query. May contain placeholders eg. ?0. Alias for value
+ * @since 5.0
+ */
+ @AliasFor("value")
+ String query() default "";
+
+ /**
+ * Returns whether the query defined should be executed as count projection.
+ *
+ * @return {@literal false} by default.
+ * @since 4.2
+ */
+ boolean count() default false;
+}
diff --git a/src/main/java/org/springframework/data/elasticsearch/annotations/Routing.java b/src/main/java/org/springframework/data/elasticsearch/annotations/Routing.java
new file mode 100644
index 0000000000..ea71e50564
--- /dev/null
+++ b/src/main/java/org/springframework/data/elasticsearch/annotations/Routing.java
@@ -0,0 +1,43 @@
+/*
+ * Copyright2020-2021 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;
+
+/**
+ * Annotation to enable custom routing values for an entity.
+ *
+ * @author Peter-Josef Meisch
+ * @since 4.2
+ */
+@Persistent
+@Inherited
+@Retention(RetentionPolicy.RUNTIME)
+@Target({ ElementType.TYPE })
+public @interface Routing {
+
+ /**
+ * defines how the routing is determined. Can be either the name of a property or a SpEL expression. See the reference
+ * documentation for examples how to use this annotation.
+ */
+ String value();
+}
diff --git a/src/main/java/org/springframework/data/elasticsearch/annotations/ScriptedField.java b/src/main/java/org/springframework/data/elasticsearch/annotations/ScriptedField.java
new file mode 100644
index 0000000000..cc596c54f3
--- /dev/null
+++ b/src/main/java/org/springframework/data/elasticsearch/annotations/ScriptedField.java
@@ -0,0 +1,20 @@
+package org.springframework.data.elasticsearch.annotations;
+
+import java.lang.annotation.*;
+
+/**
+ * Marks a property to be populated with the result of a scripted field retrieved from an Elasticsearch response.
+ * @author Ryan Murfitt
+ */
+@Retention(RetentionPolicy.RUNTIME)
+@Target(ElementType.FIELD)
+@Documented
+public @interface ScriptedField {
+
+ /**
+ * (Optional) The name of the scripted field. Defaults to
+ * the field name.
+ */
+ String name() default "";
+
+}
diff --git a/src/main/java/org/springframework/data/elasticsearch/annotations/SearchTemplateQuery.java b/src/main/java/org/springframework/data/elasticsearch/annotations/SearchTemplateQuery.java
new file mode 100644
index 0000000000..f50675d979
--- /dev/null
+++ b/src/main/java/org/springframework/data/elasticsearch/annotations/SearchTemplateQuery.java
@@ -0,0 +1,42 @@
+/*
+ * Copyright 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.data.annotation.QueryAnnotation;
+
+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;
+
+/**
+ * Annotation to mark a repository method as a search template method. The annotation defines the search template id,
+ * the parameters for the search template are taken from the method's arguments.
+ *
+ * @author P.J. Meisch (pj.meisch@sothawo.com)
+ * @since 5.5
+ */
+@Retention(RetentionPolicy.RUNTIME)
+@Target({ ElementType.METHOD, ElementType.ANNOTATION_TYPE })
+@Documented
+@QueryAnnotation
+public @interface SearchTemplateQuery {
+ /**
+ * The id of the search template. Must not be empt or null.
+ */
+ String id();
+}
diff --git a/src/main/java/org/springframework/data/elasticsearch/annotations/Setting.java b/src/main/java/org/springframework/data/elasticsearch/annotations/Setting.java
new file mode 100644
index 0000000000..926154f1f2
--- /dev/null
+++ b/src/main/java/org/springframework/data/elasticsearch/annotations/Setting.java
@@ -0,0 +1,110 @@
+/*
+ * 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
+ *
+ * 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;
+
+/**
+ * Elasticsearch Setting
+ *
+ * @author Mohsin Husen
+ * @author Peter-Josef Meisch
+ */
+
+@Persistent
+@Inherited
+@Retention(RetentionPolicy.RUNTIME)
+@Target({ ElementType.TYPE })
+public @interface Setting {
+
+ /**
+ * Resource path for a settings configuration
+ */
+ String settingPath() default "";
+
+ /**
+ * Use server-side settings when creating the index.
+ */
+ boolean useServerConfiguration() default false;
+
+ /**
+ * Number of shards for the index. Used for index creation.
+ * With version 4.0, the default value is changed from 5 to 1 to reflect the change in the default settings of
+ * Elasticsearch which changed to 1 as well in Elasticsearch 7.0.
+ */
+ short shards() default 1;
+
+ /**
+ * Number of replicas for the index. Used for index creation.
+ */
+ short replicas() default 1;
+
+ /**
+ * Refresh interval for the index. Used for index creation.
+ */
+ String refreshInterval() default "1s";
+
+ /**
+ * Index storage type for the index. Used for index creation.
+ */
+ String indexStoreType() default "fs";
+
+ /**
+ * fields to define an index sorting
+ *
+ * @since 4.2
+ */
+ String[] sortFields() default {};
+
+ /**
+ * defines the order for {@link #sortFields()}. If present, it must have the same number of elements
+ *
+ * @since 4.2
+ */
+ SortOrder[] sortOrders() default {};
+
+ /**
+ * defines the mode for {@link #sortFields()}. If present, it must have the same number of elements
+ *
+ * @since 4.2
+ */
+ SortMode[] sortModes() default {};
+
+ /**
+ * defines the missing value for {@link #sortFields()}. If present, it must have the same number of elements
+ *
+ * @since 4.2
+ */
+ SortMissing[] sortMissingValues() default {};
+
+ enum SortOrder {
+ asc, desc
+ }
+
+ enum SortMode {
+ min, max
+ }
+
+ enum SortMissing {
+ _last, _first
+ }
+}
diff --git a/src/main/java/org/springframework/data/elasticsearch/annotations/Similarity.java b/src/main/java/org/springframework/data/elasticsearch/annotations/Similarity.java
new file mode 100644
index 0000000000..46cafd91a2
--- /dev/null
+++ b/src/main/java/org/springframework/data/elasticsearch/annotations/Similarity.java
@@ -0,0 +1,27 @@
+/*
+ * 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;
+
+/**
+ * @author Peter-Josef Meisch
+ * @since 4.0
+ */
+public final class Similarity {
+ public final static String Default = "default";
+ public final static String BM25 = "BM25";
+ public final static String classic = "classic";
+ public final static String Boolean = "boolean";
+}
diff --git a/src/main/java/org/springframework/data/elasticsearch/annotations/SourceFilters.java b/src/main/java/org/springframework/data/elasticsearch/annotations/SourceFilters.java
new file mode 100644
index 0000000000..055ecc616f
--- /dev/null
+++ b/src/main/java/org/springframework/data/elasticsearch/annotations/SourceFilters.java
@@ -0,0 +1,73 @@
+/*
+ * 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.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;
+
+/**
+ * This annotation can be placed on repository methods to define the properties that should be requested from
+ * Elasticsearch when the method is run.
+ *
+ * @author Alexander Torres
+ * @author Peter-Josef Meisch
+ * @since 5.0
+ */
+@Retention(RetentionPolicy.RUNTIME)
+@Target({ ElementType.METHOD, ElementType.ANNOTATION_TYPE })
+@Documented
+public @interface SourceFilters {
+
+ /**
+ * Properties to be requested from Elasticsearch to be included in the response. These can be passed in as literals
+ * like
+ *
+ *
+ * {@code @SourceFilters(includes = {"property1", "property2"})}
+ *
+ *
+ * or as a parameterized value
+ *
+ *
+ * {@code @SourceFilters(includes = "?0")}
+ *
+ *
+ * when the list of properties is passed as a function parameter.
+ */
+ String[] includes() default "";
+
+ /**
+ * Properties to be requested from Elasticsearch to be excluded in the response. These can be passed in as literals
+ * like
+ *
+ *
+ * {@code @SourceFilters(excludes = {"property1", "property2"})}
+ *
+ *
+ * or as a parameterized value
+ *
+ *
+ * {@code @SourceFilters(excludes = "?0")}
+ *
+ *
+ * when the list of properties is passed as a function parameter.
+ */
+ String[] excludes() default "";
+}
diff --git a/src/main/java/org/springframework/data/elasticsearch/annotations/TermVector.java b/src/main/java/org/springframework/data/elasticsearch/annotations/TermVector.java
new file mode 100644
index 0000000000..25de2cbcad
--- /dev/null
+++ b/src/main/java/org/springframework/data/elasticsearch/annotations/TermVector.java
@@ -0,0 +1,24 @@
+/*
+ * 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;
+
+/**
+ * @author Peter-Josef Meisch
+ * @since 4.0
+ */
+public enum TermVector {
+ none, no, yes, with_positions, with_offsets, with_positions_offsets, with_positions_payloads, with_positions_offsets_payloads
+}
diff --git a/src/main/java/org/springframework/data/elasticsearch/annotations/ValueConverter.java b/src/main/java/org/springframework/data/elasticsearch/annotations/ValueConverter.java
new file mode 100644
index 0000000000..eb848bfed2
--- /dev/null
+++ b/src/main/java/org/springframework/data/elasticsearch/annotations/ValueConverter.java
@@ -0,0 +1,48 @@
+/*
+ * 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.Inherited;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+import org.springframework.data.elasticsearch.core.mapping.PropertyValueConverter;
+
+/**
+ * Annotation to put on a property of an entity to define a value converter which can convert the property to a type
+ * that Elasticsearch understands and back.
+ *
+ * @author Peter-Josef Meisch
+ * @since 4.3
+ */
+@Retention(RetentionPolicy.RUNTIME)
+@Target({ ElementType.FIELD, ElementType.ANNOTATION_TYPE })
+@Documented
+@Inherited
+public @interface ValueConverter {
+
+ /**
+ * Defines the class implementing the {@link PropertyValueConverter} interface. If this is a normal class, it must
+ * provide a default constructor with no arguments. If this is an enum and thus implementing a singleton by enum it
+ * must only have one enum value.
+ *
+ * @return the class to use for conversion
+ */
+ Class value();
+}
diff --git a/src/main/java/org/springframework/data/elasticsearch/annotations/WriteOnlyProperty.java b/src/main/java/org/springframework/data/elasticsearch/annotations/WriteOnlyProperty.java
new file mode 100644
index 0000000000..7704450e26
--- /dev/null
+++ b/src/main/java/org/springframework/data/elasticsearch/annotations/WriteOnlyProperty.java
@@ -0,0 +1,35 @@
+/*
+ * 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.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;
+
+/**
+ * Annotation to mark a property that will be written to Elasticsearch, but not set when reading from Elasticsearch.
+ * This is needed for synthesized fields that may be used for search but that are not available in the entity.
+ *
+ * @author Peter-Josef Meisch
+ * @since 5.0
+ */
+@Retention(RetentionPolicy.RUNTIME)
+@Target({ ElementType.METHOD, ElementType.FIELD })
+@Documented
+public @interface WriteOnlyProperty {
+}
diff --git a/src/main/java/org/springframework/data/elasticsearch/annotations/WriteTypeHint.java b/src/main/java/org/springframework/data/elasticsearch/annotations/WriteTypeHint.java
new file mode 100644
index 0000000000..86a844cc18
--- /dev/null
+++ b/src/main/java/org/springframework/data/elasticsearch/annotations/WriteTypeHint.java
@@ -0,0 +1,40 @@
+/*
+ * 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 org.springframework.data.mapping.context.MappingContext;
+
+/**
+ * Defines if type hints should be written. Used by {@link Document} annotation.
+ *
+ * @author Peter-Josef Meisch
+ * @since 4.3
+ */
+public enum WriteTypeHint {
+
+ /**
+ * Use the global settings from the {@link MappingContext}.
+ */
+ DEFAULT,
+ /**
+ * Always write type hints for the entity.
+ */
+ TRUE,
+ /**
+ * Never write type hints for the entity.
+ */
+ FALSE
+}
diff --git a/src/main/java/org/springframework/data/elasticsearch/annotations/package-info.java b/src/main/java/org/springframework/data/elasticsearch/annotations/package-info.java
new file mode 100644
index 0000000000..4b8ccdf64e
--- /dev/null
+++ b/src/main/java/org/springframework/data/elasticsearch/annotations/package-info.java
@@ -0,0 +1,2 @@
+@org.jspecify.annotations.NullMarked
+package org.springframework.data.elasticsearch.annotations;
diff --git a/src/main/java/org/springframework/data/elasticsearch/aot/ElasticsearchAotPredicates.java b/src/main/java/org/springframework/data/elasticsearch/aot/ElasticsearchAotPredicates.java
new file mode 100644
index 0000000000..c3921b8940
--- /dev/null
+++ b/src/main/java/org/springframework/data/elasticsearch/aot/ElasticsearchAotPredicates.java
@@ -0,0 +1,35 @@
+/*
+ * 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.aot;
+
+import java.util.function.Predicate;
+
+import org.springframework.data.util.ReactiveWrappers;
+
+/**
+ * @author Peter-Josef Meisch
+ * @since 5.1
+ */
+public class ElasticsearchAotPredicates {
+
+ public static final Predicate+ * // "localhost:9200" + * ClientConfiguration configuration = ClientConfiguration.localhost(); + *+ * + * @return a new {@link ClientConfiguration} instance + * @see ClientConfigurationBuilder#connectedToLocalhost() + */ + static ClientConfiguration localhost() { + return new ClientConfigurationBuilder().connectedToLocalhost().build(); + } + + /** + * Creates a new {@link ClientConfiguration} instance configured to a single host given {@code hostAndPort}. For + * example given the endpoint http://localhost:9200 + * + *
+ * ClientConfiguration configuration = ClientConfiguration.create("localhost:9200");
+ *
+ *
+ * @return a new {@link ClientConfigurationBuilder} instance.
+ */
+ static ClientConfiguration create(String hostAndPort) {
+ return new ClientConfigurationBuilder().connectedTo(hostAndPort).build();
+ }
+
+ /**
+ * Creates a new {@link ClientConfiguration} instance configured to a single host given {@link InetSocketAddress}. For
+ * example given the endpoint http://localhost:9200
+ *
+ *
+ * ClientConfiguration configuration = ClientConfiguration
+ * .create(InetSocketAddress.createUnresolved("localhost", 9200));
+ *
+ *
+ * @return a new {@link ClientConfigurationBuilder} instance.
+ */
+ static ClientConfiguration create(InetSocketAddress socketAddress) {
+ return new ClientConfigurationBuilder().connectedTo(socketAddress).build();
+ }
+
+ /**
+ * Returns the configured endpoints.
+ *
+ * @return the configured endpoints.
+ */
+ List+ * NOTE You need to leave out the protocol in + * {@link ClientConfigurationBuilderWithRequiredEndpoint#connectedTo(String)}. + * + * @return the {@link TerminalClientConfigurationBuilder}. + */ + TerminalClientConfigurationBuilder usingSsl(); + + /** + * Connects using https if flag is true. + * + * @param flag whether to use https in the connection + * @return the {@link TerminalClientConfigurationBuilder} + * @since 5.3 + */ + TerminalClientConfigurationBuilder usingSsl(boolean flag); + + /** + * Connect via {@literal https} using the given {@link SSLContext}.
+ * NOTE You need to leave out the protocol in + * {@link ClientConfigurationBuilderWithRequiredEndpoint#connectedTo(String)}. + * + * @return the {@link TerminalClientConfigurationBuilder}. + */ + TerminalClientConfigurationBuilder usingSsl(SSLContext sslContext); + + /** + * Connect via {@literal https} using the givens {@link SSLContext} and HostnameVerifier {@link HostnameVerifier} + * .
+ * NOTE You need to leave out the protocol in + * {@link ClientConfigurationBuilderWithRequiredEndpoint#connectedTo(String)}. + * + * @return the {@link TerminalClientConfigurationBuilder}. + */ + TerminalClientConfigurationBuilder usingSsl(SSLContext sslContext, HostnameVerifier hostnameVerifier); + + /** + * Connect via https using a SSLContext that is build from the given certificate fingerprint. + * + * @param caFingerprint the SHA-256 fingerprint of the self-signed http_ca.crt certificate output by Elasticsearch + * at startup time. + * @return the {@link TerminalClientConfigurationBuilder}. + */ + TerminalClientConfigurationBuilder usingSsl(String caFingerprint); + } + + /** + * @author Christoph Strobl + * @author Mark Paluch + */ + interface TerminalClientConfigurationBuilder { + + /** + * @param defaultHeaders must not be {@literal null}. + * @return the {@link TerminalClientConfigurationBuilder} + */ + TerminalClientConfigurationBuilder withDefaultHeaders(HttpHeaders defaultHeaders); + + /** + * Configure the {@literal milliseconds} for the connect-timeout. + * + * @param millis the timeout to use. + * @return the {@link TerminalClientConfigurationBuilder} + * @see #withConnectTimeout(Duration) + */ + default TerminalClientConfigurationBuilder withConnectTimeout(long millis) { + return withConnectTimeout(Duration.ofMillis(millis)); + } + + /** + * Configure a {@link java.time.Duration} connect timeout. + * + * @param timeout the timeout to use. Must not be {@literal null}. + * @return the {@link TerminalClientConfigurationBuilder} + * @see java.net.Socket#connect(SocketAddress, int) + */ + TerminalClientConfigurationBuilder withConnectTimeout(Duration timeout); + + /** + * Configure the {@literal milliseconds} for the socket timeout. + * + * @param millis the timeout to use. + * @return the {@link TerminalClientConfigurationBuilder} + * @see #withSocketTimeout(Duration) + */ + default TerminalClientConfigurationBuilder withSocketTimeout(long millis) { + return withSocketTimeout(Duration.ofMillis(millis)); + } + + /** + * Configure a {@link java.time.Duration socket timeout} which is typically applied as SO-timeout/read timeout. + * + * @param timeout the timeout to use. Must not be {@literal null}. + * @return the {@link TerminalClientConfigurationBuilder} + * @see java.net.Socket#setSoTimeout(int) + */ + TerminalClientConfigurationBuilder withSocketTimeout(Duration timeout); + + /** + * Configure the username and password to be sent as a Basic Authentication header + * + * @param username the username. Must not be {@literal null}. + * @param password the password. Must not be {@literal null}. + * @return the {@link TerminalClientConfigurationBuilder} + */ + TerminalClientConfigurationBuilder withBasicAuth(String username, String password); + + /** + * Configure the path prefix that will be prepended to any HTTP(s) requests + * + * @param pathPrefix the pathPrefix. + * @return the {@link TerminalClientConfigurationBuilder} + * @since 4.0 + */ + TerminalClientConfigurationBuilder withPathPrefix(String pathPrefix); + + /** + * @param proxy a proxy formatted as String {@literal host:port}. + * @return the {@link TerminalClientConfigurationBuilder}. + */ + TerminalClientConfigurationBuilder withProxy(String proxy); + + /** + * Register a {@link ClientConfigurationCallback} to configure the client. + * + * @param clientConfigurer configuration callback, must not be {@literal null}. + * @return the {@link TerminalClientConfigurationBuilder}. + * @since 4.3 + */ + TerminalClientConfigurationBuilder withClientConfigurer(ClientConfigurationCallback clientConfigurer); + + /** + * set a supplier for custom headers. This is invoked for every HTTP request to Elasticsearch to retrieve headers + * that should be sent with the request. A common use case is passing in authentication headers that may change. + *
+ * Note: When used in a reactive environment, the calling of {@link Supplier#get()} function must not do any + * blocking operations. It may return {@literal null}. + * + * @param headers supplier function for headers, must not be {@literal null} + * @return the {@link TerminalClientConfigurationBuilder}. + * @since 4.0 + */ + TerminalClientConfigurationBuilder withHeaders(Supplier
\. Copied from Apachae 2 licensed org.apache.lucene.queryparser.flexible.standard.QueryParserUtil
+ * class
+ */
+ public static String escape(String s) {
+ StringBuilder sb = new StringBuilder();
+ for (int i = 0; i < s.length(); i++) {
+ char c = s.charAt(i);
+ // These characters are part of the query syntax and must be escaped
+ if (c == '\\' || c == '+' || c == '-' || c == '!' || c == '(' || c == ')' || c == ':' || c == '^' || c == '['
+ || c == ']' || c == '\"' || c == '{' || c == '}' || c == '~' || c == '*' || c == '?' || c == '|' || c == '&'
+ || c == '/') {
+ sb.append('\\');
+ }
+ sb.append(c);
+ }
+ return sb.toString();
+ }
+
+ /**
+ * Convert a spring-data-elasticsearch {@literal inner_hits} to an Elasticsearch {@literal inner_hits} query.
+ *
+ * @param query spring-data-elasticsearch {@literal inner_hits}.
+ * @return an Elasticsearch {@literal inner_hits} query.
+ */
+ @Nullable
+ private static InnerHits getInnerHits(@Nullable InnerHitsQuery query) {
+ if (query == null) {
+ return null;
+ }
+
+ return InnerHits.of(iqb -> iqb.from(query.getFrom()).size(query.getSize()).name(query.getName()));
+ }
+
+}
diff --git a/src/main/java/org/springframework/data/elasticsearch/client/elc/DocumentAdapters.java b/src/main/java/org/springframework/data/elasticsearch/client/elc/DocumentAdapters.java
new file mode 100644
index 0000000000..53e8cefa7b
--- /dev/null
+++ b/src/main/java/org/springframework/data/elasticsearch/client/elc/DocumentAdapters.java
@@ -0,0 +1,241 @@
+/*
+ * 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.client.elc;
+
+import co.elastic.clients.elasticsearch.core.GetResponse;
+import co.elastic.clients.elasticsearch.core.MgetResponse;
+import co.elastic.clients.elasticsearch.core.explain.ExplanationDetail;
+import co.elastic.clients.elasticsearch.core.get.GetResult;
+import co.elastic.clients.elasticsearch.core.search.CompletionSuggestOption;
+import co.elastic.clients.elasticsearch.core.search.Hit;
+import co.elastic.clients.elasticsearch.core.search.NestedIdentity;
+import co.elastic.clients.json.JsonData;
+import co.elastic.clients.json.JsonpMapper;
+import org.apache.commons.logging.Log;
+import org.apache.commons.logging.LogFactory;
+import org.jspecify.annotations.Nullable;
+import org.springframework.data.elasticsearch.core.MultiGetItem;
+import org.springframework.data.elasticsearch.core.document.Document;
+import org.springframework.data.elasticsearch.core.document.Explanation;
+import org.springframework.data.elasticsearch.core.document.NestedMetaData;
+import org.springframework.data.elasticsearch.core.document.SearchDocument;
+import org.springframework.data.elasticsearch.core.document.SearchDocumentAdapter;
+import org.springframework.data.elasticsearch.core.document.SearchDocumentResponse;
+import org.springframework.util.Assert;
+
+import java.util.Collections;
+import java.util.LinkedHashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.function.Function;
+import java.util.stream.Collectors;
+
+/**
+ * Utility class to adapt different Elasticsearch responses to a
+ * {@link org.springframework.data.elasticsearch.core.document.Document}
+ *
+ * @author Peter-Josef Meisch
+ * @author Haibo Liu
+ * @author Mohamed El Harrougui
+ * @since 4.4
+ */
+final class DocumentAdapters {
+
+ private static final Log LOGGER = LogFactory.getLog(DocumentAdapters.class);
+
+ private DocumentAdapters() {
+ }
+
+ /**
+ * Creates a {@link SearchDocument} from a {@link Hit} returned by the Elasticsearch client.
+ *
+ * @param hit the hit object
+ * @param jsonpMapper to map JsonData objects
+ * @return the created {@link SearchDocument}
+ */
+ public static SearchDocument from(Hit hit, JsonpMapper jsonpMapper) {
+
+ Assert.notNull(hit, "hit must not be null");
+
+ Map