SCOW

A simple code generator (as a maven plugin) for java DTOs and DAOs from raw sql.

What does it do?

Scow takes a directory of files containing SQL select statements and turns those into .java source code files.

The generated DTO classes contain typed fields for every column in the sql file and also DAO methods for querying the data using sql2o.

The DAO methods are built using the name and type of the named queries, which are determined by the jdbc resultSet metadata. This means that the methods do have typed parameters and that a database that is targeted for the SQL queries must be accessible during code generation.

There are also "modifiers" which enable different selection modifiers to be applied for a single query, using the ---: modifierName syntax.

Example

File queries/my/app/sql/User.sql:

SELECT
    *
FROM
    user
---: allOrdered
ORDER BY name
---: getById
WHERE
    id = :id
---: matchByName
WHERE
    name LIKE :name

would emit a file src/gen/java/my/app/sql/UserDto.java

with the contents

package my.app.sql;

// import... 

/**
 * see <a href="file:///path/to/queries/my/app/sql/User.sql">User.sql</a> */
public final class UserDto {
    public Integer id;

    public String name;

    public String password;

    public Timestamp created;

    public static class allOrdered {
        private static final String QUERY = "SELECT\n"
                + "    *\n"
                + "FROM\n"
                + "    users\n"
                + "\n"
                + "ORDER BY name";

        public static Query query(Connection conn) {
            return conn.createQuery(QUERY)
                    ;
        }

        public static List<UserDto> fetchAll(Connection conn) {
            return conn.createQuery(QUERY)
                    .executeAndFetch(UserDto.class);
        }

        public static UserDto fetch(Connection conn) {
            return conn.createQuery(QUERY)
                    .executeAndFetchFirst(UserDto.class);
        }
    }

    public static class getById {
        private static final String QUERY = "SELECT\n"
                + "    *\n"
                + "FROM\n"
                + "    users\n"
                + "\n"
                + "WHERE id=:userId";

        public static Query query(Connection conn, Integer userId) {
            return conn.createQuery(QUERY)
                    .addParameter("userId", userId)
                    ;
        }

        public static List<UserDto> fetchAll(Connection conn, Integer userId) {
            return conn.createQuery(QUERY)
                    .addParameter("userId", userId)
                    .executeAndFetch(UserDto.class);
        }

        public static UserDto fetch(Connection conn, Integer userId) {
            return conn.createQuery(QUERY)
                    .addParameter("userId", userId)
                    .executeAndFetchFirst(UserDto.class);
        }
    }

    public static class matchByName {
        private static final String QUERY = "SELECT\n"
                + "    *\n"
                + "FROM\n"
                + "    users\n"
                + "\n"
                + "WHERE name LIKE :name";

        public static Query query(Connection conn, String name) {
            return conn.createQuery(QUERY)
                    .addParameter("name", name)
                    ;
        }

        public static List<UserDto> fetchAll(Connection conn, String name) {
            return conn.createQuery(QUERY)
                    .addParameter("name", name)
                    .executeAndFetch(UserDto.class);
        }

        public static UserDto fetch(Connection conn, String name) {
            return conn.createQuery(QUERY)
                    .addParameter("name", name)
                    .executeAndFetchFirst(UserDto.class);
        }
    }
}

In your application, usage could look like this:

    try (Connection con = sql2o.open()) {
        // fetch all rows
        List<UserDto> users = UserDto.matchByName.fetchAll(con, "john");

        // or fetch single row
        UserDto adminUser = UserDto.getById.fetch(con, 1);
    }

Limitations

For some reason, jdbc's result set metadata doesn't return usable data for sqlite (Objects only). There's a workaround by providing a partially implemented SqliteTranslator.
There are no sanity checks for modifier composition; Dto class properties are determined by the first modifier; if the rest doesn't match up there will be problems.

Dependencies

Scow outputs code that uses sql2o, so this is a dependency in your project.
Of course you also need to provide the correct jdbc driver.

Maven Plugin configuration example

Note that in this example, the org.codehaus.mojo.properties-maven-plugin is used to keep the (secret) configuration out of the build file.

<project>

    <!-- your project configuration -->

    <pluginRepositories>
        <pluginRepository>
            <id>jitpack.io</id>
            <url>https://jitpack.io</url>
        </pluginRepository>
    </pluginRepositories>

    <build>
        <plugins>
            <plugin>
                <groupId>com.github.h34tnet</groupId>
                <artifactId>scow</artifactId>
                <version>0.2</version>
                <configuration>
                    <inputPath>${project.basedir}/queries</inputPath>
                    <!-- Optional - this is the default value -->
                    <outputPath>${project.build.directory}/generated-sources/scow</outputPath>
            
                    <dsn>${dbjdbcurl}</dsn>
                    <schema>${dbschema}</schema>
                    <username>${dbusername}</username>
                    <password>${dbpassword}</password>
                    <jdbcdriver>org.postgresql.Driver</jdbcdriver>
                </configuration>
                <executions>
                    <execution>
                        <id>scow</id>
                        <!-- optional -->
                        <phase>generate-sources</phase>
                        <goals>
                            <goal>generate-dto</goal>
                        </goals>
                    </execution>
                </executions>
                <dependencies>
                    <dependency>
                        <groupId>org.postgresql</groupId>
                        <artifactId>postgresql</artifactId>
                        <version>42.2.5</version>
                    </dependency>
                </dependencies>
            </plugin>
        </plugins>
    </build>
</project>

Notes

This is all ...

... very limited, read only (SELECT)
... without sanity checks for query modifier composition, i.e. it's possible to generate broken code
... work in progress.

Disclaimer: Don't use this in production ... or do whatever you want.

License

This software is published under the MIT License

h34tnet / scow