elasticmagic-kt

Asynchronous Elasticsearch query DSL enabling typed query expressions, sub-field navigation, and declarative query modifications. Supports multiple serialization libraries and autodetects Elasticsearch and Opensearch versions.

#web
#serializer
#serialization
#kotlin-serialization
#kotlin-native
#json
#dsl

Suggest an edit

JVMKotlin/NativeJS

GitHub stars45

Authorsanti-social

Open issues9

LicenseApache License 2.0

Creation datealmost 5 years ago

Last activity7 months ago

Latest release0.3.4 (7 months ago)

Homepage GitHub repository GitHub pages Wiki page

Elasticmagic for Kotlin

Elasticsearch query DSL for Kotlin

Read User Guide

Features

Multiplatform (JVM, Native and JS)
Asynchronous API
No reflection (only for delegates)
Sub-fields and sub-documents with navigation
Typed query expression (when it is possible)
Typed document source
Parent child relations (ability to merge multiple documents into a single mapping)
Focused on a search API
Declarative search query modifications via query filters
Supports several serialization libraries (kotlinx.serialization and jackson out of the box)
Supports Elasticsearch 6.x, 7.x and 8.x (autodetect Elasticsearch version)
Supports Opensearch 1.x and 2.x

Not a goal

Covering full Elasticsearch API

Compatibility policy

versions before 0.1 (0.0.x) can be binary and source incompatible; backward incompatible changes are allowed
versions greater or equal 0.1 but before 1.0 (0.x.y):
- different minor versions can be binary and source incompatible
- 2 versions with the same minor version should be binary compatible
versions higher or equal 1.0:
- different major versions may require changing the source codes
- the same major but different minor versions should be source compatible. Update from 1.2.0 to 1.3.0 may require recompilation
- same major and minor version mean that you can freely upgrade version of the library