Koala

Koala is an SQL DSL for Kotlin.

Usage documentation

User docs are under construction here

Developing

Import the project directory into IntelliJ IDEA as a Gradle project.

Running tests

Tests require PostgreSQL and MySQL running in Docker. Start the database instances by running postgres/setup.sh and mysql/setup.sh.

Tests should now run successfully:

./gradlew test

Running the user documentation

To interactively develop the user documentation, run the following task:

./gradlew :docs:docusaurusStart --continuous

This will serve documentation on http://localhost:3000/koala by default.

Contributing

See CONTRIBUTING.md