| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="de"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_201) on Wed Apr 24 20:07:05 CEST 2019 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>MappingTool (OpenJPA Parent POM 3.1.0 API)</title> |
| <meta name="date" content="2019-04-24"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="MappingTool (OpenJPA Parent POM 3.1.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":9,"i18":10,"i19":10,"i20":10,"i21":9,"i22":9,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10,"i35":10,"i36":10,"i37":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/MappingTool.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/openjpa/jdbc/meta/MappingStrategyInstaller.html" title="class in org.apache.openjpa.jdbc.meta"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/openjpa/jdbc/meta/MappingTool.Flags.html" title="class in org.apache.openjpa.jdbc.meta"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/openjpa/jdbc/meta/MappingTool.html" target="_top">Frames</a></li> |
| <li><a href="MappingTool.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.openjpa.jdbc.meta</div> |
| <h2 title="Class MappingTool" class="title">Class MappingTool</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.openjpa.jdbc.meta.MappingTool</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="../../../../../org/apache/openjpa/meta/MetaDataModes.html" title="interface in org.apache.openjpa.meta">MetaDataModes</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">MappingTool</span> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> |
| implements <a href="../../../../../org/apache/openjpa/meta/MetaDataModes.html" title="interface in org.apache.openjpa.meta">MetaDataModes</a></pre> |
| <div class="block">Tool for manipulating class mappings and associated schema.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Author:</span></dt> |
| <dd>Abe White</dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Class and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/MappingTool.Flags.html" title="class in org.apache.openjpa.jdbc.meta">MappingTool.Flags</a></span></code> |
| <div class="block">Run flags.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static interface </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/MappingTool.ImportExport.html" title="interface in org.apache.openjpa.jdbc.meta">MappingTool.ImportExport</a></span></code> |
| <div class="block">Helper used to import and export mapping data.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/MappingTool.html#ACTION_ADD">ACTION_ADD</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/MappingTool.html#ACTION_BUILD_SCHEMA">ACTION_BUILD_SCHEMA</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/MappingTool.html#ACTION_DROP">ACTION_DROP</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/MappingTool.html#ACTION_DROP_SCHEMA">ACTION_DROP_SCHEMA</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/MappingTool.html#ACTION_EXPORT">ACTION_EXPORT</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/MappingTool.html#ACTION_IMPORT">ACTION_IMPORT</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/MappingTool.html#ACTION_REFRESH">ACTION_REFRESH</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/MappingTool.html#ACTION_SCRIPT_CREATE">ACTION_SCRIPT_CREATE</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/MappingTool.html#ACTION_SCRIPT_DROP">ACTION_SCRIPT_DROP</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/MappingTool.html#ACTION_SCRIPT_LOAD">ACTION_SCRIPT_LOAD</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/MappingTool.html#ACTION_VALIDATE">ACTION_VALIDATE</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/MappingTool.html#ACTIONS">ACTIONS</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/MappingTool.html#SCHEMA_ACTION_NONE">SCHEMA_ACTION_NONE</a></span></code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.openjpa.meta.MetaDataModes"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface org.apache.openjpa.meta.<a href="../../../../../org/apache/openjpa/meta/MetaDataModes.html" title="interface in org.apache.openjpa.meta">MetaDataModes</a></h3> |
| <code><a href="../../../../../org/apache/openjpa/meta/MetaDataModes.html#MODE_ALL">MODE_ALL</a>, <a href="../../../../../org/apache/openjpa/meta/MetaDataModes.html#MODE_ANN_MAPPING">MODE_ANN_MAPPING</a>, <a href="../../../../../org/apache/openjpa/meta/MetaDataModes.html#MODE_MAPPING">MODE_MAPPING</a>, <a href="../../../../../org/apache/openjpa/meta/MetaDataModes.html#MODE_MAPPING_INIT">MODE_MAPPING_INIT</a>, <a href="../../../../../org/apache/openjpa/meta/MetaDataModes.html#MODE_META">MODE_META</a>, <a href="../../../../../org/apache/openjpa/meta/MetaDataModes.html#MODE_NONE">MODE_NONE</a>, <a href="../../../../../org/apache/openjpa/meta/MetaDataModes.html#MODE_QUERY">MODE_QUERY</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/MappingTool.html#MappingTool-org.apache.openjpa.jdbc.conf.JDBCConfiguration-java.lang.String-boolean-">MappingTool</a></span>(<a href="../../../../../org/apache/openjpa/jdbc/conf/JDBCConfiguration.html" title="interface in org.apache.openjpa.jdbc.conf">JDBCConfiguration</a> conf, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> action, |
| boolean meta)</code> |
| <div class="block">Constructor.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/MappingTool.html#MappingTool-org.apache.openjpa.jdbc.conf.JDBCConfiguration-java.lang.String-boolean-java.lang.ClassLoader-">MappingTool</a></span>(<a href="../../../../../org/apache/openjpa/jdbc/conf/JDBCConfiguration.html" title="interface in org.apache.openjpa.jdbc.conf">JDBCConfiguration</a> conf, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> action, |
| boolean meta, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a> loader)</code> |
| <div class="block">Constructor.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/MappingTool.html#clear--">clear</a></span>()</code> |
| <div class="block">Reset the internal repository.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/MappingTool.html#getAction--">getAction</a></span>()</code> |
| <div class="block">The action supplied on construction.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/MappingTool.html#getDropUnusedComponents--">getDropUnusedComponents</a></span>()</code> |
| <div class="block">Whether schema components that are unused by any mapping will be |
| dropped from this tool's <a href="../../../../../org/apache/openjpa/jdbc/schema/SchemaGroup.html" title="class in org.apache.openjpa.jdbc.schema"><code>SchemaGroup</code></a>, and, depending on |
| the schema action, from the database.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/MappingTool.html#getForeignKeys--">getForeignKeys</a></span>()</code> |
| <div class="block">Whether foreign keys on existing tables should be manipulated.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/MappingTool.html#getIgnoreErrors--">getIgnoreErrors</a></span>()</code> |
| <div class="block">Whether and SQL errors should cause a failure or just issue a warning.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/MappingTool.html#getIndexes--">getIndexes</a></span>()</code> |
| <div class="block">Whether indexes on existing tables should be manipulated.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/MappingTool.html#getMappingWriter--">getMappingWriter</a></span>()</code> |
| <div class="block">The stream to export the planned mappings to as an XML document.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/MappingTool.html#getMetaDataFile--">getMetaDataFile</a></span>()</code> |
| <div class="block">If adding metadata, the metadata file to add to.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/MappingTool.html#getPrimaryKeys--">getPrimaryKeys</a></span>()</code> |
| <div class="block">Whether primary keys on existing tables should be manipulated.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/MappingTool.html#getReadSchema--">getReadSchema</a></span>()</code> |
| <div class="block">Set to true to read the entire schema before mapping.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/openjpa/jdbc/meta/MappingRepository.html" title="class in org.apache.openjpa.jdbc.meta">MappingRepository</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/MappingTool.html#getRepository--">getRepository</a></span>()</code> |
| <div class="block">Return the repository to use to access mapping information.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/MappingTool.html#getRollbackBeforeDDL--">getRollbackBeforeDDL</a></span>()</code> |
| <div class="block">If true, rollback will be performed before each DDL statement is executed.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/MappingTool.html#getSchemaAction--">getSchemaAction</a></span>()</code> |
| <div class="block">The schema modification policy, or <code>none</code>.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/openjpa/jdbc/schema/SchemaGroup.html" title="class in org.apache.openjpa.jdbc.schema">SchemaGroup</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/MappingTool.html#getSchemaGroup--">getSchemaGroup</a></span>()</code> |
| <div class="block">Return the schema group to use in mapping.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/MappingTool.html#getSchemaWriter--">getSchemaWriter</a></span>()</code> |
| <div class="block">The stream to export the planned schema to as an XML document.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/MappingTool.html#getSequences--">getSequences</a></span>()</code> |
| <div class="block">Whether to manipulate sequences.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/MappingTool.html#isMetaDataAction--">isMetaDataAction</a></span>()</code> |
| <div class="block">Whether the action works on metadata as well as mappings.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/MappingTool.html#main-java.lang.String:A-">main</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] arguments)</code> |
| <div class="block">Usage: java org.apache.openjpa.jdbc.meta.MappingTool [option]* |
| [-action/-a <refresh | add | buildSchema | drop | validate | import |
| | export>] <class name | .java file | .class file | .jdo file>* |
| Where the following options are recognized.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/MappingTool.html#record--">record</a></span>()</code> |
| <div class="block">Records the changes that have been made to both the mappings and the |
| associated schema, and clears the tool for further use.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/MappingTool.html#record-org.apache.openjpa.jdbc.meta.MappingTool.Flags-">record</a></span>(<a href="../../../../../org/apache/openjpa/jdbc/meta/MappingTool.Flags.html" title="class in org.apache.openjpa.jdbc.meta">MappingTool.Flags</a> flags)</code> </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/MappingTool.html#run-java.lang.Class-">run</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> cls)</code> |
| <div class="block">Run the configured action on the given instance.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/MappingTool.html#run-org.apache.openjpa.jdbc.conf.JDBCConfiguration-java.lang.String:A-org.apache.openjpa.jdbc.meta.MappingTool.Flags-java.lang.ClassLoader-">run</a></span>(<a href="../../../../../org/apache/openjpa/jdbc/conf/JDBCConfiguration.html" title="interface in org.apache.openjpa.jdbc.conf">JDBCConfiguration</a> conf, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] args, |
| <a href="../../../../../org/apache/openjpa/jdbc/meta/MappingTool.Flags.html" title="class in org.apache.openjpa.jdbc.meta">MappingTool.Flags</a> flags, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a> loader)</code> |
| <div class="block">Run the tool.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/MappingTool.html#run-org.apache.openjpa.jdbc.conf.JDBCConfiguration-java.lang.String:A-org.apache.openjpa.lib.util.Options-java.lang.ClassLoader-">run</a></span>(<a href="../../../../../org/apache/openjpa/jdbc/conf/JDBCConfiguration.html" title="interface in org.apache.openjpa.jdbc.conf">JDBCConfiguration</a> conf, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] args, |
| <a href="../../../../../org/apache/openjpa/lib/util/Options.html" title="class in org.apache.openjpa.lib.util">Options</a> opts, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a> loader)</code> |
| <div class="block">Run the tool.</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/MappingTool.html#setDropUnusedComponents-boolean-">setDropUnusedComponents</a></span>(boolean dropUnused)</code> |
| <div class="block">Whether schema components that are unused by any mapping will be |
| dropped from this tool's <a href="../../../../../org/apache/openjpa/jdbc/schema/SchemaGroup.html" title="class in org.apache.openjpa.jdbc.schema"><code>SchemaGroup</code></a>, and, depending on |
| the schema action, from the database.</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/MappingTool.html#setForeignKeys-boolean-">setForeignKeys</a></span>(boolean fks)</code> |
| <div class="block">Whether foreign keys on existing tables should be manipulated.</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/MappingTool.html#setIgnoreErrors-boolean-">setIgnoreErrors</a></span>(boolean ignoreErrors)</code> |
| <div class="block">Whether and SQL errors should cause a failure or just issue a warning.</div> |
| </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/MappingTool.html#setIndexes-boolean-">setIndexes</a></span>(boolean indexes)</code> |
| <div class="block">Whether indexes on existing tables should be manipulated.</div> |
| </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/MappingTool.html#setMappingWriter-java.io.Writer-">setMappingWriter</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a> mappingWriter)</code> |
| <div class="block">The stream to export the planned mappings to as an XML document.</div> |
| </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/MappingTool.html#setMetaDataFile-java.io.File-">setMetaDataFile</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> file)</code> |
| <div class="block">If adding metadata, the metadata file to add to.</div> |
| </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/MappingTool.html#setPrimaryKeys-boolean-">setPrimaryKeys</a></span>(boolean pks)</code> |
| <div class="block">Whether primary keys on existing tables should be manipulated.</div> |
| </td> |
| </tr> |
| <tr id="i30" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/MappingTool.html#setReadSchema-boolean-">setReadSchema</a></span>(boolean readSchema)</code> |
| <div class="block">Set to true to read the entire schema before mapping.</div> |
| </td> |
| </tr> |
| <tr id="i31" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/MappingTool.html#setRepository-org.apache.openjpa.jdbc.meta.MappingRepository-">setRepository</a></span>(<a href="../../../../../org/apache/openjpa/jdbc/meta/MappingRepository.html" title="class in org.apache.openjpa.jdbc.meta">MappingRepository</a> repos)</code> |
| <div class="block">Set the repository to use to access mapping information.</div> |
| </td> |
| </tr> |
| <tr id="i32" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/MappingTool.html#setRollbackBeforeDDL-boolean-">setRollbackBeforeDDL</a></span>(boolean rollbackBeforeDDL)</code> |
| <div class="block">If true, rollback will be performed before each DDL statement is executed.</div> |
| </td> |
| </tr> |
| <tr id="i33" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/MappingTool.html#setSchemaAction-java.lang.String-">setSchemaAction</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> schemaAction)</code> |
| <div class="block">The schema modification policy, or <code>none</code>.</div> |
| </td> |
| </tr> |
| <tr id="i34" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/MappingTool.html#setSchemaGroup-org.apache.openjpa.jdbc.schema.SchemaGroup-">setSchemaGroup</a></span>(<a href="../../../../../org/apache/openjpa/jdbc/schema/SchemaGroup.html" title="class in org.apache.openjpa.jdbc.schema">SchemaGroup</a> schema)</code> |
| <div class="block">Set the schema to use in mapping.</div> |
| </td> |
| </tr> |
| <tr id="i35" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/MappingTool.html#setSchemaTool-org.apache.openjpa.jdbc.schema.SchemaTool-">setSchemaTool</a></span>(<a href="../../../../../org/apache/openjpa/jdbc/schema/SchemaTool.html" title="class in org.apache.openjpa.jdbc.schema">SchemaTool</a> tool)</code> |
| <div class="block">Set the schema tool to use for schema modification.</div> |
| </td> |
| </tr> |
| <tr id="i36" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/MappingTool.html#setSchemaWriter-java.io.Writer-">setSchemaWriter</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a> schemaWriter)</code> |
| <div class="block">The stream to export the planned schema to as an XML document.</div> |
| </td> |
| </tr> |
| <tr id="i37" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/MappingTool.html#setSequences-boolean-">setSequences</a></span>(boolean seqs)</code> |
| <div class="block">Whether to manipulate sequences.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="SCHEMA_ACTION_NONE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SCHEMA_ACTION_NONE</h4> |
| <pre>public static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> SCHEMA_ACTION_NONE</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.openjpa.jdbc.meta.MappingTool.SCHEMA_ACTION_NONE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="ACTION_ADD"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ACTION_ADD</h4> |
| <pre>public static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> ACTION_ADD</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.openjpa.jdbc.meta.MappingTool.ACTION_ADD">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="ACTION_REFRESH"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ACTION_REFRESH</h4> |
| <pre>public static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> ACTION_REFRESH</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.openjpa.jdbc.meta.MappingTool.ACTION_REFRESH">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="ACTION_BUILD_SCHEMA"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ACTION_BUILD_SCHEMA</h4> |
| <pre>public static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> ACTION_BUILD_SCHEMA</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.openjpa.jdbc.meta.MappingTool.ACTION_BUILD_SCHEMA">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="ACTION_DROP"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ACTION_DROP</h4> |
| <pre>public static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> ACTION_DROP</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.openjpa.jdbc.meta.MappingTool.ACTION_DROP">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="ACTION_DROP_SCHEMA"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ACTION_DROP_SCHEMA</h4> |
| <pre>public static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> ACTION_DROP_SCHEMA</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.openjpa.jdbc.meta.MappingTool.ACTION_DROP_SCHEMA">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="ACTION_VALIDATE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ACTION_VALIDATE</h4> |
| <pre>public static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> ACTION_VALIDATE</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.openjpa.jdbc.meta.MappingTool.ACTION_VALIDATE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="ACTION_EXPORT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ACTION_EXPORT</h4> |
| <pre>public static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> ACTION_EXPORT</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.openjpa.jdbc.meta.MappingTool.ACTION_EXPORT">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="ACTION_IMPORT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ACTION_IMPORT</h4> |
| <pre>public static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> ACTION_IMPORT</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.openjpa.jdbc.meta.MappingTool.ACTION_IMPORT">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="ACTION_SCRIPT_CREATE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ACTION_SCRIPT_CREATE</h4> |
| <pre>public static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> ACTION_SCRIPT_CREATE</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.openjpa.jdbc.meta.MappingTool.ACTION_SCRIPT_CREATE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="ACTION_SCRIPT_DROP"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ACTION_SCRIPT_DROP</h4> |
| <pre>public static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> ACTION_SCRIPT_DROP</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.openjpa.jdbc.meta.MappingTool.ACTION_SCRIPT_DROP">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="ACTION_SCRIPT_LOAD"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ACTION_SCRIPT_LOAD</h4> |
| <pre>public static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> ACTION_SCRIPT_LOAD</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.openjpa.jdbc.meta.MappingTool.ACTION_SCRIPT_LOAD">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="ACTIONS"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>ACTIONS</h4> |
| <pre>public static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] ACTIONS</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="MappingTool-org.apache.openjpa.jdbc.conf.JDBCConfiguration-java.lang.String-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>MappingTool</h4> |
| <pre>public MappingTool(<a href="../../../../../org/apache/openjpa/jdbc/conf/JDBCConfiguration.html" title="interface in org.apache.openjpa.jdbc.conf">JDBCConfiguration</a> conf, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> action, |
| boolean meta)</pre> |
| <div class="block">Constructor. Supply configuration and action.</div> |
| </li> |
| </ul> |
| <a name="MappingTool-org.apache.openjpa.jdbc.conf.JDBCConfiguration-java.lang.String-boolean-java.lang.ClassLoader-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>MappingTool</h4> |
| <pre>public MappingTool(<a href="../../../../../org/apache/openjpa/jdbc/conf/JDBCConfiguration.html" title="interface in org.apache.openjpa.jdbc.conf">JDBCConfiguration</a> conf, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> action, |
| boolean meta, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a> loader)</pre> |
| <div class="block">Constructor. Supply configuration and action.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getAction--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAction</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getAction()</pre> |
| <div class="block">The action supplied on construction.</div> |
| </li> |
| </ul> |
| <a name="isMetaDataAction--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isMetaDataAction</h4> |
| <pre>public boolean isMetaDataAction()</pre> |
| <div class="block">Whether the action works on metadata as well as mappings.</div> |
| </li> |
| </ul> |
| <a name="getSchemaAction--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSchemaAction</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getSchemaAction()</pre> |
| <div class="block">The schema modification policy, or <code>none</code>. See the |
| ACTION constants in <a href="../../../../../org/apache/openjpa/jdbc/schema/SchemaTool.html" title="class in org.apache.openjpa.jdbc.schema"><code>SchemaTool</code></a>. May be a comma-separated |
| list of values. Defaults to <a href="../../../../../org/apache/openjpa/jdbc/schema/SchemaTool.html#ACTION_ADD"><code>SchemaTool.ACTION_ADD</code></a>.</div> |
| </li> |
| </ul> |
| <a name="setSchemaAction-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSchemaAction</h4> |
| <pre>public void setSchemaAction(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> schemaAction)</pre> |
| <div class="block">The schema modification policy, or <code>none</code>. See the |
| ACTION constants in <a href="../../../../../org/apache/openjpa/jdbc/schema/SchemaTool.html" title="class in org.apache.openjpa.jdbc.schema"><code>SchemaTool</code></a>. May be a comma-separated |
| list of values. Defaults to <a href="../../../../../org/apache/openjpa/jdbc/schema/SchemaTool.html#ACTION_ADD"><code>SchemaTool.ACTION_ADD</code></a>.</div> |
| </li> |
| </ul> |
| <a name="getReadSchema--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getReadSchema</h4> |
| <pre>public boolean getReadSchema()</pre> |
| <div class="block">Set to true to read the entire schema before mapping. |
| Leaving this option false saves time, but is dangerous when adding |
| new mappings, because without full knowledge of the existing schema the |
| mapping tool might create tables or indexes that conflict with |
| existing components.</div> |
| </li> |
| </ul> |
| <a name="setReadSchema-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setReadSchema</h4> |
| <pre>public void setReadSchema(boolean readSchema)</pre> |
| <div class="block">Set to true to read the entire schema before mapping. |
| Leaving this option false saves time, but is dangerous when adding |
| new mappings, because without full knowledge of the existing schema the |
| mapping tool might create tables or indexes that conflict with |
| existing components.</div> |
| </li> |
| </ul> |
| <a name="getSequences--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSequences</h4> |
| <pre>public boolean getSequences()</pre> |
| <div class="block">Whether to manipulate sequences. Defaults to true.</div> |
| </li> |
| </ul> |
| <a name="setSequences-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSequences</h4> |
| <pre>public void setSequences(boolean seqs)</pre> |
| <div class="block">Whether to manipulate sequences. Defaults to true.</div> |
| </li> |
| </ul> |
| <a name="getIndexes--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getIndexes</h4> |
| <pre>public boolean getIndexes()</pre> |
| <div class="block">Whether indexes on existing tables should be manipulated. |
| Defaults to false.</div> |
| </li> |
| </ul> |
| <a name="setIndexes-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setIndexes</h4> |
| <pre>public void setIndexes(boolean indexes)</pre> |
| <div class="block">Whether indexes on existing tables should be manipulated. |
| Defaults to false.</div> |
| </li> |
| </ul> |
| <a name="getForeignKeys--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getForeignKeys</h4> |
| <pre>public boolean getForeignKeys()</pre> |
| <div class="block">Whether foreign keys on existing tables should be manipulated. |
| Defaults to false.</div> |
| </li> |
| </ul> |
| <a name="setForeignKeys-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setForeignKeys</h4> |
| <pre>public void setForeignKeys(boolean fks)</pre> |
| <div class="block">Whether foreign keys on existing tables should be manipulated. |
| Defaults to false.</div> |
| </li> |
| </ul> |
| <a name="getPrimaryKeys--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPrimaryKeys</h4> |
| <pre>public boolean getPrimaryKeys()</pre> |
| <div class="block">Whether primary keys on existing tables should be manipulated. |
| Defaults to false.</div> |
| </li> |
| </ul> |
| <a name="setPrimaryKeys-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPrimaryKeys</h4> |
| <pre>public void setPrimaryKeys(boolean pks)</pre> |
| <div class="block">Whether primary keys on existing tables should be manipulated. |
| Defaults to false.</div> |
| </li> |
| </ul> |
| <a name="getDropUnusedComponents--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDropUnusedComponents</h4> |
| <pre>public boolean getDropUnusedComponents()</pre> |
| <div class="block">Whether schema components that are unused by any mapping will be |
| dropped from this tool's <a href="../../../../../org/apache/openjpa/jdbc/schema/SchemaGroup.html" title="class in org.apache.openjpa.jdbc.schema"><code>SchemaGroup</code></a>, and, depending on |
| the schema action, from the database. Defaults to true.</div> |
| </li> |
| </ul> |
| <a name="setDropUnusedComponents-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDropUnusedComponents</h4> |
| <pre>public void setDropUnusedComponents(boolean dropUnused)</pre> |
| <div class="block">Whether schema components that are unused by any mapping will be |
| dropped from this tool's <a href="../../../../../org/apache/openjpa/jdbc/schema/SchemaGroup.html" title="class in org.apache.openjpa.jdbc.schema"><code>SchemaGroup</code></a>, and, depending on |
| the schema action, from the database. Defaults to true.</div> |
| </li> |
| </ul> |
| <a name="setIgnoreErrors-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setIgnoreErrors</h4> |
| <pre>public void setIgnoreErrors(boolean ignoreErrors)</pre> |
| <div class="block">Whether and SQL errors should cause a failure or just issue a warning.</div> |
| </li> |
| </ul> |
| <a name="getIgnoreErrors--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getIgnoreErrors</h4> |
| <pre>public boolean getIgnoreErrors()</pre> |
| <div class="block">Whether and SQL errors should cause a failure or just issue a warning.</div> |
| </li> |
| </ul> |
| <a name="getRollbackBeforeDDL--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRollbackBeforeDDL</h4> |
| <pre>public boolean getRollbackBeforeDDL()</pre> |
| <div class="block">If true, rollback will be performed before each DDL statement is executed. Defaults to true.</div> |
| </li> |
| </ul> |
| <a name="setRollbackBeforeDDL-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setRollbackBeforeDDL</h4> |
| <pre>public void setRollbackBeforeDDL(boolean rollbackBeforeDDL)</pre> |
| <div class="block">If true, rollback will be performed before each DDL statement is executed. Defaults to true.</div> |
| </li> |
| </ul> |
| <a name="setSchemaTool-org.apache.openjpa.jdbc.schema.SchemaTool-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSchemaTool</h4> |
| <pre>public void setSchemaTool(<a href="../../../../../org/apache/openjpa/jdbc/schema/SchemaTool.html" title="class in org.apache.openjpa.jdbc.schema">SchemaTool</a> tool)</pre> |
| <div class="block">Set the schema tool to use for schema modification.</div> |
| </li> |
| </ul> |
| <a name="getSchemaWriter--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSchemaWriter</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a> getSchemaWriter()</pre> |
| <div class="block">The stream to export the planned schema to as an XML document. |
| If non-null, then the database schema will not be altered.</div> |
| </li> |
| </ul> |
| <a name="setSchemaWriter-java.io.Writer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSchemaWriter</h4> |
| <pre>public void setSchemaWriter(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a> schemaWriter)</pre> |
| <div class="block">The stream to export the planned schema to as an XML document. |
| If non-null, then the database schema will not be altered.</div> |
| </li> |
| </ul> |
| <a name="getMappingWriter--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMappingWriter</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a> getMappingWriter()</pre> |
| <div class="block">The stream to export the planned mappings to as an XML document. |
| If non-null, then the mapping repository will not be altered.</div> |
| </li> |
| </ul> |
| <a name="setMappingWriter-java.io.Writer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMappingWriter</h4> |
| <pre>public void setMappingWriter(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a> mappingWriter)</pre> |
| <div class="block">The stream to export the planned mappings to as an XML document. |
| If non-null, then the mapping repository will not be altered.</div> |
| </li> |
| </ul> |
| <a name="getMetaDataFile--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMetaDataFile</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> getMetaDataFile()</pre> |
| <div class="block">If adding metadata, the metadata file to add to.</div> |
| </li> |
| </ul> |
| <a name="setMetaDataFile-java.io.File-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMetaDataFile</h4> |
| <pre>public void setMetaDataFile(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> file)</pre> |
| <div class="block">If adding metadata, the metadata file to add to.</div> |
| </li> |
| </ul> |
| <a name="getRepository--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRepository</h4> |
| <pre>public <a href="../../../../../org/apache/openjpa/jdbc/meta/MappingRepository.html" title="class in org.apache.openjpa.jdbc.meta">MappingRepository</a> getRepository()</pre> |
| <div class="block">Return the repository to use to access mapping information. |
| Defaults to a new <a href="../../../../../org/apache/openjpa/jdbc/meta/MappingRepository.html" title="class in org.apache.openjpa.jdbc.meta"><code>MappingRepository</code></a>.</div> |
| </li> |
| </ul> |
| <a name="setRepository-org.apache.openjpa.jdbc.meta.MappingRepository-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setRepository</h4> |
| <pre>public void setRepository(<a href="../../../../../org/apache/openjpa/jdbc/meta/MappingRepository.html" title="class in org.apache.openjpa.jdbc.meta">MappingRepository</a> repos)</pre> |
| <div class="block">Set the repository to use to access mapping information.</div> |
| </li> |
| </ul> |
| <a name="getSchemaGroup--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSchemaGroup</h4> |
| <pre>public <a href="../../../../../org/apache/openjpa/jdbc/schema/SchemaGroup.html" title="class in org.apache.openjpa.jdbc.schema">SchemaGroup</a> getSchemaGroup()</pre> |
| <div class="block">Return the schema group to use in mapping. If none has been set, the |
| schema will be generated from the database.</div> |
| </li> |
| </ul> |
| <a name="setSchemaGroup-org.apache.openjpa.jdbc.schema.SchemaGroup-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSchemaGroup</h4> |
| <pre>public void setSchemaGroup(<a href="../../../../../org/apache/openjpa/jdbc/schema/SchemaGroup.html" title="class in org.apache.openjpa.jdbc.schema">SchemaGroup</a> schema)</pre> |
| <div class="block">Set the schema to use in mapping.</div> |
| </li> |
| </ul> |
| <a name="clear--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clear</h4> |
| <pre>public void clear()</pre> |
| <div class="block">Reset the internal repository. This is called automatically after |
| every <a href="../../../../../org/apache/openjpa/jdbc/meta/MappingTool.html#record--"><code>record()</code></a>.</div> |
| </li> |
| </ul> |
| <a name="record--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>record</h4> |
| <pre>public void record()</pre> |
| <div class="block">Records the changes that have been made to both the mappings and the |
| associated schema, and clears the tool for further use. This also |
| involves clearing the internal mapping repository.</div> |
| </li> |
| </ul> |
| <a name="record-org.apache.openjpa.jdbc.meta.MappingTool.Flags-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>record</h4> |
| <pre>public void record(<a href="../../../../../org/apache/openjpa/jdbc/meta/MappingTool.Flags.html" title="class in org.apache.openjpa.jdbc.meta">MappingTool.Flags</a> flags)</pre> |
| </li> |
| </ul> |
| <a name="run-java.lang.Class-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>run</h4> |
| <pre>public void run(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> cls)</pre> |
| <div class="block">Run the configured action on the given instance.</div> |
| </li> |
| </ul> |
| <a name="main-java.lang.String:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>main</h4> |
| <pre>public static void main(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] arguments) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</a></pre> |
| <div class="block">Usage: java org.apache.openjpa.jdbc.meta.MappingTool [option]* |
| [-action/-a <refresh | add | buildSchema | drop | validate | import |
| | export>] <class name | .java file | .class file | .jdo file>* |
| Where the following options are recognized. |
| <ul> |
| <li><i>-properties/-p <properties file or resource></i>: The |
| path or resource name of a OpenJPA properties file containing |
| information as outlined in <a href="../../../../../org/apache/openjpa/conf/OpenJPAConfiguration.html" title="interface in org.apache.openjpa.conf"><code>OpenJPAConfiguration</code></a>. Optional.</li> |
| <li><i>-<property name> <property value></i>: All bean |
| properties of the OpenJPA <a href="../../../../../org/apache/openjpa/jdbc/conf/JDBCConfiguration.html" title="interface in org.apache.openjpa.jdbc.conf"><code>JDBCConfiguration</code></a> can be set by |
| using their names and supplying a value. For example: |
| <code>-licenseKey adslfja83r3lkadf</code></li> |
| <li><i>-file/-f <stdout | output file or resource></i>: Use |
| this option to write the planned mappings to an XML document rather |
| than store them in the repository. This option also specifies the |
| metadata file to write to if using the <code>add</code> action with |
| the <code>-meta true</code> flag, or the file to dump to if using |
| the <code>export</code> action.</li> |
| <li><i>-schemaAction/-sa <schema action | none></i>: The |
| <a href="../../../../../org/apache/openjpa/jdbc/schema/SchemaTool.html" title="class in org.apache.openjpa.jdbc.schema"><code>SchemaTool</code></a> defines the actions possible. The actions will |
| apply to all schema components used by the mappings involved. |
| Unless you are running the mapping tool on all of your persistent |
| types at once, be careful running schema actions that can drop data. |
| It is possible to accidentally drop schema components that are |
| used by classes you aren't currently running the tool over. The |
| action defaults to <code>add</code>.</li> |
| <li><i>-schemaFile/-sf <stdout | output file or resource></i>: Use |
| this option to write the planned schema to an XML document rather |
| than modify the data store.</li> |
| <li><i>-sqlFile/-sql <stdout | output file or resource></i>: Use |
| this option to write the planned schema changes as a SQL |
| script rather than modifying the data store.</li> |
| <li><i>-sqlEncode/-se <encoding></i>: Use |
| this option with the <code>-sqlFile</code> flag to write the SQL script |
| in a different Java character set encoding than the default JVM locale, |
| such as <code>UTF-8</code>.</li> |
| <li><i>-dropTables/-dt <true/t | false/f></i>: Corresponds to the |
| same-named option in the <a href="../../../../../org/apache/openjpa/jdbc/schema/SchemaTool.html" title="class in org.apache.openjpa.jdbc.schema"><code>SchemaTool</code></a>.</li> |
| <li><i>-dropSequences/-dsq <true/t | false/f></i>: Corresponds |
| to the same-named option in the <a href="../../../../../org/apache/openjpa/jdbc/schema/SchemaTool.html" title="class in org.apache.openjpa.jdbc.schema"><code>SchemaTool</code></a>.</li> |
| <li><i>-openjpaTables/-kt <true/t | false/f></i>: Corresponds to |
| the same-named option in the <a href="../../../../../org/apache/openjpa/jdbc/schema/SchemaTool.html" title="class in org.apache.openjpa.jdbc.schema"><code>SchemaTool</code></a>.</li> |
| <li><i>-ignoreErrors/-i <true/t | false/f></i>: Corresponds to the |
| same-named option in the <a href="../../../../../org/apache/openjpa/jdbc/schema/SchemaTool.html" title="class in org.apache.openjpa.jdbc.schema"><code>SchemaTool</code></a>.</li> |
| <li><i>-readSchema/-rs <true/t | false/f></i>: Set this to true |
| to read the entire existing schema (even when false the parts of |
| the schema used by classes the tool is run on will still be read). |
| Turning on schema reading can ensure that no naming conflicts will |
| occur, but it can take a long time.</li> |
| <li><i>-primaryKeys/-pk <true/t | false/f></i>: Whether primary |
| keys on existing tables are manipulated. Defaults to false.</li> |
| <li><i>-foreignKeys/-fk <true/t | false/f></i>: Whether foreign |
| keys on existing tables are manipulated. Defaults to false.</li> |
| <li><i>-indexes/-ix <true/t | false/f></i>: Whether indexes on |
| existing tables are manipulated. Defaults to false.</li> |
| <li><i>-sequences/-sq <true/t | false/f></i>: Whether sequences |
| are manipulated. Defaults to true.</li> |
| <li><i>-schemas/-s <schema and table names></i>: A list of schemas |
| and/or tables to read. Corresponds to the |
| same-named option in the <a href="../../../../../org/apache/openjpa/jdbc/schema/SchemaGenerator.html" title="class in org.apache.openjpa.jdbc.schema"><code>SchemaGenerator</code></a>. This option |
| is ignored if <code>readSchema</code> is false.</li> |
| <li><i>-meta/-m <true/t | false/f></i>: Whether the given action |
| applies to metadata as well as mappings.</li> |
| </ul> |
| The various actions are as follows. |
| <ul> |
| <li><i>refresh</i>: Bring the mapping information up-to-date |
| with the class definitions. OpenJPA will attempt to use any provided |
| mapping information, and fill in missing information. If the |
| provided information conflicts with the class definition, the |
| conflicting information will be discarded and the class/field will |
| be re-mapped to new columns/tables. This is the default action.</li> |
| <li><i>add</i>: If used with the <code>-meta</code> option, adds new |
| default metadata for the given class(es). Otherwise, brings the |
| mapping information up-to-date with the class |
| definitions. OpenJPA will attempt to use any provided mapping |
| information, and fill in missing information. OpenJPA will fail if |
| the provided information conflicts with the class definition.</li> |
| <li><i>buildSchema</i>: Create the schema matching the existing |
| mappings for the given class(es). Any invalid mapping information |
| will cause an exception.</li> |
| <li><i>drop</i>: Delete mappings for the given classes. If used with |
| the <code>-meta</code> option, also deletes metadata.</li> |
| <li><i>validate</i>: Validate the given mappings. The mapping |
| repository and schema will not be affected.</li> |
| <li><i>import</i>: Import mappings from an XML document and store |
| them as the current system mappings.</li> |
| <li><i>export</i>: Dump the current mappings for the given classes to |
| an XML document specified by the <code>file</code> option.</li> |
| If used with the <code>-meta</code> option, the metadata will be |
| included in the export. |
| </ul> |
| Each class supplied as an argument must have valid metadata. If |
| no class arguments are given, the tool runs on all metadata files in |
| the CLASSPATH. |
| Examples: |
| <ul> |
| <li>Refresh the mappings for given package, without dropping any |
| schema components:<br /> |
| <code>java org.apache.openjpa.jdbc.meta.MappingTool |
| mypackage.jdo</code></li> |
| <li>Refresh the mappings for all persistent classes in the classpath, |
| dropping any unused columns and even tables:<br /> |
| <code>java org.apache.openjpa.jdbc.meta.MappingTool -sa refresh |
| -dt true</code></li> |
| <li>Make sure the mappings you've created by hand match the object |
| model and schema:<br /> |
| <code>java org.apache.openjpa.jbdc.meta.MappingTool |
| -a validate Person.java</code></li> |
| <li>Remove the recorded mapping for a given class:<br /> |
| <code>java org.apache.openjpa.jbdc.meta.MappingTool |
| -a drop Person.java</code></li> |
| <li>Record the current mappings in an XML file:<br /> |
| <code>java org.apache.openjpa.jdbc.meta.MappingTool |
| -f mypackage.orm -a export mypackage.jdo</code></li> |
| </ul></div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="run-org.apache.openjpa.jdbc.conf.JDBCConfiguration-java.lang.String:A-org.apache.openjpa.lib.util.Options-java.lang.ClassLoader-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>run</h4> |
| <pre>public static boolean run(<a href="../../../../../org/apache/openjpa/jdbc/conf/JDBCConfiguration.html" title="interface in org.apache.openjpa.jdbc.conf">JDBCConfiguration</a> conf, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] args, |
| <a href="../../../../../org/apache/openjpa/lib/util/Options.html" title="class in org.apache.openjpa.lib.util">Options</a> opts, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a> loader) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</a></pre> |
| <div class="block">Run the tool. Returns false if invalid options are given.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</a></code></dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../org/apache/openjpa/jdbc/meta/MappingTool.html#main-java.lang.String:A-"><code>main(java.lang.String[])</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="run-org.apache.openjpa.jdbc.conf.JDBCConfiguration-java.lang.String:A-org.apache.openjpa.jdbc.meta.MappingTool.Flags-java.lang.ClassLoader-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>run</h4> |
| <pre>public static boolean run(<a href="../../../../../org/apache/openjpa/jdbc/conf/JDBCConfiguration.html" title="interface in org.apache.openjpa.jdbc.conf">JDBCConfiguration</a> conf, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] args, |
| <a href="../../../../../org/apache/openjpa/jdbc/meta/MappingTool.Flags.html" title="class in org.apache.openjpa.jdbc.meta">MappingTool.Flags</a> flags, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a> loader) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</a></pre> |
| <div class="block">Run the tool. Return false if an invalid option was given.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/MappingTool.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/openjpa/jdbc/meta/MappingStrategyInstaller.html" title="class in org.apache.openjpa.jdbc.meta"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/openjpa/jdbc/meta/MappingTool.Flags.html" title="class in org.apache.openjpa.jdbc.meta"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/openjpa/jdbc/meta/MappingTool.html" target="_top">Frames</a></li> |
| <li><a href="MappingTool.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2006–2019 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
