kt-search

Multi platform kotlin client for Elasticsearch & Opensearch with easily extendable Kotlin DSLs for queries, mappings, bulk, and more.

---

Project maintained by jillesvangurp Hosted on GitHub Pages — Theme by mattgraham

KT Search Manual

Kt-search is a Kotlin Multi Platform library to search across the Opensearch and Elasticsearch ecosystem on any platform that kotlin can compile to. It provides Kotlin DSLs for querying, defining mappings, bulk indexing, index templates, index life cycle management, index aliases, and much more. The key goal for this library is to provide a best in class developer experience for using Elasticsearch and Opensearch.

Related Links

• jillesvangurp/kt-search - the main Github project for kt-search.
• kt-search-kts - Kotlin scripting support for kt-search. Uses kotlinx-cli to make scripting really easy and enables you to write your own .main.kts files. Combined with the out of the box support for managing snapshots, creating template mappings, bulk indexing, data-streams, etc. this is the perfect companion to script all your index operations. Additionally, it’s a great tool to e.g. query your data, or build some health checks against your production indices.
• kt-search-logback-appender - this is a logback appender that bulk indexes log events straight to elasticsearch. Nice if you are using a jvm based project and want to aggregate your logs to elasticsearch/kibana.

Table of contents

• What is Kt-Search
• Getting Started
• Indices, Settings, Mappings, and Aliases
• Search and Queries
• Text Queries
• Term Level Queries
• Compound Queries
• Geo Spatial Queries
• Aggregations
• Deep Paging Using search_after and scroll
• Deleting by query
• Document Manipulation
• Index Repository
• Efficiently Ingest Content Using Bulk Indexing
• Creating Data Streams
• Migrating from the old Es Kotlin Client
• Extending the Json DSLs
• Using Kotlin Scripting
• Jupyter Notebooks

About this Manual

This manual documents how to use the kotlin search client and all of its features. As a manual like this contains a lot of code samples, I ended up writing a mini framework to allow me to generate markdown from Kotlin.

The project for this is called Kotlin4Example. Most of the documentation you will find here has correct code samples that get tested and compiled whenever this project is built and whenever something gets refactored that would affect one of the code samples.