Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
zikani03 committed Apr 24, 2022
1 parent a9ca4a9 commit 17be95b
Showing 1 changed file with 19 additions and 1 deletion.
20 changes: 19 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,24 @@ Jdbi3 Utilities

A set of utilities for working with [Jdbi 3](https://github.com/jdbi/jdbi)

## jdbigen

A command-line program to generate DAO classes from database tables complete with CRUD queries

**Usage**

Generates DAOs as `interface` SqlObjects

`$ jdbigen --package "com.example" --exclude schema_version "postgres://user:password@localhost/database?sslmode=disable"`

Generate DAOs as a regular `class` that uses `Jdbi.withHandle`

`$ jdbigen --sqlhandle --package "com.example" --exclude schema_version "postgres://user:password@localhost/database?sslmode=disable"`

More information [here](jdbigen/README.md)

## Customizers

### Counter

Use the `CounterCustomizer` to automatically update a "counter field" in a table.
Expand Down Expand Up @@ -108,7 +126,7 @@ public class Application {
binding annotation - but that's not been tested thoroughly.


### @UseClasspathSqlLocator compile-time checks
## @UseClasspathSqlLocator compile-time checks

The `useclasspathsql-checker` module implements an Annotation Processor that checks that
SQL files for methods on your DAOs (SqlObjects in JDBI speak) exist and are not empty.
Expand Down

0 comments on commit 17be95b

Please sign in to comment.