Java/jOOQ: Add code generation add-on for Gradle, with reflection from SQL DDL files #11

amotl · 2023-01-24T16:43:02Z

About

As a followup to GH-9, this patch adds the Gradle-based jOOQ code generation add-on. It can be invoked like:

./gradlew generateJooq

The style of code generation exercised here works by reflecting the database schema from existing SQL DDL files.

✅ Contrary to GH-10, this works well. ✅

Details

This time, the code within the src/generated folder has truly been generated using jOOQ 3.17.7.

The code generator class used for this procedure was org.jooq.meta.extensions.ddl.DDLDatabase.
The relevant upstream documentation DDLDatabase: Code generation from SQL files has more details.

by-language/java-jooq/README.rst

mkleen · 2023-01-25T09:00:27Z

This looks promising. I guess this only works without having any CrateDB-specific schema definitions since it has to pass the jOQL parser and will then be created in a H2 memory database.

mkleen · 2023-01-25T09:03:23Z

Can we then create the domain model based on the code generation from the SQL files ?

mkleen · 2023-01-25T09:16:26Z

by-language/java-jooq/README.rst

-  into a set of Java classes. This feature currently does not work with CrateDB
-  yet. The code provided within the ``src/generated`` directory has not been
-  derived by reflecting the database schema from CrateDB.
+- `jOOQ's code generator`_ currently does not work with directly connecting to


I would probably mention that since we are using the psql jdbc driver and we are bound to JOOQ parser, we can only use sql-standard/psql based definitions.

I guess this only works without having any CrateDB-specific schema definitions since it has to pass the jOQL parser and will then be created in a H2 memory database.

I would probably mention that since we are using the psql jdbc driver and we are bound to JOOQ parser, we can only use sql-standard/psql based definitions.

You are right. Thanks!

11:06:01 SEVERE DDLDatabase Error : Your SQL string could not be parsed or interpreted. This may have a variety of reasons, including: - The jOOQ parser doesn't understand your SQL - The jOOQ DDL simulation logic (translating to H2) cannot simulate your SQL

I've improved the "Caveats" section with 15ae4cd. Thank you again.

Hi again. I've diverted the documentation updates to GH-12 after the review.

mkleen · 2023-01-25T09:17:43Z

by-language/java-jooq/src/generated/java/io/crate/demo/jooq/model/DefaultCatalog.java

@@ -17,13 +15,6 @@
 /**
 * This class is generated by jOOQ.
 */
