MyBatis Generator (MBG)

MyBatis Generator (MBG) is a code generation tool for the MyBatis SQL mapping framework. It automates the creation of several components by introspecting database tables via JDBC DatabaseMetaData:

• SQL Map XML files: Mapping files for MyBatis.
• Java model objects (POJOs): Java classes that correspond to your database tables.
• Java client classes: (Optional) Client classes that utilize the generated model objects.
• Kotlin code: MBG also supports generating Kotlin code for MyBatis.

To identify which features bundle specific plugins in a target runtime, use the OSGi console with a provlquery.

1. Open an OSGi Console from the console view.
2. Find the console number:

   ss p2.console

3. Start the console using the number found:

   start <<consoleNumber>>

4. Run a provlquery to find the feature containing your required dependency. For example, to find which feature bundles org.apache.commons.commons-logging in the 2024-09 release:

   provlquery http://download.eclipse.org/releases/2024-09 "select(parent | parent.properties['org.eclipse.equinox.p2.type.group'] == true && parent.requirements.exists(rc | everything.exists(iu | iu.id == 'org.apache.commons.commons-logging' && iu ~= rc)))" true

5. Use the resulting feature IDs to add them directly to your target platform definition file.

To use MyBatis Generator, ensure your environment meets the following requirements:

1. JRE: Java 8 or above is required.
2. JDBC Driver: You must provide a JDBC driver that implements the DatabaseMetaData interface. Specifically, the driver must correctly implement the getColumns and getPrimaryKeys methods to allow MBG to introspect your database schema.

Use the Maven wrapper (./mvnw) to build the project. Use the following commands depending on your goal:

• Verify the build: Run integration tests to ensure the build is functional.
• Create a release version: Build the project and create a new version suitable for publishing.

If Eclipse warns that the plugin execution environment is lower than a plugin dependency (e.g., targeting environment 2021-06 which requires JDK 11), perform the following updates:

1. Update MANIFEST.MF: Update the execution environment in the MANIFEST.MF files for:
   • org.mybatis.generator.core
   • org.mybatis.generator.eclipse.ui
   • org.mybatis.generator.eclipse.ui.tests
2. Update Project Definitions: Update .classpath and org.eclipse.jdt.core.prefs (you can use the quick fix helper in the MANIFEST.MF file).
3. Update Parent POM: Update the source and compile versions in the parent POM and the toolchain definition to match the new environment.

The core product and Maven plugin are released using standard Maven release support.

Prerequisites for Unix/Mac users: Set up GPG to use the terminal for password prompts:

export GPG_TTY=$(tty)

Release Steps:

1. Clone the main repository via SSH and checkout the master branch.
2. Navigate to the core directory.
3. Execute the Maven release preparation and performance commands.
4. Verify the deployment at Sonatype Central (Profile -> View Deployments) and publish it manually if required.

cd core
./mvnw release:prepare
./mvnw release:perform

Before building with Maven, you must set up a toolchain by adding a toolchains.xml file to your ~/.m2 directory. This ensures the correct JDK is used during the build process.

<?xml version="1.0" encoding="UTF8"?>
<toolchains>
  <toolchain>
    <type>jdk</type>
    <provides>
      <version>17</version>
      <vendor>temurin</vendor>
    </provides>
    <configuration>
      <jdkHome>/Users/xxx/.sdkman/candidates/java/17.0.16-tem</jdkHome>
    </configuration>
  </toolchain>
</toolchains>

You can manually configure an Eclipse update site to install the generator.

Use the following update site URL in Eclipse: https://jeffgbutler.github.io/mybatis-generator-update-site/

For manual installation, you can download a zip file containing the update site directly from the GitHub releases page.

1. Go to the GitHub releases page: https://github.com/mybatis/generator/releases
2. Download the release bundle zip file.
3. Manually install the plugin into your Eclipse environment.