mirror of
https://github.com/spring-projects/spring-data-elasticsearch.git
synced 2025-06-01 09:42:11 +00:00
Polishing.
This commit is contained in:
parent
31b488d08f
commit
ebac4c097c
@ -58,21 +58,58 @@ Constructor arguments are mapped by name to the key values in the retrieved Docu
|
|||||||
** `name`: The name of the field as it will be represented in the Elasticsearch document, if not set, the Java field name is used.
|
** `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_.
|
** `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]
|
See https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-types.html[Elasticsearch Mapping Types]
|
||||||
** `format`: One or more built-in formats, default value is _strict_date_optional_time_ and _epoch_millis_.
|
** `format`: One or more built-in date formats, see the next section <<elasticsearch.mapping.meta-model.date-formats>>.
|
||||||
See https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-date-format.html#built-in-date-formats[Elasticsearch Built In Formats]
|
** `pattern`: One or more custom date formats, see the next section <<elasticsearch.mapping.meta-model.date-formats>>.
|
||||||
** `pattern`: One or more custom date formats. NOTE: If you want to use only custom date formats, you must set the `format` property to empty `{}`.
|
|
||||||
See https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-date-format.html#custom-date-formats[Elasticsearch Custom Date Formats]
|
|
||||||
** `store`: Flag whether the original field value should be store in Elasticsearch, default value is _false_.
|
** `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.
|
** `analyzer`, `searchAnalyzer`, `normalizer` for specifying custom analyzers and normalizer.
|
||||||
* `@GeoPoint`: Marks a field as _geo_point_ datatype.
|
* `@GeoPoint`: Marks a field as _geo_point_ datatype.
|
||||||
Can be omitted if the field is an instance of the `GeoPoint` class.
|
Can be omitted if the field is an instance of the `GeoPoint` class.
|
||||||
|
|
||||||
NOTE: Properties that derive from `TemporalAccessor` or are of type `java.util.Date` must either have a `@Field` annotation of type `FieldType.Date`.
|
|
||||||
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].
|
|
||||||
|
|
||||||
The mapping metadata infrastructure is defined in a separate spring-data-commons project that is technology agnostic.
|
The mapping metadata infrastructure is defined in a separate spring-data-commons project that is technology agnostic.
|
||||||
|
|
||||||
|
[[elasticsearch.mapping.meta-model.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` attributes 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].
|
||||||
|
|
||||||
==== Mapped field 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.
|
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.
|
||||||
|
@ -31,6 +31,7 @@ import org.springframework.data.elasticsearch.annotations.GeoShapeField;
|
|||||||
import org.springframework.data.elasticsearch.annotations.MultiField;
|
import org.springframework.data.elasticsearch.annotations.MultiField;
|
||||||
import org.springframework.data.elasticsearch.annotations.Parent;
|
import org.springframework.data.elasticsearch.annotations.Parent;
|
||||||
import org.springframework.data.elasticsearch.core.completion.Completion;
|
import org.springframework.data.elasticsearch.core.completion.Completion;
|
||||||
|
import org.springframework.data.elasticsearch.core.convert.ConversionException;
|
||||||
import org.springframework.data.elasticsearch.core.convert.ElasticsearchDateConverter;
|
import org.springframework.data.elasticsearch.core.convert.ElasticsearchDateConverter;
|
||||||
import org.springframework.data.elasticsearch.core.geo.GeoJson;
|
import org.springframework.data.elasticsearch.core.geo.GeoJson;
|
||||||
import org.springframework.data.elasticsearch.core.geo.GeoPoint;
|
import org.springframework.data.elasticsearch.core.geo.GeoPoint;
|
||||||
@ -191,8 +192,7 @@ public class SimpleElasticsearchPersistentProperty extends
|
|||||||
// register converters for custom formats
|
// register converters for custom formats
|
||||||
for (String dateFormatPattern : dateFormatPatterns) {
|
for (String dateFormatPattern : dateFormatPatterns) {
|
||||||
if (!StringUtils.hasText(dateFormatPattern)) {
|
if (!StringUtils.hasText(dateFormatPattern)) {
|
||||||
throw new MappingException(
|
throw new MappingException(String.format("Date pattern of property '%s' must not be empty", property));
|
||||||
String.format("Date pattern of property '%s' must not be empty", property));
|
|
||||||
}
|
}
|
||||||
converters.add(ElasticsearchDateConverter.of(dateFormatPattern));
|
converters.add(ElasticsearchDateConverter.of(dateFormatPattern));
|
||||||
}
|
}
|
||||||
@ -216,7 +216,7 @@ public class SimpleElasticsearchPersistentProperty extends
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
throw new RuntimeException(String
|
throw new ConversionException(String
|
||||||
.format("Unable to parse date value '%s' of property '%s' with configured converters", s, property));
|
.format("Unable to parse date value '%s' of property '%s' with configured converters", s, property));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -34,6 +34,7 @@ import java.lang.Integer;
|
|||||||
import java.lang.Object;
|
import java.lang.Object;
|
||||||
import java.math.BigDecimal;
|
import java.math.BigDecimal;
|
||||||
import java.time.LocalDate;
|
import java.time.LocalDate;
|
||||||
|
import java.time.LocalDateTime;
|
||||||
import java.util.Collection;
|
import java.util.Collection;
|
||||||
import java.util.Date;
|
import java.util.Date;
|
||||||
import java.util.HashMap;
|
import java.util.HashMap;
|
||||||
@ -614,6 +615,40 @@ public class MappingBuilderUnitTests extends MappingContextBaseTests {
|
|||||||
assertEquals(expected, mapping, false);
|
assertEquals(expected, mapping, false);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@Test // #1727
|
||||||
|
@DisplayName("should map according to the annotated properties")
|
||||||
|
void shouldMapAccordingToTheAnnotatedProperties() throws JSONException {
|
||||||
|
|
||||||
|
String expected = "{\n" +
|
||||||
|
" \"properties\": {\n" + //
|
||||||
|
" \"field1\": {\n" + //
|
||||||
|
" \"type\": \"date\",\n" + //
|
||||||
|
" \"format\": \"date_optional_time||epoch_millis\"\n" + //
|
||||||
|
" },\n" + //
|
||||||
|
" \"field2\": {\n" + //
|
||||||
|
" \"type\": \"date\",\n" + //
|
||||||
|
" \"format\": \"basic_date\"\n" + //
|
||||||
|
" },\n" + //
|
||||||
|
" \"field3\": {\n" + //
|
||||||
|
" \"type\": \"date\",\n" + //
|
||||||
|
" \"format\": \"basic_date||basic_time\"\n" + //
|
||||||
|
" },\n" + //
|
||||||
|
" \"field4\": {\n" + //
|
||||||
|
" \"type\": \"date\",\n" + //
|
||||||
|
" \"format\": \"date_optional_time||epoch_millis||dd.MM.uuuu\"\n" + //
|
||||||
|
" },\n" + //
|
||||||
|
" \"field5\": {\n" + //
|
||||||
|
" \"type\": \"date\",\n" + //
|
||||||
|
" \"format\": \"dd.MM.uuuu\"\n" + //
|
||||||
|
" }\n" + //
|
||||||
|
" }\n" + //
|
||||||
|
"}"; //
|
||||||
|
|
||||||
|
String mapping = getMappingBuilder().buildPropertyMapping(DateFormatsEntity.class);
|
||||||
|
|
||||||
|
assertEquals(expected, mapping, false);
|
||||||
|
}
|
||||||
|
|
||||||
@Setter
|
@Setter
|
||||||
@Getter
|
@Getter
|
||||||
@NoArgsConstructor
|
@NoArgsConstructor
|
||||||
@ -971,7 +1006,7 @@ public class MappingBuilderUnitTests extends MappingContextBaseTests {
|
|||||||
}
|
}
|
||||||
|
|
||||||
static class ValueObject {
|
static class ValueObject {
|
||||||
private String value;
|
private final String value;
|
||||||
|
|
||||||
public ValueObject(String value) {
|
public ValueObject(String value) {
|
||||||
this.value = value;
|
this.value = value;
|
||||||
@ -1060,4 +1095,21 @@ public class MappingBuilderUnitTests extends MappingContextBaseTests {
|
|||||||
@Field(type = Text) private String objectField;
|
@Field(type = Text) private String objectField;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@Data
|
||||||
|
@AllArgsConstructor
|
||||||
|
@NoArgsConstructor
|
||||||
|
static class DateFormatsEntity {
|
||||||
|
@Id private String id;
|
||||||
|
@Field(type = FieldType.Date) private LocalDateTime field1;
|
||||||
|
|
||||||
|
@Field(type = FieldType.Date, format = DateFormat.basic_date) private LocalDateTime field2;
|
||||||
|
|
||||||
|
@Field(type = FieldType.Date,
|
||||||
|
format = { DateFormat.basic_date, DateFormat.basic_time }) private LocalDateTime field3;
|
||||||
|
|
||||||
|
@Field(type = FieldType.Date, pattern = "dd.MM.uuuu") private LocalDateTime field4;
|
||||||
|
|
||||||
|
@Field(type = FieldType.Date, format = {}, pattern = "dd.MM.uuuu") private LocalDateTime field5;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
Loading…
x
Reference in New Issue
Block a user