mybatis/mybatis-dynamic-sql

MyBatis Dynamic SQL

What Is This?

This library is a general purpose SQL generator. Think of it as a typesafe and expressive SQL DSL (domain specific language), with support for rendering SQL formatted properly for MyBatis3 and Spring's NamedParameterJDBCTemplate.

The library also contains extensions for Kotlin that enable an idiomatic Kotlin DSL for SQL.

The library will generate full DELETE, INSERT, SELECT, and UPDATE statements. The DSL implemented by the library is very similar to native SQL, but it includes many functions that allow for very dynamic SQL statements. For example, a typical search can be coded with a query like this (the following code is Kotlin, but Java code is very similar):

   data class SearchParameters(val id: String?, val firstName: String?, val lastName: String?)

   fun search(searchParameters: SearchParameters) =
        select(id, firstName, lastName) {
            from(Customer)
            where {
                active isEqualTo true
                and { id isEqualToWhenPresent searchParameters.id }
                and {
                    firstName(isLikeCaseInsensitiveWhenPresent(searchParameters.firstName)
                        .map { "%" + it.trim() + "%" })
                }
                and {
                    lastName(isLikeCaseInsensitiveWhenPresent(searchParameters.lastName)
                        .map { "%" + it.trim() + "%" })
                }
            }
            orderBy(lastName, firstName)
            limit(500)
        }

This query does quite a lot...

1. It is a search with three search criteria - any combination of search criteria can be used
2. Only records with an active status will be returned
3. If id is specified, it will be used as a filter
4. If firstName is specified, it will be used in a case-insensitive search and SQL wildcards will be appended
5. If lastName is specified, it will be used in a case-insensitive search and SQL wildcards will be appended
6. The query results are limited to 500 rows

Using the dynamic SQL features of the library eliminates a lot of code that would be required for checking nulls, adding wild cards, etc. This query clearly expresses the intent of the search in just a few lines.

See the following pages for detailed information:

The library test cases provide several complete examples of using the library in various different styles:

Requirements and Dependencies

Version 2.x requires Java 17 and has a required runtime dependency on JSpecify (https://jspecify.dev/). Version 1.x requires Java 8 and has no required runtime dependencies.

All versions have support for MyBatis3, Spring Framework, and Kotlin - all those dependencies are optional. The library should work in those environments as the dependencies will be made available at runtime.