-@Generated(


I think having the code generated is ok as long as it's possible to do so out of the box.

As the description stated, all these files are generated now. For whatever reason these comments don't get generated anymore.

ok, i did not know this.

mkleen · 2023-01-25T09:18:18Z

by-language/java-jooq/src/test/java/io/crate/demo/jooq/ApplicationTest.java

@@ -40,7 +40,7 @@ public void testExampleWithDynamicSchema() throws SQLException, IOException {

        // Check number of records.
        DSLContext db = app.getDSLContext();
-        int count = db.fetchCount(DSL.selectFrom("testdrive.book"));


Maybe a few more advanced queries would be nice.

Thanks. I've planned to exercise more advanced queries within a subsequent iteration.

The backlog now enumerates a number of items which may be addressed on behalf of later iterations.

seut

Cool stuff, just some more minor suggestions.

seut · 2023-01-25T09:17:18Z

by-language/java-jooq/README.rst

+- We have not been able to make multiple SQL DDL statements work within a
+  single SQL bootstrap file at ``src/main/resources/bootstrap.sql``.


Is this really a caveat? Isn't defining dedicated SQL files for each table even a cleaner way?

I am not sure. I think when using a framework managing your data migrations, there is usually one file per schema-change iteration, containing multiple ALTER TABLE statements. This caveat is here as a reminder that I discovered issues in this area, and that I would like to revisit the topic on a subsequent iteration.

See also #12 (review).

seut

👍

mkleen

Very nice 👍

by-language/java-jooq/src/main/java/io/crate/demo/jooq/Application.java

This time, the code within the `src/generated` folder has truly been generated using jOOQ 3.17.7. - The code generator used for that is `DDLDatabase` [1]. - The relevant upstream documentation is [2]. [1] org.jooq.meta.extensions.ddl.DDLDatabase [2] https://www.jooq.org/doc/latest/manual/code-generation/codegen-ddl/

amotl requested review from seut, mkleen and matriv January 24, 2023 16:43

amotl mentioned this pull request Jan 24, 2023

Java/jOOQ: Add basic demo application and testing rig #9

Merged

amotl commented Jan 24, 2023

View reviewed changes

by-language/java-jooq/README.rst Outdated Show resolved Hide resolved

amotl force-pushed the amo/jooq/codegen-sql branch 2 times, most recently from f715102 to 86a1483 Compare January 24, 2023 22:39

mkleen reviewed Jan 25, 2023

View reviewed changes

seut reviewed Jan 25, 2023

View reviewed changes

amotl force-pushed the amo/jooq/codegen-sql branch from 86a1483 to 15ae4cd Compare January 25, 2023 10:19

amotl requested review from seut and mkleen January 25, 2023 10:20

seut approved these changes Jan 25, 2023

View reviewed changes

mkleen approved these changes Jan 25, 2023

View reviewed changes

Base automatically changed from amo/jooq/baseline to main January 25, 2023 10:42

Java/jOOQ: Add jOOQ code generation add-on for Gradle

a68847a

amotl force-pushed the amo/jooq/codegen-sql branch from 15ae4cd to ab9187e Compare January 25, 2023 10:42

amotl commented Jan 25, 2023

View reviewed changes

by-language/java-jooq/src/main/java/io/crate/demo/jooq/Application.java Outdated Show resolved Hide resolved

amotl force-pushed the amo/jooq/codegen-sql branch from ab9187e to 6870718 Compare January 25, 2023 13:59

amotl merged commit 538e160 into main Jan 25, 2023

amotl deleted the amo/jooq/codegen-sql branch January 25, 2023 14:02

amotl mentioned this pull request Jan 25, 2023

Java/jOOQ: Improve documentation #12

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Java/jOOQ: Add code generation add-on for Gradle, with reflection from SQL DDL files #11

Java/jOOQ: Add code generation add-on for Gradle, with reflection from SQL DDL files #11

amotl commented Jan 24, 2023 •

edited

Loading

mkleen commented Jan 25, 2023 •

edited by amotl

Loading

mkleen commented Jan 25, 2023

mkleen Jan 25, 2023

amotl Jan 25, 2023

amotl Jan 25, 2023

amotl Jan 25, 2023

mkleen Jan 25, 2023

seut Jan 25, 2023

mkleen Jan 25, 2023

mkleen Jan 25, 2023

amotl Jan 25, 2023

mkleen Jan 25, 2023

amotl Jan 25, 2023

seut left a comment

seut Jan 25, 2023

amotl Jan 25, 2023

amotl Jan 25, 2023 •

edited

Loading

amotl Jan 25, 2023

seut Jan 25, 2023

amotl Jan 25, 2023

amotl Jan 25, 2023

seut left a comment

mkleen left a comment

		- We have not been able to make multiple SQL DDL statements work within a
		single SQL bootstrap file at ``src/main/resources/bootstrap.sql``.

+                                          property {
+                                              key = 'unqualifiedSchema'
+                                              value = 'none'

Java/jOOQ: Add code generation add-on for Gradle, with reflection from SQL DDL files #11

Java/jOOQ: Add code generation add-on for Gradle, with reflection from SQL DDL files #11

Conversation

amotl commented Jan 24, 2023 • edited Loading

About

Details

mkleen commented Jan 25, 2023 • edited by amotl Loading

mkleen commented Jan 25, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

seut left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

amotl Jan 25, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

seut left a comment

Choose a reason for hiding this comment

mkleen left a comment

Choose a reason for hiding this comment

amotl commented Jan 24, 2023 •

edited

Loading

mkleen commented Jan 25, 2023 •

edited by amotl

Loading

amotl Jan 25, 2023 •

edited

Loading