blob: 989482cca2ced1e3459913d27ca3fe8405556bf9 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!-- Generated by Apache Maven Doxia Site Renderer 1.8.1 from org.apache.maven.plugins:maven-plugin-plugin:3.5.2:report at 06 Sep 2020 22:02 CEST -->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<title>OpenJPA Maven Plugin &#x2013; Plugin Documentation</title>
<style type="text/css" media="all">
@import url("./css/maven-base.css");
@import url("./css/maven-theme.css");
@import url("./css/site.css");
</style>
<link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
<meta http-equiv="Content-Language" content="en" />
</head>
<body class="composite">
<div id="banner">
<div id="bannerLeft">
OpenJPA
</div>
<div class="clear">
<hr/>
</div>
</div>
<div id="breadcrumbs">
<div class="xleft">
<span id="publishDate">Last Published: 06 Sep 2020 22:02 CEST</span>
&nbsp;| <span id="projectVersion">Version: 3.1.3-SNAPSHOT</span>
</div>
<div class="xright"> </div>
<div class="clear">
<hr/>
</div>
</div>
<div id="leftColumn">
<div id="navcolumn">
<h5>Overview</h5>
<ul>
<li class="none"><a href="index.html" title="Introduction">Introduction</a></li>
<li class="none"><a href="usage.html" title="Usage">Usage</a></li>
<li class="none"><strong>Goals</strong></li>
</ul>
<h5>Examples</h5>
<ul>
<li class="none"><a href="examples/enhance.html" title="Enhance">Enhance</a></li>
<li class="none"><a href="examples/sql.html" title="SQL">SQL</a></li>
<li class="none"><a href="examples/schema.html" title="Schema">Schema</a></li>
<li class="none"><a href="examples/testenhance.html" title="TestEnhance">TestEnhance</a></li>
</ul>
<a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
<img class="poweredBy" alt="Built by Maven" src="./images/logos/maven-feather.png" />
</a>
</div>
</div>
<div id="bodyColumn">
<div id="contentBox">
<div class="section">
<h2><a name="Plugin_Documentation"></a>Plugin Documentation</h2><a name="Plugin_Documentation"></a>
<p>Goals available for this plugin:</p>
<table border="0" class="bodyTable">
<tr class="a">
<th>Goal</th>
<th>Description</th></tr>
<tr class="b">
<td><a href="enhance-mojo.html">openjpa:enhance</a></td>
<td>Processes Application model classes and enhances them by running
OpenJPA Enhancer tool.</td></tr>
<tr class="a">
<td><a href="help-mojo.html">openjpa:help</a></td>
<td>Display help information on openjpa-maven-plugin.<br />
Call <code>mvn openjpa:help -Ddetail=true
-Dgoal=&lt;goal-name&gt;</code> to display parameter details.</td></tr>
<tr class="b">
<td><a href="schema-mojo.html">openjpa:schema</a></td>
<td>Executes the schema generation via the OpenJPA MappingTool.</td></tr>
<tr class="a">
<td><a href="sql-mojo.html">openjpa:sql</a></td>
<td>Executes the SQL generation via the OpenJPA MappingTool.</td></tr>
<tr class="b">
<td><a href="test-enhance-mojo.html">openjpa:test-enhance</a></td>
<td>Processes Application model test classes and enhances them by
running OpenJPA Enhancer tool.</td></tr></table>
<div class="section">
<h3><a name="System_Requirements"></a>System Requirements</h3><a name="System_Requirements"></a>
<p>The following specifies the minimum requirements to run this Maven plugin:</p>
<table border="0" class="bodyTable">
<tr class="a">
<td>Maven</td>
<td>3.3.9</td></tr>
<tr class="b">
<td>JDK</td>
<td>1.8</td></tr>
<tr class="a">
<td>Memory</td>
<td>No minimum requirement.</td></tr>
<tr class="b">
<td>Disk Space</td>
<td>No minimum requirement.</td></tr></table></div>
<div class="section">
<h3><a name="Usage"></a>Usage</h3><a name="Usage"></a>
<p>You should specify the version in your project's plugin configuration:</p>
<div class="source">
<pre>&lt;project&gt;
...
&lt;build&gt;
&lt;!-- To define the plugin version in your parent POM --&gt;
&lt;pluginManagement&gt;
&lt;plugins&gt;
&lt;plugin&gt;
&lt;groupId&gt;org.apache.openjpa&lt;/groupId&gt;
&lt;artifactId&gt;openjpa-maven-plugin&lt;/artifactId&gt;
&lt;version&gt;3.1.3-SNAPSHOT&lt;/version&gt;
&lt;/plugin&gt;
...
&lt;/plugins&gt;
&lt;/pluginManagement&gt;
&lt;!-- To use the plugin goals in your POM or parent POM --&gt;
&lt;plugins&gt;
&lt;plugin&gt;
&lt;groupId&gt;org.apache.openjpa&lt;/groupId&gt;
&lt;artifactId&gt;openjpa-maven-plugin&lt;/artifactId&gt;
&lt;version&gt;3.1.3-SNAPSHOT&lt;/version&gt;
&lt;/plugin&gt;
...
&lt;/plugins&gt;
&lt;/build&gt;
...
&lt;/project&gt;
</pre></div>
<p>For more information, see <a class="externalLink" href="http://maven.apache.org/guides/mini/guide-configuring-plugins.html">&quot;Guide to Configuring Plug-ins&quot;</a></p></div></div>
</div>
</div>
<div class="clear">
<hr/>
</div>
<div id="footer">
<div class="xright">
Copyright &#169; 2011&#x2013;2020 <a href="http://www.apache.org">Apache Software Foundation</a>.
All rights reserved. </div>
<div class="clear">
<hr/>
</div>
</div>
</body>
</html>