Repository files navigation

| | | |

The Jdbi library provides convenient, idiomatic access to relational databases in Java and other JVM technologies such as Kotlin, Clojure or Scala.

Jdbi is built on top of JDBC. If your database has a JDBC driver, you can use Jdbi with it.

• Developer Guide
• Javadoc
• User forums
• Mailing List
• Stack Overflow

Also check out the code examples in theExamples module.

• Jdbi is a recipient of the Spotify FOSS 2023 Fund
• Jdbi is supported by Tidelift

Jdbi requires Java 11 or better to run.

We run CI tests against Java 11, 17 and 21.

Java 8, 9 and 10 are supported by any Jdbi version before3.40.0.

Java 11 is supported by any Jdbi version up to3.50.0.

Java 17 or better is required for Jdbi3.51.0 or newer.

Jdbi has a very small footprint for its core but supports a huge number of other projects for mapping data, supporting data types. etc.

We run our test suite against a number of library versions for backwards compatibility tests. Currently, we test

Libraries:

• Google Guava
• Immutables
• Jackson
• JodaTime
• vavr
• Google Guice
• Kotlin
• Spring Framework

Jdbi will use the latest, stable release of a library. We update these dependencies for releases. For the libraries listed above, we will also test the two previous, stable versions of a library.

Databases:

Jdbi uses PostgreSQL for most of its non-in-memory tests. We test with the latest Postgres release that is supported by our testing libraries and the two previous released versions.

We also run tests inside testcontainers against a large set of databases.

Jdbi requires the latest LTS JDK version (Currently Java 21) or better to build. All release builds are done with the latest LTS version.

Jdbi is "batteries included" and uses theApache Maven Wrapper. If an external Maven installation is used, Apache Maven 3.9 or later is required. Using themake targets requires GNU make.

All build tasks are organized asmake targets.

Build the code an install it into the local repository:

$ make install

Runningmake ormake help displays all available build targets with a short explanation. Some of the goals will require project membership privileges. TheCONTRIBUTING.md document contains a list of all supported targets.

To add command line parameters to the maven executions from the Makefile, set theMAVEN_ARGS variable:

% MAVEN_ARGS="-B -fae" make install

• make tests builds the code and runs all unit and integration tests.
• make run-tests only runs the tests.

Some tests use Postgres and H2 databases (the tests will spin up temporary database servers as needed). Most modern OS (Windows, MacOS, Linux) and host architecture (x86_64, aarch64) should work.

For a full release build, docker or a docker compatible environmentmust be available. A small number of tests use testcontainers which inturn requires docker.

make install-nodocker skips the tests when building and installing Jdbi locally.make tests-nodocker skips the tests when only running tests.

Supported configurations are

• Docker Desktop on MacOS
• docker-ce on Linux
• podman 3 or better on Linux and MacOS

Other docker installations such asColima may work but are untested and unsupported.

For podman on Linux, the podman socket must be activated (seehttps://stackoverflow.com/questions/71549856/testcontainers-with-podman-in-java-tests)for details. SELinux sometimes interferes with testcontainers ifSELinux is active; make sure that there is an exception configured.

For podman on MacOS, it is necessary to set theDOCKER_HOST environment variable correctly.

Please readCONTRIBUTING.mdfor instructions to set up your development environment to build Jdbi.

Jdbi usesSemVer to version its public API.

This project is licensed under theApache 2.0 license.

• Brian McCallister (@brianm) - Project Founder
• Steven Schlansker (@stevenschlansker)
• Henning Schmiedehausen (@hgschmie)

• Artem Prigoda (@arteam)
• Matthew Hall (@qualidafial)
• Markus Spann (@spannm)
• Marnick L'Eau

• Alex Harin (@aharin) - Kotlin plugins.
• Ali Shakiba (@shakiba) - JPA plugin
• @alwins0n - Vavr plugin.
• Fred Deschenes (@FredDeschenes) -Kotlin unchecked extensions forJdbi functions.@BindFields,@BindMethods annotations.