Built by Maven

Plugin Documentation

This report describes goals, parameters details, requirements and sample usage of this plugin.

Goals

Goals available for this plugin:

Goal Description
tentackle-sql:create Generates an SQL-script to create the database tables according to the model.
tentackle-sql:help Display help information on tentackle-sql-maven-plugin.
Call mvn tentackle-sql:help -Ddetail=true -Dgoal=<goal-name> to display parameter details.
tentackle-sql:migrate Generates an SQL-script to migrate the database tables according to the model.
tentackle-sql:run Runs an SQL script.
Example: 
  mvn tentackle-sql:run -Dscript=src/sql/myscript.sql
tentackle-sql:validate Validates the database against the model.
The build fails if something to migrate found.
Alternative to the validate configuration option of the migrate goal.

System Requirements

The following specifies the minimum requirements to run this Maven plugin:

Maven 3.9.0
JDK 21

System Requirements History

The following specifies the minimum requirements to run this Maven plugin for historical versions:

Plugin Version Maven JDK
from 21.15.0.0 to 21.16.1.0 - 21
from 17.8.0.0 to 17.14.0.2 - 17
16.0-M1 - 16
from 11.2.3.0 to 11.7.4.1 - 11
from 8.2.2.0 to 8.3.0.4 - 8
2.2.0 - 11
from 2.0.4 to 2.1.6 - 8

Usage

You should specify the version in your project's plugin configuration:

<project>
  ...
  <build>
    <!-- To define the plugin version in your parent POM -->
    <pluginManagement>
      <plugins>
        <plugin>
          <groupId>org.tentackle</groupId>
          <artifactId>tentackle-sql-maven-plugin</artifactId>
          <version>21.16.1.0</version>
        </plugin>
        ...
      </plugins>
    </pluginManagement>
    <!-- To use the plugin goals in your POM or parent POM -->
    <plugins>
      <plugin>
        <groupId>org.tentackle</groupId>
        <artifactId>tentackle-sql-maven-plugin</artifactId>
      </plugin>
      ...
    </plugins>
  </build>
  ...
</project>

For more information, see "Guide to Configuring Plug-ins"