Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mbuhot/eskotlin
Elasticsearch Query DSL for Kotlin
https://github.com/mbuhot/eskotlin
dsl elasticsearch kotlin
Last synced: 3 months ago
JSON representation
Elasticsearch Query DSL for Kotlin
- Host: GitHub
- URL: https://github.com/mbuhot/eskotlin
- Owner: mbuhot
- License: mit
- Created: 2016-03-16T21:09:47.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-12-15T22:03:48.000Z (11 months ago)
- Last Synced: 2024-05-02T15:26:09.225Z (6 months ago)
- Topics: dsl, elasticsearch, kotlin
- Language: Kotlin
- Size: 247 KB
- Stars: 135
- Watchers: 13
- Forks: 28
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.org/mbuhot/eskotlin)
# ES Kotlin
Elasticsearch Query DSL for Kotlin.
This library aims to minimize the gap between the Elasticsearch JSON query DSL, and the API used when writing kotlin applications.
This integrates with the existing java API, only providing a nicer syntax to build the queries.
# Getting Started
## Gradle
```groovy
repositories {
mavenCentral()
...
maven {
url "http://dl.bintray.com/mbuhot/maven"
}
}
dependencies {
compile 'mbuhot:eskotlin:0.7.0'
...
}
```
See [CHANGELOG](./CHANGELOG.md) for older versions supporting previous elasticsearch client versions.
## Maven
Full details on [bintray](https://bintray.com/mbuhot/maven/eskotlin/)
```xml
mbuhot
eskotlin
0.7.0
pom
```
# Examples
## Term Query
JSON:
```json
{
"term" : { "user" : "Kimchy" }
}
```
Kotlin:
```kotlin
val query = term {
"user" to "Kimchy"
}
```
## Bool Query
JSON:
```json
{
"bool" : {
"must" : {
"term" : { "user" : "kimchy" }
},
"filter": {
"term" : { "tag" : "tech" }
},
"must_not" : {
"range" : {
"age" : { "from" : 10, "to" : 20 }
}
},
"should" : [
{
"term" : { "tag" : "wow" }
},
{
"term" : { "tag" : "elasticsearch" }
}
],
"minimum_should_match" : 1,
"boost" : 1.0
}
}
```
Kotlin:
```kotlin
val query = bool {
must {
term { "user" to "kimchy" }
}
filter {
term { "tag" to "tech" }
}
must_not {
range {
"age" {
from = 10
to = 20
}
}
}
should = listOf(
term { "tag" to "wow" },
term { "tag" to "elasticsearch" })
minimum_should_match = 1
boost = 1.0f
}
```
## Function Score Query
JSON:
```json
{
"function_score": {
"query": {
"match_all": {}
},
"functions": [
{
"filter": {
"term": {
"foo": "bar"
}
},
"gauss": {
"baz": {
"scale": 1.0
}
}
},
{
"filter": {
"match_all": {}
},
"random_score": {
"seed": 234
}
},
{
"exp": {
"qux": {
"scale": 2.3
}
}
}
],
"score_mode": "max",
"boost_mode": "multiply",
"max_boost": 5.0,
"boost": 1.2,
"min_score": 0.001
}
}
```
Kotlin:
```kotlin
val query = function_score {
query = match_all { }
functions = listOf(
term { "foo" to "bar" } to gaussDecayFunction("baz", 1.0),
match_all { } to randomFunction(234L),
null to exponentialDecayFunction("qux", 2.3))
boost = 1.2f
boost_mode = "multiply"
score_mode = "max"
max_boost = 5.0f
min_score = 0.001f
}
```
See the src/test directory for more examples.
# API Coverage
## Full Text Queries - Done
+ [Match](./src/test/kotlin/mbuhot/eskotlin/query/fulltext/MatchTest.kt)
+ [Multi Match](./src/test/kotlin/mbuhot/eskotlin/query/fulltext/MultiMatchTest.kt)
+ [Common Terms](./src/test/kotlin/mbuhot/eskotlin/query/fulltext/CommonTest.kt)
## Term Queries - Done
+ [Term](./src/test/kotlin/mbuhot/eskotlin/query/term/TermTest.kt)
+ [Terms](./src/test/kotlin/mbuhot/eskotlin/query/term/TermsTest.kt)
+ [Range](./src/test/kotlin/mbuhot/eskotlin/query/term/RangeTest.kt)
+ [Exists](./src/test/kotlin/mbuhot/eskotlin/query/term/ExistsTest.kt)
+ [Prefix](./src/test/kotlin/mbuhot/eskotlin/query/term/PrefixTest.kt)
+ [Wildcard](./src/test/kotlin/mbuhot/eskotlin/query/term/WildcardTest.kt)
+ [Regex](./src/test/kotlin/mbuhot/eskotlin/query/term/RegexpTest.kt)
+ [Fuzzy](./src/test/kotlin/mbuhot/eskotlin/query/term/FuzzyTest.kt)
+ [Type](./src/test/kotlin/mbuhot/eskotlin/query/term/TypeTest.kt)
+ [Ids](./src/test/kotlin/mbuhot/eskotlin/query/term/IdsTest.kt)
## Compound Queries - Done
+ [Constant Score](./src/test/kotlin/mbuhot/eskotlin/query/compound/ConstantScoreTest.kt)
+ [Bool](./src/test/kotlin/mbuhot/eskotlin/query/compound/BoolTest.kt)
+ [Dis Max](./src/test/kotlin/mbuhot/eskotlin/query/compound/DisMaxTest.kt)
+ [Function Score](./src/test/kotlin/mbuhot/eskotlin/query/compound/FunctionScoreTest.kt)
+ [Boosting](./src/test/kotlin/mbuhot/eskotlin/query/compound/BoostingTest.kt)
## Joining Queries - Done
+ [Nested](./src/test/kotlin/mbuhot/eskotlin/query/joining/NestedTest.kt)
+ [Has Child](./src/test/kotlin/mbuhot/eskotlin/query/joining/HasChildTest.kt)
+ [Has Parent](./src/test/kotlin/mbuhot/eskotlin/query/joining/HasParentTest.kt)
## Geo Queries - Contributions welcome!
+ Geo Shape
+ Geo Bounding Box
+ Geo Distance Range
+ Geo Polygon
+ Geohash Cell
## Specialized Queries - Contributions welcome!
+ More Like This
+ Template
+ Script
## Span Queries - Contributions welcome!
+ Span Term
+ Span Multi Term
+ Span First
+ Span Near
+ Span Or
+ Span Not
+ Span Containing
+ Span Within
## Aggregations - Contributions welcome!
+ [Nested](./src/test/kotlin/mbuhot/eskotlin/aggregation/NestedAggregationTest.kt)
+ [Filter](./src/test/kotlin/mbuhot/eskotlin/aggregation/FilterAggregationTest.kt)
+ Metrics Aggregations
+ Bucket Aggregations
+ Pipeline Aggregations
+ Matrix Aggregations
# License
MIT - See LICENSE file for full text.