jasync sql

Java & Kotlin Async DataBase Driver for MySQL and PostgreSQL written in Kotlin

1667

137

Kotlin

jasync-sql is a Simple, Netty based, asynchronous, performant and reliable database drivers for
PostgreSQL and MySQL written in Kotlin.

Show your ❤ with a ★

Getting started

// Connection to MySQL DB
Connection connection = MySQLConnectionBuilder.createConnectionPool(
               "jdbc:mysql://$host:$port/$database?user=$username&password=$password");
     
// Connection to PostgreSQL DB    
Connection connection = PostgreSQLConnectionBuilder.createConnectionPool(
               "jdbc:postgresql://$host:$port/$database?user=$username&password=$password");
// Execute query
CompletableFuture<QueryResult> future = connection.sendPreparedStatement("select * from table");
// work with result ...
// Close the connection pool
connection.disconnect().get()

See a full example at jasync-mysql-example and jasync-postgresql-example.
More samples on the samples dir.

For docs and info see the wiki.

Download

Maven

<!-- mysql -->
<dependency>
  <groupId>com.github.jasync-sql</groupId>
  <artifactId>jasync-mysql</artifactId>
  <version>2.2.4</version>
</dependency>

<!-- postgresql -->
<dependency>
    <groupId>com.github.jasync-sql</groupId>
    <artifactId>jasync-postgresql</artifactId>
    <version>2.2.4</version>
</dependency>

Gradle

dependencies {
  // mysql
  compile 'com.github.jasync-sql:jasync-mysql:2.2.4'
  // postgresql
  compile 'com.github.jasync-sql:jasync-postgresql:2.2.4'
}

Additional Modules

com.github.jasync-sql:jasync-r2dbc-mysql r2dbc extension.
com.github.jasync-sql:postgis-jasync spatial types support for postgres + postgis.
com.github.jasync-sql:pool-async async objects pool.
com.github.jasync-sql:db-async-common internal module for shared logic.

Overview

This project is a port of mauricio/postgresql-async to Kotlin.
Why? Because the original lib is not maintained anymore, We use it in ob1k, and would like to remove the Scala dependency in ob1k.

If you want information specific to the drivers, check the PostgreSQL README and the
MySQL README.

You can view the project’s change log here.

Follow us on twitter: @jasyncs.

DateTime:

Version 1.x always returns JodaTime when dealing with date types and not the
java.util.Date class nor jdk-8 dates.
Version 2.x works with java 8 DateTime objects (java.time.LocalDateTime and such).
This post can help with migration.

Who is using it

Add your name here!

Is it used in production on large scale?

The graph above is from only couple of services using it. Y-Axis is # of queries per minute.

There is also a TechEmpower test using ktor and jasync-sql.

Zeko SQL Builder compared jasync to hikary and vertex:
jasync-sql-zeko

Compatibility

Latest & greatest version is

The driver was forked from mauricio/postgresql-async and is compatible with it (but not jdbc compatible!). More details in wiki.

R2DBC:

Initial support in jasync 0.9.51.
Support for 0.8 released version since jasync 1.0.12.
Upgrade to GA 1.0 R2DBC (spring boot >= 3) was done in jasync 2.1.0. jaync-sql 2.0.8 will be the last version that’s compatible with r2dbc <= 0.9.1. See also FAQ.

Postgis support added in 2.1.7 (see blog post).

Unix domain socket support was added in 2.1.6 (see #175).

Chanlog is currently documented in github release page. Previous ones can be found here and older here.

Notable changes:

First driver release is version 0.8.20.
First driver release to maven is 1.0.0.
Migrating from joda to java 8 times was done in 2.0.0 (see #233). Versions <= 2.0 are not suppoprted anymore.

Support

Check FAQ or Known Issues or google.
Open an issue here: https://github.com/jasync-sql/jasync-sql/issues
Chat on gitter: https://gitter.im/jasync-sql/support
Ask a question in StackOverflow with jasync-sql tag.

Contributing

Pull requests are welcome!
See CONTRIBUTING.