cliffton / es-kotlin-codegen-plugin

Kotlin code generator using Java Elasticsearch high level rest client

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Actions Status

Introduction

This gradle project is intended for use by the es-kotlin-wrapper-client project. It works by scanning the classes in the Elasticsearch Rest Highlevel client using reflection to generate some useful extension functions for Kotlin. Currently this is mainly limited to adding co-routine friendly versions of the many async functions in the Rest High Level Client. I may add some additional generated code in the future.

The build file of es-kotlin-wrapper-client runs this plugin to get the generated code so we can use that. Unless you know what you are doing and want to e.g. create a PR to change the generated code, you should probably be using es-kotlin-wrapper-client.

Releases

Generally, I try to keep up with the stable Elasticsearch releases and tag releases from master. I use jitpack.io to distribute maven/gradle jars. Check the badge at the top of this page.

Versioning

I tend to mirror Elastics versioning as this plugin runs against their client. So 7.15.0.0 would be the first release intended to work with the 7.15.0 release of the Elasticsearch java client. Elastic tends to do internal refactoring between minor and patch releases and sometimes package names change, or other API changes happen. So, it is important to match the correct version of Elasticsearch and this gradle plugin.

LICENSE

Licensed under the MIT License.

About

Kotlin code generator using Java Elasticsearch high level rest client

License:MIT License


Languages

Language:Kotlin 100.0%