PL/SQL Connector Builder Maven-Plugin Documentation

Installation

• Download PL/SQL Connector Builder Maven-Plugin : plsql_connectorbuilder_maven_plugin_2.5.39.zip
• The Oracle driver ojdbc8.jar is already embedded in the Maven plugin.
• Call the command line script file install.[sh|cmd]] from the command line.
• The PL/SQL Connector Builder Maven-Plugin is now installed in your local repository.

Configure pom.xml

XML-File : pom.xml

<build>
  <plugins>
    ...
    <plugin>
      <groupId>de.jrdatabasetools.dbworkbench</groupId>
      <artifactId>connectorbuilder-maven-plugin</artifactId>
      <version>2.5.39</version>
      <configuration>
        <connectorBuilderName>rmi</connectorBuilderName>
        <url>${db.url}</url>
        <user>${db.username}</user>
        <password>${db.password}</password>
        <info>warning</info>
        <connection_login_timeout>10</connection_login_timeout>
        <connection_pool_max_size>8</connection_pool_max_size>
        <connection_pool_validate_on_borrow>true</connection_pool_validate_on_borrow>
        <connection_pool_validate_wait_timeout>20000</connection_pool_validate_wait_timeout>
        <connection_pool_borrow_timeout>60000</connection_pool_borrow_timeout>
      </configuration>
      <executions>
        <execution>
          <phase>generate-sources</phase>
          <goals>
            <goal>run</goal>
          </goals>
        </execution>
      </executions>
    </plugin>
    ...
  </plugins>
</build>

• connectorBuilderName : Name of the connector builder (required).
• url, user, password : Connection parameter overwrites setting of the connector builder (optional).
• info : Information level of output during connector builder run. Valid values : all, compact, warning (optional, default:all).
• connection_login_timeout : wait number of seconds to connect to database (default:10 seconds).
• connection_pool_max_size : maximum number of connections in pool (default: 8).
• connection_pool_borrow_timeout : maximum time in milliseconds to acquire connection from connection pool (default:60000 ms).
• connection_pool_validate_on_borrow : verify connection after acquire from pool before usage (default:false).
• connection_pool_validate_wait_timeout : timeout in seconds to verify connection after acquire (default:5 seconds).

Run PL/SQL Connector Builder from command line

• The file 'plsqlworkbench.cfg' saved by the UI-Configurator stores the PL/SQL Connector Builder configuration. It must exists in the same folder.
• mvn connectorbuilder:run

Info

• The PL/SQL Connector Builder will run on any build process of maven.
• The Connector Builder types with separated client and server parts needs configuration of the client and the server project. Both connector builder runs separately.