elasticmagic/dev.evo.elasticmagic.doc

Package-level declarations

Types

BaseDocSource

abstract class BaseDocSource

BaseDocument

abstract class BaseDocument : FieldSet

BoundField

open class BoundField<V, T>(name: String, type: FieldType<V, T>, params: Params, parent: FieldSet) : MappingField<T>

Represents field of a specific type. Usually it can be accessed as a document property.

BoundJoinField

class BoundJoinField(name: String, type: FieldType<Join, String>, relations: Map<String, List<String>>, params: Params, parent: FieldSet) : BoundField<Join, String>

Represents join field.

BoundMappingTemplate

class BoundMappingTemplate<V, T, F>(val name: String, val mapping: DynamicTemplates.DynamicField<V, T, F>, val matchOptions: DynamicTemplates.MatchOptions)

BoundRuntimeField

class BoundRuntimeField<V>(name: String, type: FieldType<V, V>, val script: Script, parent: FieldSet) : BoundField<V, V>

Represents a runtime field.

DocSource

open class DocSource : BaseDocSource

DocSourceFactory

object DocSourceFactory

DocSourceField

typealias DocSourceField = BoundField<BaseDocSource, Nothing>

Document

abstract class Document(val options: MappingOptions = MappingOptions()) : DynamicTemplates

Base class for describing a top level Elasticsearch document.

Dynamic

enum Dynamic : Enum<Dynamic> , ToValue<Any>

Controls dynamic field mapping setting. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/dynamic-field-mapping.html

DynamicTemplates

abstract class DynamicTemplates : RootFieldSet

DynDocSource

class DynDocSource : BaseDocSource

FieldSet

abstract class FieldSet : FieldSetShortcuts, Named

Base class for any types which hold set of fields: https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping.html

FieldSetShortcuts

abstract class FieldSetShortcuts

MappingField

interface MappingField<T> : FieldOperations<T>

Represents field of any type in an Elasticsearch document. See FieldSet.getAllFields and FieldSet.get methods.

MappingOptions

data class MappingOptions(val dynamic: Dynamic? = null, val numericDetection: Boolean? = null, val dateDetection: Boolean? = null, val dynamicDateFormats: List<String>? = null)

MetaFields

open class MetaFields : RootFieldSet

Metadata fields: https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-fields.html

RawSource

typealias RawSource = Map<*, *>

RootFieldSet

open class RootFieldSet : BaseDocument

RuntimeFields

class RuntimeFields : RootFieldSet

Fields that are accessible when search query is executing. They are mostly used in scripts.

SubDocument

abstract class SubDocument(field: DocSourceField, dynamic: Dynamic? = null) : BaseDocument, FieldOperations<Nothing>

Represents Elasticsearch sub-document.

SubFields

open class SubFields<V>(field: BoundField<V, V>) : FieldSet, FieldOperations<V>

Represents Elasticsearch multi-fields: https://www.elastic.co/guide/en/elasticsearch/reference/7.10/multi-fields.html

Functions

emptySource

fun emptySource(): Map<Nothing, Nothing>

enum

inline fun <V : Enum<V>> FieldSet.Field<Int, Int>.enum(fieldValue: IntEnumValue<V>): FieldSet.Field<V, V>

Maps integer value to the corresponding enum variant.

inline fun <V : Enum<V>> FieldSet.Field<String, String>.enum(fieldValue: KeywordEnumValue<V>? = null): FieldSet.Field<V, V>

Maps string value to the corresponding enum variant.

list

fun <V, T> BoundField<V, T>.list(): BoundField<MutableList<V?>, T>

fun SubDocument.list(): BoundField<MutableList<DynDocSource?>, Nothing>

mergeDocuments

fun mergeDocuments(vararg docs: Document): Document