| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.10) on Mon Dec 05 10:27:04 MSK 2022 --> |
| <title>DbGenerator (cayenne-doc: Cayenne Documentation 4.2.RC2 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2022-12-05"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../jquery/jquery-3.5.1.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="DbGenerator (cayenne-doc: Cayenne Documentation 4.2.RC2 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"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":10,"i18":10,"i19":10,"i20":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../"; |
| var useModuleDirectories = false; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/DbGenerator.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 class="aboutLanguage"><a href="http://cayenne.apache.org" target="top">Apache Cayenne</a></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </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 id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.cayenne.access</a></div> |
| <h2 title="Class DbGenerator" class="title">Class DbGenerator</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" class="externalLink">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.cayenne.access.DbGenerator</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <pre>public class <span class="typeNameLabel">DbGenerator</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" class="externalLink">Object</a></pre> |
| <div class="block">Utility class that generates database schema based on Cayenne mapping. It is |
| a logical counterpart of DbLoader class.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Field</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="../dba/DbAdapter.html" title="interface in org.apache.cayenne.dba">DbAdapter</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#adapter">adapter</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,​<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createConstraints">createConstraints</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createPK">createPK</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,​<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createTables">createTables</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="../map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dbEntitiesInInsertOrder">dbEntitiesInInsertOrder</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Contains all DbEntities ordered considering their interdependencies.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="../map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dbEntitiesRequiringAutoPK">dbEntitiesRequiringAutoPK</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="DataDomain.html" title="class in org.apache.cayenne.access">DataDomain</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#domain">domain</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dropPK">dropPK</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,​<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dropTables">dropTables</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../validation/ValidationResult.html" title="class in org.apache.cayenne.validation">ValidationResult</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#failures">failures</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="../log/JdbcEventLogger.html" title="interface in org.apache.cayenne.log">JdbcEventLogger</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#jdbcEventLogger">jdbcEventLogger</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../map/DataMap.html" title="class in org.apache.cayenne.map">DataMap</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#map">map</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#shouldCreateFKConstraints">shouldCreateFKConstraints</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#shouldCreatePKSupport">shouldCreatePKSupport</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#shouldCreateTables">shouldCreateTables</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#shouldDropPKSupport">shouldDropPKSupport</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#shouldDropTables">shouldDropTables</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.cayenne.dba.DbAdapter,org.apache.cayenne.map.DataMap,java.util.Collection,org.apache.cayenne.access.DataDomain,org.apache.cayenne.log.JdbcEventLogger)">DbGenerator</a></span>​(<a href="../dba/DbAdapter.html" title="interface in org.apache.cayenne.dba">DbAdapter</a> adapter, |
| <a href="../map/DataMap.html" title="class in org.apache.cayenne.map">DataMap</a> map, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a><<a href="../map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a>> excludedEntities, |
| <a href="DataDomain.html" title="class in org.apache.cayenne.access">DataDomain</a> domain, |
| <a href="../log/JdbcEventLogger.html" title="interface in org.apache.cayenne.log">JdbcEventLogger</a> logger)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates and initializes new DbGenerator instance.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.cayenne.dba.DbAdapter,org.apache.cayenne.map.DataMap,org.apache.cayenne.log.JdbcEventLogger)">DbGenerator</a></span>​(<a href="../dba/DbAdapter.html" title="interface in org.apache.cayenne.dba">DbAdapter</a> adapter, |
| <a href="../map/DataMap.html" title="class in org.apache.cayenne.map">DataMap</a> map, |
| <a href="../log/JdbcEventLogger.html" title="interface in org.apache.cayenne.log">JdbcEventLogger</a> logger)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.cayenne.dba.DbAdapter,org.apache.cayenne.map.DataMap,org.apache.cayenne.log.JdbcEventLogger,java.util.Collection)">DbGenerator</a></span>​(<a href="../dba/DbAdapter.html" title="interface in org.apache.cayenne.dba">DbAdapter</a> adapter, |
| <a href="../map/DataMap.html" title="class in org.apache.cayenne.map">DataMap</a> map, |
| <a href="../log/JdbcEventLogger.html" title="interface in org.apache.cayenne.log">JdbcEventLogger</a> logger, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a><<a href="../map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a>> excludedEntities)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</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="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#buildStatements()">buildStatements</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Creates and stores internally a set of statements for database schema |
| creation, ignoring configured schema creation preferences.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#configuredStatements()">configuredStatements</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a list of all schema statements that should be executed with the |
| current configuration.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createConstraintsQueries(org.apache.cayenne.map.DbEntity)">createConstraintsQueries</a></span>​(<a href="../map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a> table)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates FK and UNIQUE constraint statements for a given table.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../dba/DbAdapter.html" title="interface in org.apache.cayenne.dba">DbAdapter</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAdapter()">getAdapter</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns DbAdapter associated with this DbGenerator.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="DataDomain.html" title="class in org.apache.cayenne.access">DataDomain</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDomain()">getDomain</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a DataDomain used by the DbGenerator to detect cross-database |
| relationships.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../validation/ValidationResult.html" title="class in org.apache.cayenne.validation">ValidationResult</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFailures()">getFailures</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns an object representing a collection of failures that occurred on |
| the last "runGenerator" invocation, or null if there were no failures.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isEmpty(boolean)">isEmpty</a></span>​(boolean respectConfiguredSettings)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns <code>true</code> if there is nothing to be done by this |
| generator.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#resetToDefaults()">resetToDefaults</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#runGenerator(javax.sql.DataSource)">runGenerator</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/javax/sql/DataSource.html?is-external=true" title="class or interface in javax.sql" class="externalLink">DataSource</a> ds)</code></th> |
| <td class="colLast"> |
| <div class="block">Executes a set of commands to drop/create database objects.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#runGenerator(org.apache.cayenne.conn.DataSourceInfo)">runGenerator</a></span>​(<a href="../conn/DataSourceInfo.html" title="class in org.apache.cayenne.conn">DataSourceInfo</a> dsi)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a temporary DataSource out of DataSourceInfo and invokes |
| <code>public void runGenerator(DataSource ds)</code>.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#safeExecute(java.sql.Connection,java.lang.String)">safeExecute</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/sql/Connection.html?is-external=true" title="class or interface in java.sql" class="externalLink">Connection</a> connection, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> sql)</code></th> |
| <td class="colLast"> |
| <div class="block">Builds and executes a SQL statement, catching and storing SQL exceptions |
| resulting from invalid SQL.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setShouldCreateFKConstraints(boolean)">setShouldCreateFKConstraints</a></span>​(boolean shouldCreateFKConstraints)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setShouldCreatePKSupport(boolean)">setShouldCreatePKSupport</a></span>​(boolean shouldCreatePKSupport)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setShouldCreateTables(boolean)">setShouldCreateTables</a></span>​(boolean shouldCreateTables)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setShouldDropPKSupport(boolean)">setShouldDropPKSupport</a></span>​(boolean shouldDropPKSupport)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setShouldDropTables(boolean)">setShouldDropTables</a></span>​(boolean shouldDropTables)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#shouldCreateFKConstraints()">shouldCreateFKConstraints</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#shouldCreatePKSupport()">shouldCreatePKSupport</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns whether DbGenerator is configured to create primary key support |
| for DataMap entities.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#shouldCreateTables()">shouldCreateTables</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns whether DbGenerator is configured to create tables for DataMap |
| entities.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#shouldDropPKSupport()">shouldDropPKSupport</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#shouldDropTables()">shouldDropTables</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="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" class="externalLink">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" class="externalLink">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" class="externalLink">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" class="externalLink">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" class="externalLink">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" class="externalLink">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" class="externalLink">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" class="externalLink">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" class="externalLink">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" class="externalLink">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" class="externalLink">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" class="externalLink">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a id="adapter"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>adapter</h4> |
| <pre>protected <a href="../dba/DbAdapter.html" title="interface in org.apache.cayenne.dba">DbAdapter</a> adapter</pre> |
| </li> |
| </ul> |
| <a id="map"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>map</h4> |
| <pre>protected <a href="../map/DataMap.html" title="class in org.apache.cayenne.map">DataMap</a> map</pre> |
| </li> |
| </ul> |
| <a id="domain"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>domain</h4> |
| <pre>protected <a href="DataDomain.html" title="class in org.apache.cayenne.access">DataDomain</a> domain</pre> |
| </li> |
| </ul> |
| <a id="jdbcEventLogger"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>jdbcEventLogger</h4> |
| <pre>protected <a href="../log/JdbcEventLogger.html" title="interface in org.apache.cayenne.log">JdbcEventLogger</a> jdbcEventLogger</pre> |
| </li> |
| </ul> |
| <a id="dropTables"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>dropTables</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,​<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>>> dropTables</pre> |
| </li> |
| </ul> |
| <a id="createTables"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createTables</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,​<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>> createTables</pre> |
| </li> |
| </ul> |
| <a id="createConstraints"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createConstraints</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,​<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>>> createConstraints</pre> |
| </li> |
| </ul> |
| <a id="createPK"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createPK</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>> createPK</pre> |
| </li> |
| </ul> |
| <a id="dropPK"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>dropPK</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>> dropPK</pre> |
| </li> |
| </ul> |
| <a id="dbEntitiesInInsertOrder"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>dbEntitiesInInsertOrder</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="../map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a>> dbEntitiesInInsertOrder</pre> |
| <div class="block">Contains all DbEntities ordered considering their interdependencies. |
| DerivedDbEntities are filtered out of this list.</div> |
| </li> |
| </ul> |
| <a id="dbEntitiesRequiringAutoPK"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>dbEntitiesRequiringAutoPK</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="../map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a>> dbEntitiesRequiringAutoPK</pre> |
| </li> |
| </ul> |
| <a id="shouldDropTables"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>shouldDropTables</h4> |
| <pre>protected boolean shouldDropTables</pre> |
| </li> |
| </ul> |
| <a id="shouldCreateTables"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>shouldCreateTables</h4> |
| <pre>protected boolean shouldCreateTables</pre> |
| </li> |
| </ul> |
| <a id="shouldDropPKSupport"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>shouldDropPKSupport</h4> |
| <pre>protected boolean shouldDropPKSupport</pre> |
| </li> |
| </ul> |
| <a id="shouldCreatePKSupport"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>shouldCreatePKSupport</h4> |
| <pre>protected boolean shouldCreatePKSupport</pre> |
| </li> |
| </ul> |
| <a id="shouldCreateFKConstraints"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>shouldCreateFKConstraints</h4> |
| <pre>protected boolean shouldCreateFKConstraints</pre> |
| </li> |
| </ul> |
| <a id="failures"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>failures</h4> |
| <pre>protected <a href="../validation/ValidationResult.html" title="class in org.apache.cayenne.validation">ValidationResult</a> failures</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a id="<init>(org.apache.cayenne.dba.DbAdapter,org.apache.cayenne.map.DataMap,org.apache.cayenne.log.JdbcEventLogger)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DbGenerator</h4> |
| <pre>public DbGenerator​(<a href="../dba/DbAdapter.html" title="interface in org.apache.cayenne.dba">DbAdapter</a> adapter, |
| <a href="../map/DataMap.html" title="class in org.apache.cayenne.map">DataMap</a> map, |
| <a href="../log/JdbcEventLogger.html" title="interface in org.apache.cayenne.log">JdbcEventLogger</a> logger)</pre> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="<init>(org.apache.cayenne.dba.DbAdapter,org.apache.cayenne.map.DataMap,org.apache.cayenne.log.JdbcEventLogger,java.util.Collection)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DbGenerator</h4> |
| <pre>public DbGenerator​(<a href="../dba/DbAdapter.html" title="interface in org.apache.cayenne.dba">DbAdapter</a> adapter, |
| <a href="../map/DataMap.html" title="class in org.apache.cayenne.map">DataMap</a> map, |
| <a href="../log/JdbcEventLogger.html" title="interface in org.apache.cayenne.log">JdbcEventLogger</a> logger, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a><<a href="../map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a>> excludedEntities)</pre> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="<init>(org.apache.cayenne.dba.DbAdapter,org.apache.cayenne.map.DataMap,java.util.Collection,org.apache.cayenne.access.DataDomain,org.apache.cayenne.log.JdbcEventLogger)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>DbGenerator</h4> |
| <pre>public DbGenerator​(<a href="../dba/DbAdapter.html" title="interface in org.apache.cayenne.dba">DbAdapter</a> adapter, |
| <a href="../map/DataMap.html" title="class in org.apache.cayenne.map">DataMap</a> map, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a><<a href="../map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a>> excludedEntities, |
| <a href="DataDomain.html" title="class in org.apache.cayenne.access">DataDomain</a> domain, |
| <a href="../log/JdbcEventLogger.html" title="interface in org.apache.cayenne.log">JdbcEventLogger</a> logger)</pre> |
| <div class="block">Creates and initializes new DbGenerator instance.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>adapter</code> - DbAdapter corresponding to the database</dd> |
| <dd><code>map</code> - DataMap whose entities will be used in schema generation</dd> |
| <dd><code>excludedEntities</code> - entities that should be ignored during schema generation</dd> |
| <dd><code>domain</code> - optional DataDomain used to detect cross-database |
| relationships.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.1</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="resetToDefaults()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>resetToDefaults</h4> |
| <pre class="methodSignature">protected void resetToDefaults()</pre> |
| </li> |
| </ul> |
| <a id="buildStatements()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>buildStatements</h4> |
| <pre class="methodSignature">protected void buildStatements()</pre> |
| <div class="block">Creates and stores internally a set of statements for database schema |
| creation, ignoring configured schema creation preferences. Statements are |
| NOT executed in this method.</div> |
| </li> |
| </ul> |
| <a id="isEmpty(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isEmpty</h4> |
| <pre class="methodSignature">public boolean isEmpty​(boolean respectConfiguredSettings)</pre> |
| <div class="block">Returns <code>true</code> if there is nothing to be done by this |
| generator. If <code>respectConfiguredSettings</code> is <code>true</code> |
| , checks are done applying currently configured settings, otherwise check |
| is done, assuming that all possible generated objects.</div> |
| </li> |
| </ul> |
| <a id="getAdapter()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAdapter</h4> |
| <pre class="methodSignature">public <a href="../dba/DbAdapter.html" title="interface in org.apache.cayenne.dba">DbAdapter</a> getAdapter()</pre> |
| <div class="block">Returns DbAdapter associated with this DbGenerator.</div> |
| </li> |
| </ul> |
| <a id="configuredStatements()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>configuredStatements</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>> configuredStatements()</pre> |
| <div class="block">Returns a list of all schema statements that should be executed with the |
| current configuration.</div> |
| </li> |
| </ul> |
| <a id="runGenerator(org.apache.cayenne.conn.DataSourceInfo)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>runGenerator</h4> |
| <pre class="methodSignature">public void runGenerator​(<a href="../conn/DataSourceInfo.html" title="class in org.apache.cayenne.conn">DataSourceInfo</a> dsi) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre> |
| <div class="block">Creates a temporary DataSource out of DataSourceInfo and invokes |
| <code>public void runGenerator(DataSource ds)</code>.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="runGenerator(javax.sql.DataSource)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>runGenerator</h4> |
| <pre class="methodSignature">public void runGenerator​(<a href="https://docs.oracle.com/javase/8/docs/api/javax/sql/DataSource.html?is-external=true" title="class or interface in javax.sql" class="externalLink">DataSource</a> ds) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre> |
| <div class="block">Executes a set of commands to drop/create database objects. This is the |
| main worker method of DbGenerator. Command set is built based on |
| pre-configured generator settings.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="safeExecute(java.sql.Connection,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>safeExecute</h4> |
| <pre class="methodSignature">protected boolean safeExecute​(<a href="https://docs.oracle.com/javase/8/docs/api/java/sql/Connection.html?is-external=true" title="class or interface in java.sql" class="externalLink">Connection</a> connection, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> sql) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql" class="externalLink">SQLException</a></pre> |
| <div class="block">Builds and executes a SQL statement, catching and storing SQL exceptions |
| resulting from invalid SQL. Only non-recoverable exceptions are rethrown.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <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" class="externalLink">SQLException</a></code></dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="createConstraintsQueries(org.apache.cayenne.map.DbEntity)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createConstraintsQueries</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>> createConstraintsQueries​(<a href="../map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a> table)</pre> |
| <div class="block">Creates FK and UNIQUE constraint statements for a given table.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getFailures()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFailures</h4> |
| <pre class="methodSignature">public <a href="../validation/ValidationResult.html" title="class in org.apache.cayenne.validation">ValidationResult</a> getFailures()</pre> |
| <div class="block">Returns an object representing a collection of failures that occurred on |
| the last "runGenerator" invocation, or null if there were no failures. |
| Failures usually indicate problems with generated DDL (such as |
| "create...", "drop...", etc.) and usually happen due to the DataMap being |
| out of sync with the database.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="shouldCreatePKSupport()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>shouldCreatePKSupport</h4> |
| <pre class="methodSignature">public boolean shouldCreatePKSupport()</pre> |
| <div class="block">Returns whether DbGenerator is configured to create primary key support |
| for DataMap entities.</div> |
| </li> |
| </ul> |
| <a id="shouldCreateTables()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>shouldCreateTables</h4> |
| <pre class="methodSignature">public boolean shouldCreateTables()</pre> |
| <div class="block">Returns whether DbGenerator is configured to create tables for DataMap |
| entities.</div> |
| </li> |
| </ul> |
| <a id="shouldDropPKSupport()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>shouldDropPKSupport</h4> |
| <pre class="methodSignature">public boolean shouldDropPKSupport()</pre> |
| </li> |
| </ul> |
| <a id="shouldDropTables()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>shouldDropTables</h4> |
| <pre class="methodSignature">public boolean shouldDropTables()</pre> |
| </li> |
| </ul> |
| <a id="shouldCreateFKConstraints()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>shouldCreateFKConstraints</h4> |
| <pre class="methodSignature">public boolean shouldCreateFKConstraints()</pre> |
| </li> |
| </ul> |
| <a id="setShouldCreatePKSupport(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setShouldCreatePKSupport</h4> |
| <pre class="methodSignature">public void setShouldCreatePKSupport​(boolean shouldCreatePKSupport)</pre> |
| </li> |
| </ul> |
| <a id="setShouldCreateTables(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setShouldCreateTables</h4> |
| <pre class="methodSignature">public void setShouldCreateTables​(boolean shouldCreateTables)</pre> |
| </li> |
| </ul> |
| <a id="setShouldDropPKSupport(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setShouldDropPKSupport</h4> |
| <pre class="methodSignature">public void setShouldDropPKSupport​(boolean shouldDropPKSupport)</pre> |
| </li> |
| </ul> |
| <a id="setShouldDropTables(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setShouldDropTables</h4> |
| <pre class="methodSignature">public void setShouldDropTables​(boolean shouldDropTables)</pre> |
| </li> |
| </ul> |
| <a id="setShouldCreateFKConstraints(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setShouldCreateFKConstraints</h4> |
| <pre class="methodSignature">public void setShouldCreateFKConstraints​(boolean shouldCreateFKConstraints)</pre> |
| </li> |
| </ul> |
| <a id="getDomain()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getDomain</h4> |
| <pre class="methodSignature">public <a href="DataDomain.html" title="class in org.apache.cayenne.access">DataDomain</a> getDomain()</pre> |
| <div class="block">Returns a DataDomain used by the DbGenerator to detect cross-database |
| relationships. By default DataDomain is null.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.2</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/DbGenerator.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 class="aboutLanguage"><a href="http://cayenne.apache.org" target="top">Apache Cayenne</a></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses.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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </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 id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2001–2022 <a href="https://cayenne.apache.org/">Apache Cayenne</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |