org.hibernate.search.backend.elasticsearch.types.dsl

Interface ElasticsearchIndexFieldTypeFactory

All Superinterfaces:

IndexFieldTypeFactory

public interface ElasticsearchIndexFieldTypeFactory
extends IndexFieldTypeFactory

Method Summary

Modifier and Type	Method and Description
ElasticsearchNativeIndexFieldTypeMappingStep	asNative() Define a native field type.

Methods inherited from interface org.hibernate.search.engine.backend.types.dsl.IndexFieldTypeFactory

as, asBigDecimal, asBigInteger, asBoolean, asByte, asDouble, asFloat, asGeoPoint, asInstant, asInteger, asLocalDate, asLocalDateTime, asLocalTime, asLong, asMonthDay, asOffsetDateTime, asOffsetTime, asShort, asString, asYear, asYearMonth, asZonedDateTime, extension

Method Detail

asNative

ElasticsearchNativeIndexFieldTypeMappingStep asNative()

Define a native field type.

A native field type has the following characteristics:

• Hibernate Search doesn't know its exact type, so it must be entirely defined as a JSON object, provided as the mappingJsonString parameter
• When indexing, fields of this type must be populated with JSON. The field has a string type, but the string is interpreted as JSON, so it can contain a boolean, an integer, or even an object.
• The predicate/sort/projection DSLs have only limited support for fields of this type. Some features may not work and throw an exception, such as phrase predicates. It is recommended to create the predicate/sort/projections targeting these fields from JSON using ElasticsearchSearchPredicateFactory.fromJson(String) or ElasticsearchSearchSortFactory.fromJson(String)

Returns:

A DSL step where the index field type can be defined in more details.