Doma CodeGen Plugin

Doma CodeGen Plugin is a gradle plugin.
It generates Java source files and SQL files from Database.

How to use

The basic build.gradle example is as follows:

buildscript {
    repositories {
        mavenCentral()
    }
    dependencies {
        // specify your JDBC driver
        classpath 'com.h2database:h2:1.3.175'
    }
}

plugins {
    id 'java'
    // specify the Doma CodeGen Plugin with correct version
    id 'org.seasar.doma.codegen' version 'x.x.x'
}

domaCodeGen {
    // make an arbitrary named block
    dev {
        // JDBC url
        url = '...'
        // JDBC user
        user = '...'
        // JDBC password
        password = '...'
        // configuration for generated entity source files
        entity {
          packageName = 'org.example.entity'
        }
        // configuration for generated DAO source files
        dao {
          packageName = 'org.example.dao'
        }
    }
}

To generate all files, run domaCodeGenDevAll task:

$ ./gradlew domaCodeGenDevAll

See also Gradle Plugin Portal.

Sample Project

• codegen-sample

Gradle Tasks

The Doma CodeGen Plugin provides following tasks:

• domaCodeGenNameAll - Generates all.
• domaCodeGenNameDao - Generates DAO source files.
• domaCodeGenNameDto - Reads resultSet metadata and generate a DTO source file.
• domaCodeGenNameEntity - Generates entity source files.
• domaCodeGenNameSql - Generates SQL files.
• domaCodeGenNameSqlTest - Generates SQL test source files.

Note that each Name part in the above task names is replaced with the block name defined under the domaCodeGen block.
In the above usage example, the Dev part is corresponding to the dev block.

To check all defined task names, run the tasks task:

$ ./gradlew tasks

Config Options

named config

A named config must be under the domaCodeGen block.
The name of the config is arbitrary.
You can make multiple configs under the domaCodeGen block.

In the following example, we define two configs - sales and account:

domaCodeGen {
  sales {   
    url = "jdbc:h2:mem:sales" 
  }
  account {
    url = "jdbc:h2:mem:account" 
  }
}

entity

An entity block must be under a named config:

domaCodeGen {
  sales {
    entity {
      useAccessor = false
    }
  }
}

dao

A dao block must be under a named config:

domaCodeGen {
  sales {
    dao {
      packageName = 'org.example.sales.dao'
    }
  }
}

sql

A sql block must be under a named config:

domaCodeGen {
  sales {
    sql {
      overwrite = false
    }
  }
}

Customization

Using custom template files

Default template files are located in the source code repository of the Doma CodeGen Plugin.
They are listed as follows:

To create custom template files, copy them and modify their contents without changing file names. Then put them in the directory which is specified to the templateDir option.

domaCodeGen {
    dev {
        url = '...'
        user = '...'
        password = '...'
        // specify the directory including your custom template files
        templateDir = "$projectDir/template"
        entity {
          packageName = 'org.example.entity'
        }
        dao {
          packageName = 'org.example.dao'
        }
    }
}

The Doma CodeGen Plugin uses Apache FreeMarker to process the template files.