https://github.com/vlachenal/sql-request-builder
Dynamic SQL request builder
https://github.com/vlachenal/sql-request-builder
fluent java sql
Last synced: 6 months ago
JSON representation
Dynamic SQL request builder
- Host: GitHub
- URL: https://github.com/vlachenal/sql-request-builder
- Owner: vlachenal
- License: lgpl-3.0
- Created: 2018-08-16T19:36:36.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2023-02-26T11:10:06.000Z (over 3 years ago)
- Last Synced: 2023-07-01T02:41:50.656Z (almost 3 years ago)
- Topics: fluent, java, sql
- Language: Java
- Size: 952 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.org/vlachenal/sql-request-builder) [](https://codeclimate.com/github/vlachenal/sql-request-builder/maintainability) [](https://codeclimate.com/github/vlachenal/sql-request-builder/test_coverage)
[](https://search.maven.org/search?q=g:%22com.github.vlachenal%22%20AND%20a:%22sql-request-builder%22)
# sql-request-builder
Dynamic SQL request builder aims to provides a fluent API to easily write dynamic SQL request.
## Synopsis
In most web services, there are search features. These features may have several optional filters which will add clauses in SQL request.
Managing every filter makes your source code more complex and less readable. And the more your service have filters, less your code is readable.
This library provides a fluent API to add clauses only when filter has a valid value (by default not null and not empty). I try to make API to use as easy as if you were writing SQL request.
Every valid value will be added as prepared statement value to avoid SQL injections.
I will not recommend to use this library for static SQL request. It will induce overhead compared to static SQL query string.
## Requirements
sql-request-builder is a standalone library. The only requirement is Java 1.8+.
Build and unit tests are automatically executed with Oracle JDK 1.8 and OpenJDK 10.
## Installation
sql-request-builder library is published on Maven Central.
If you are using Maven, you can add the following dependency to your `pom.xml`:
```xml
com.github.vlachenal
sql-request-builder
0.13
```
If you are using Gradle, you can add the following dependency:
```groovy
compile "com.github.vlachenal:sql-request-builder:0.13"
```
Otherwise, you can clone this repository and build library using `jar` task.
## Documentation
### Javadoc
You can consult Javadoc [here](https://vlachenal.github.io/sql-request-builder/index.html?com/github/vlachenal/sql/package-summary.html).
### Wiki
[Wiki](https://github.com/vlachenal/sql-request-builder/wiki) contains detailled library usage, releases notes and remaining tasks.
### Examples
More examples can be found in unit tests and wiki.
Here is a sample of library usage:
The following request bean:
```java
public class ExampleRequest {
public UUID id;
public String firstName;
public String lastName;
public String email;
public String gender;
public String country;
}
```
is filled with the following values:
```java
final ExampleRequest req = new ExampleRequest();
req.gender = "F";
req.lastName = "%Croft%";
```
The following code will generate an SQL request to retrieve 'heroes' according to the request:
```java
final SQLQuery query = SQL.select().field("*")
.from("Heroes")
.where(SQL.clauses("id", Clauses::equalsTo, req.id)
.and("first_name", Clauses::like, req.firstName)
.and("last_name", Clauses::like, req.lastName)
.and("email", Clauses::equalsTo, req.email)
.and("gender", Clauses::equalsTo, req.gender)
.and("country", Clauses::equalsTo, req.country)
).build();
```
The generated SQL request will be:
```sql
SELECT * FROM Heroes WHERE last_name LIKE ? AND gender = ?
```
With `%Croft%` and `F` as values.
Query and values can be retrieved like this:
```java
String strQuery = query.getQuery();
List valueLst = query.getValues();
Object[] values = query.values();
```