Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mybatis/mybatis-dynamic-sql
SQL DSL (Domain Specific Language) for Kotlin and Java. Supports rendering for MyBatis or Spring JDBC Templates
https://github.com/mybatis/mybatis-dynamic-sql
functional-programming java-8 kotlin kotlin-dsl mybatis mybatis3 spring-jdbctemplate sql-dsl sql-generation sql-generator
Last synced: 7 days ago
JSON representation
SQL DSL (Domain Specific Language) for Kotlin and Java. Supports rendering for MyBatis or Spring JDBC Templates
- Host: GitHub
- URL: https://github.com/mybatis/mybatis-dynamic-sql
- Owner: mybatis
- License: apache-2.0
- Created: 2016-11-11T15:22:00.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2025-01-05T23:56:19.000Z (16 days ago)
- Last Synced: 2025-01-08T18:05:58.938Z (14 days ago)
- Topics: functional-programming, java-8, kotlin, kotlin-dsl, mybatis, mybatis3, spring-jdbctemplate, sql-dsl, sql-generation, sql-generator
- Language: Java
- Homepage: http://www.mybatis.org/mybatis-dynamic-sql/docs/introduction.html
- Size: 27.5 MB
- Stars: 1,110
- Watchers: 65
- Forks: 212
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# MyBatis Dynamic SQL
[](https://github.com/mybatis/mybatis-dynamic-sql/actions?query=workflow%3A%22Java+CI%22)
[](https://coveralls.io/github/mybatis/mybatis-dynamic-sql?branch=master)
[](https://maven-badges.herokuapp.com/maven-central/org.mybatis.dynamic-sql/mybatis-dynamic-sql)
[](https://oss.sonatype.org/content/repositories/snapshots/org/mybatis/dynamic-sql/mybatis-dynamic-sql/)
[](https://www.apache.org/licenses/LICENSE-2.0.html)
[](https://sonarcloud.io/dashboard?id=mybatis_mybatis-dynamic-sql)
[](https://sonarcloud.io/dashboard?id=mybatis_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):
```kotlin
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:
| Page | Comments |
|--------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Quick Start](src/site/markdown/docs/quickStart.md) | Shows a complete example of building code for this library |
| [MyBatis3 Support](src/site/markdown/docs/mybatis3.md) | Information about specialized support for [MyBatis3](https://github.com/mybatis/mybatis-3). The examples on this page are similar to the code generated by [MyBatis Generator](https://github.com/mybatis/generator) |
| [Kotlin Support with MyBatis3](src/site/markdown/docs/kotlinMyBatis3.md) | Information about the Kotlin extensions and Kotlin DSL when using MyBatis3 as the runtime |
| [Spring Support](src/site/markdown/docs/spring.md) | Information about specialized support for Spring JDBC Templates |
| [Kotlin Support with Spring](src/site/markdown/docs/kotlinSpring.md) | Information about the Kotlin extensions and Kotlin DSL when using Spring JDBC Template as the runtime |
| [Spring Batch Support](src/site/markdown/docs/springBatch.md) | Information about specialized support for Spring Batch using the [MyBatis Spring Integration](https://github.com/mybatis/spring) |
The library test cases provide several complete examples of using the library in various different styles:
| Language | Runtime | Comments | Code Directory |
|----------|------------------------------------------|------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------|
| Java | MyBatis3 | Example using Java utility classes for MyBatis in the style of MyBatis Generator | [../examples/simple](src/test/java/examples/simple) |
| Java | MyBatis3 + MyBatis-Spring | Example using MyBatis-Spring integration | [../examples/column/comparison](src/test/java/examples/column/comparison) |
| Java | MyBatis3 + MyBatis-Spring (Spring Batch) | Example using Java utility classes for the MyBatis integration with Spring Batch | [../examples/springbatch](src/test/java/examples/springbatch) |
| Java | Spring JDBC | Example using Java utility classes for Spring JDBC Template | [../examples/spring](src/test/java/examples/spring) |
| Kotlin | MyBatis3 | Example using Kotlin utility classes for MyBatis in the style of MyBatis Generator | [../examples/kotlin/mybatis3/canonical](src/test/kotlin/examples/kotlin/mybatis3/canonical) |
| Kotlin | MyBatis3 + MyBatis-Spring | Example using MyBatis-Spring integration in Kotlin | [../examples/kotlin/mybatis3/column/comparison](src/test/kotlin/examples/kotlin/mybatis3/column/comparison) |
| Kotlin | Spring JDBC | Example using Kotlin utility classes for Spring JDBC Template | [../examples/kotlin/spring/canonical](src/test/kotlin/examples/kotlin/spring/canonical) |
## 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.