Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jklingsporn/vertx-jooq

A jOOQ-CodeGenerator to create vertx-ified DAOs and POJOs.
https://github.com/jklingsporn/vertx-jooq

java jdbc jooq reactive rxjava2 rxjava3 vertx vertx-jooq

Last synced: about 2 months ago
JSON representation

A jOOQ-CodeGenerator to create vertx-ified DAOs and POJOs.

Host: GitHub
URL: https://github.com/jklingsporn/vertx-jooq
Owner: jklingsporn
License: mit
Created: 2016-11-03T09:21:43.000Z (almost 8 years ago)
Default Branch: master
Last Pushed: 2024-01-11T11:28:15.000Z (8 months ago)
Last Synced: 2024-06-19T03:07:52.061Z (3 months ago)
Topics: java, jdbc, jooq, reactive, rxjava2, rxjava3, vertx, vertx-jooq
Language: Java
Homepage:
Size: 2.88 MB
Stars: 379
Watchers: 23
Forks: 53
Open Issues: 45
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

new-and-awesome - jOOQ - Doing typesafe, asynchronous SQL and generate code using . (Back-End Development / [Vert.x](https://github.com/vert-x3/vertx-awesome))
vertx-awesome - jOOQ - Doing typesafe, asynchronous SQL and generate code using jOOQ. (Database Clients)

README

        # vertx-jooq

A [jOOQ](http://www.jooq.org/)-CodeGenerator to create [vertx](http://vertx.io/)-ified DAOs and POJOs!

Perform all CRUD-operations asynchronously and convert your POJOs from/into a `io.vertx.core.json.JsonObject` using the API and

driver of your choice.

## latest release 6.5.5

- Fix Use enum literal instead of toString for datatype conversion [#209](https://github.com/jklingsporn/vertx-jooq/issues/209)

- Update to jooq 3.17.3

- Update to vertx 4.3.3

- Update mutiny dependencies

- Update rx dependencies

## different needs, different apis

![What do you want](https://media.giphy.com/media/E87jjnSCANThe/giphy.gif)

Before you start generating code using vertx-jooq, you have to answer these questions:

- **Which API do you want to use?**

  - a `io.vertx.core.Future`-based API. This is `vertx-jooq-classic`.

  - a [rxjava2](https://github.com/ReactiveX/RxJava/tree/2.x) based API. This is `vertx-jooq-rx`.

  - a [rxjava3](https://github.com/ReactiveX/RxJava) based API. This is `vertx-jooq-rx3`.

  - a [mutiny](https://smallrye.io/smallrye-mutiny/) based API. This is `vertx-jooq-mutiny`.

- **How do you want to communicate with the database?**

  - Using good old JDBC, check for the modules with `-jdbc` suffix.

  - Using the [reactive vertx](https://github.com/eclipse-vertx/vertx-sql-client) database driver, check for `-reactive` modules.

- **Do you need extras?**

  - Support for [Guice](https://github.com/google/guice) dependency injection

  - Generation of `io.vertx.codegen.annotations.@DataObject`-annotations for your POJOs

  

Once you made your choice, you can start to configure the code-generator. This can be either done programmatically or

 using a maven- / gradle-plugin (recommended way). 

Please check the documentation in the module of the API and driver of your choice how to set it up and how to use it:

- [`vertx-jooq-classic-jdbc`](vertx-jooq-classic-jdbc)

- [`vertx-jooq-classic-reactive`](vertx-jooq-classic-reactive)

- [`vertx-jooq-rx-jdbc`](vertx-jooq-rx-jdbc)

- [`vertx-jooq-rx-reactive`](vertx-jooq-rx-reactive)

- [`vertx-jooq-rx3-jdbc`](vertx-jooq-rx3-jdbc)

- [`vertx-jooq-rx3-reactive`](vertx-jooq-rx3-reactive)

- [`vertx-jooq-mutiny-jdbc`](vertx-jooq-mutiny-jdbc)

- [`vertx-jooq-mutiny-reactive`](vertx-jooq-mutiny-reactive)

## example

Once the generator is set up, it can create DAOs like in the code snippet below (classic-API, JDBC, no dependency injection):

```java

//Setup your jOOQ configuration

Configuration configuration = ...

//setup Vertx

Vertx vertx = Vertx.vertx();

//instantiate a DAO (which is generated for you)

SomethingDao dao = new SomethingDao(configuration,vertx);

//fetch something with ID 123...

dao.findOneById(123)

    .onComplete(res->{

    		if(res.succeeded()){

        		vertx.eventBus().send("sendSomething", res.result().toJson())

    		}else{

    				System.err.println("Something failed badly: "+res.cause().getMessage());

    		}

    });

//maybe consume it in another verticle

vertx.eventBus().consumer("sendSomething", jsonEvent->{

    JsonObject message = jsonEvent.body();

    //Convert it back into a POJO...

    Something something = new Something(message);

    //... change some values

    something.setSomeregularnumber(456);

    //... and update it into the DB

    Future updatedFuture = dao.update(something);

});

//or do you prefer writing your own type-safe SQL? Use the QueryExecutor from the DAO...

ClassicQueryExecutor queryExecutor = dao.queryExecutor();

//... or create a new one when there is no DAO around :)

queryExecutor = new JDBCClassicGenericQueryExecutor(configuration,vertx);

Future updatedCustom = queryExecutor.execute(dslContext ->

				dslContext

				.update(Tables.SOMETHING)

				.set(Tables.SOMETHING.SOMEREGULARNUMBER,456)

				.where(Tables.SOMETHING.SOMEID.eq(something.getSomeid()))

				.execute()

);

//check for completion

updatedCustom.onComplete(res->{

		if(res.succeeded()){

				System.out.println("Rows updated: "+res.result());

		}else{

				System.err.println("Something failed badly: "+res.cause().getMessage());

		}

});

```

More examples can be found [here](https://github.com/jklingsporn/vertx-jooq/blob/master/vertx-jooq-generate/src/test/java/io/github/jklingsporn/vertx/jooq/generate/classic/ClassicTestBase.java), [here](https://github.com/jklingsporn/vertx-jooq/blob/master/vertx-jooq-generate/src/test/java/io/github/jklingsporn/vertx/jooq/generate/rx3/RX3TestBase.java) and [here](https://github.com/jklingsporn/vertx-jooq/blob/master/vertx-jooq-generate/src/test/java/io/github/jklingsporn/vertx/jooq/generate/mutiny/MutinyTestBase.java).

# FAQ

## vertx is cool, but what about quarkus?

Checkout [this repository](https://github.com/jklingsporn/quarkus-jooq-reactive-example) to figure out how to utilize vertx-jooq to create Quarkus-compatible classes.

## handling custom datatypes

The generator will omit datatypes that it does not know, e.g. `java.sql.Timestamp`. To fix this, you can subclass the generator, handle these types and generate the code using your generator.

 See the `handleCustomTypeFromJson` and `handleCustomTypeToJson` methods in the `AbstractVertxGenerator` or checkout the [`CustomVertxGenerator`](vertx-jooq-generate/src/test/java/io/github/jklingsporn/vertx/jooq/generate/custom)

 from the tests.

 

## is vertx-jooq compatible with Java 8? 

Starting with version `6.4.0`, vertx-jooq implicitly requires Java 11, as this is the minimum required version by the non-commercial version of jOOQ `3.15`. 

If you're stuck with Java 8, the latest version you can use is `6.3.0`. 

## are you sure this works?

Yes! There are [many integration tests](https://github.com/jklingsporn/vertx-jooq/tree/master/vertx-jooq-generate/src/test/java/io/github/jklingsporn/vertx/jooq/generate) that cover most usecases. 

Check them out if you're interested.

### how to run tests

The tests are executed against two docker containers. Please refer to [this readme](docker/README.md) of how to set them up.

#### I receive a "Too many open files" exception on **macOS**

Increase your file limits. Unfortunately the solution differs by each OS version, so you have to do some research.

# disclaimer

This library comes without any warranty - just take it or leave it. Also, the author is neither connected to the

company behind vertx nor the one behind jOOQ.