JDBX

JDBX is a library which provides replacements for Java JDBC Statement and ResultSet classes to allow you to write compact and concise Java database code.

It shares this intent with libraries like Apache DBUtils, Spring JDBC template, JDBI, etc which all wrap plain JDBC to make database access easier. But unlike these libraries JDBX does not only simplify coding but still provides an API which retains 100% of the original JDBC functionality.

JDBX requires Java 11+, has no external dependencies and is released under the Apache 2.0 license.

• Examples
• Download and Installation
• Documentation
• License

Examples

The following snippets show two examples of typical JDBC code and the JDBX rewrite, to give you an impression how JDBX reduces boilerplate database code:

Example 1: Perform a SQL select, create a data object for every result row, return the objects stored in a List.

using JDBC:

public List<City> queryCities(Connection con) throws SQLException {
    List<City> list = new ArrayList<>();
    try (Statement stmt = con.createStatement()) {
        ResultSet result = stmt.executeQuery("SELECT * FROM Cities ORDER BY name");
        while (result.next())
            list.add(City.read(result));
    }
    return list;
}

using JDBX:

public List<City> queryCities(Connection con) {
    return Jdbx.query(con, "SELECT * FROM Cities ORDER BY name").rows().read(City::read);
}

Example 2: Perform a parameterized INSERT, return the auto generated primary key, convert any SQLException to a runtime exception.

using JDBC:

public Integer createUser(Connection con, String firstName, String lastName) {
    try (PreparedStatement pstmt = con.prepareStatement("INSERT INTO Users VALUES (DEFAULT, ?, ?)",
        new String[] { "id" })) {
        pstmt.setString(1, firstName);
        pstmt.setString(2, lastName);
        if (pstmt.executeUpdate() != 1)
            throw new IllegalStateException("insert failed");
        Integer id = null;
        ResultSet result = pstmt.getGeneratedKeys();
        if (result.next())
            id = result.getObject(1, Integer.class);
        if (id == null)
            throw new IllegalStateException("id not returned");
        return id;
    }
    catch (SQLException e) {
        throw new IllegalStateException("sql error", e);
    }
}

using JDBX:

public Integer createUser(Connection con, String firstName, String lastName) {
    try (PrepStmt pstmt = new PrepStmt(con)) {
        return pstmt.init().returnCols("id").sql("INSERT INTO Users VALUES (DEFAULT, ?, ?)")
            .params(firstName, lastName);
            .createUpdate().runGetCol(Integer.class).requireCount(1).requireValue();
    }
}

Download and Installation

• Download the latest release.
• and put the JDBX jar file into the classpath.

Documentation

• User Guide: explains how to use JDBX.
• Design: Discusses the design of JDBX and the refactorings applied to JDBC.
• Build: How to build JDBX.

License

JDBX is released under the Apache 2.0 license.