Usage

The maven-oqt-plugin is fairly easy to use but requires a (read-only) connection to a live database to translate the JPQL queries to SQL queries. For proper execution of this plugin, the following items must be on the execution classpath:

  • OpenJPA
  • The JDBC driver
  • Your entities

For the validation of the JPQL queries there's no need for a real database connection.

Below are a few examples to demonstrate the usage of this plugin.

Example 1: Translate

The following plugin configuration will analyze all the entities in the packages net.sf.oqt.test.model (and its subpackages). These packages are provided via the oqt-maven-plugin-it-model artifact. The SQL queries will be generated for a Derby database.

<plugin>
	<groupId>net.sf.oqt</groupId>
	<artifactId>oqt-maven-plugin</artifactId>
	<version>0.1-SNAPSHOT</version>
	<executions>
		<execution>
			<goals>
				<goal>report</goal>
			</goals>
		</execution>
	</executions>
	<configuration>
		<dictionary>derby</dictionary>	<!-- Required -->
		<driverName>org.apache.derby.jdbc.EmbeddedDriver</driverName> <!-- Required -->
		<packageNames>	<!-- At least 1 required. Must be at least a.b.c -->
			<packageName>net.sf.oqt.test.model</packageName> 
		</packageNames>
		<url>jdbc:derby:db/test/derby;create=true;databaseName=example</url> <!-- Required -->
		<username></username> <!-- Not required -->
		<password></password> <!-- Not required -->
	</configuration>
	<dependencies>
		<dependency>	<!-- Mandatory-->
			<groupId>org.apache.openjpa</groupId>
			<artifactId>apache-openjpa</artifactId>
			<version>2.2.1</version>
			<type>pom</type>
		</dependency>
		<dependency>	<!-- Mandatory otherwise, your entities are not on the classpath-->
			<groupId>net.sf.oqt.test</groupId>
			<artifactId>oqt-maven-plugin-it-model</artifactId>
			<version>0.1-SNAPSHOT</version>
		</dependency>
		<dependency>	<!-- Mandatory, depends on driverName -->
			<groupId>org.apache.derby</groupId>
			<artifactId>derby</artifactId>
			<version>10.9.1.0</version>
		</dependency>
		<dependency>	<!-- Mandatory -->
			<groupId>javax</groupId>
			<artifactId>javaee-api</artifactId>
			<version>6.0</version>
		</dependency>
	</dependencies>
</plugin>

If you run mvn site or mvn oqt:report the report will be generated.

Example 2: Validate

The following plugin configuration will validate all the JPQL queries found in the net.sf.oqt.test.model package and it's subpackages. All invalid JPQL queries will be outputted and will cause the build to fail. 

<plugin>
	<groupId>net.sf.oqt</groupId>
	<artifactId>oqt-maven-plugin</artifactId>
	<version>0.1-SNAPSHOT</version>
	<executions>
		<execution>
			<goals>
				<goal>validate</goal>
			</goals>
		</execution>
	</executions>
	<configuration>
		<packageNames>	<!-- At least 1 required. Must be at least a.b.c -->
			<packageName>net.sf.oqt.test.model</packageName> 
		</packageNames>
	</configuration>
	<dependencies>
		<dependency>	<!-- Mandatory-->
			<groupId>org.apache.openjpa</groupId>
			<artifactId>apache-openjpa</artifactId>
			<version>2.2.1</version>
			<type>pom</type>
		</dependency>
		<dependency>	<!-- Not mandatory is plugin is launched inside the model project-->
			<groupId>net.sf.oqt.test</groupId>
			<artifactId>oqt-maven-plugin-it-model</artifactId>
			<version>0.1-SNAPSHOT</version>
		</dependency>
		<dependency>	<!-- Mandatory -->
			<groupId>javax</groupId>
			<artifactId>javaee-api</artifactId>
			<version>6.0</version>
		</dependency>
	</dependencies>
</plugin>

You can quickly validate your queries using mvn validate or mvn oqt:validate.