| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_252) on Fri Jul 16 09:39:10 UTC 2021 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>SchemaManager (EclipseLink 3.0.2, API Reference)</title> |
| <meta name="date" content="2021-07-16"> |
| <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="SchemaManager (EclipseLink 3.0.2, API Reference)"; |
| } |
| } |
| 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":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"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,"i38":10,"i39":10,"i40":10,"i41":10,"i42":10,"i43":10,"i44":10,"i45":10,"i46":10,"i47":10,"i48":10,"i49":10,"i50":10,"i51":10,"i52":10,"i53":10,"i54":10,"i55":10,"i56":10,"i57":10,"i58":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"; |
| </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="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">EclipseLink 3.0.2, API Reference</div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/eclipse/persistence/tools/schemaframework/PopulationManager.html" title="class in org.eclipse.persistence.tools.schemaframework"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/eclipse/persistence/tools/schemaframework/SequenceDefinition.html" title="class in org.eclipse.persistence.tools.schemaframework"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/eclipse/persistence/tools/schemaframework/SchemaManager.html" target="_top">Frames</a></li> |
| <li><a href="SchemaManager.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>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 name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.eclipse.persistence.tools.schemaframework</div> |
| <h2 title="Class SchemaManager" class="title">Class SchemaManager</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.eclipse.persistence.tools.schemaframework.SchemaManager</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><a href="../../../../../org/eclipse/persistence/tools/schemaframework/DynamicSchemaManager.html" title="class in org.eclipse.persistence.tools.schemaframework">DynamicSchemaManager</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">SchemaManager</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></pre> |
| <div class="block"><p> |
| <b>Purpose</b>: Define all user level protocol for development time database manipulation. |
| <p> |
| <b>Responsibilities</b>: |
| <ul> |
| <li> Define protocol for schema creation. |
| <li> Define any useful testing specific protocol. |
| </ul></div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== 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>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/SchemaManager.html#createDatabaseSchemas">createDatabaseSchemas</a></span></code> |
| <div class="block">Flag to determine if database schemas should be created during DDL generation</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/HashSet.html?is-external=true" title="class or interface in java.util">HashSet</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">String</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/SchemaManager.html#createdDatabaseSchemas">createdDatabaseSchemas</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/HashSet.html?is-external=true" title="class or interface in java.util">HashSet</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">String</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/SchemaManager.html#createdDatabaseSchemasOnDatabase">createdDatabaseSchemasOnDatabase</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <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/eclipse/persistence/tools/schemaframework/SchemaManager.html#createSchemaWriter">createSchemaWriter</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/SchemaManager.html#createSQLFiles">createSQLFiles</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../../../../../org/eclipse/persistence/tools/schemaframework/TableCreator.html" title="class in org.eclipse.persistence.tools.schemaframework">TableCreator</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/SchemaManager.html#defaultTableCreator">defaultTableCreator</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/HashMap.html?is-external=true" title="class or interface in java.util">HashMap</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">String</a>,<a href="../../../../../org/eclipse/persistence/tools/schemaframework/DatabaseObjectDefinition.html" title="class in org.eclipse.persistence.tools.schemaframework">DatabaseObjectDefinition</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/SchemaManager.html#dropDatabaseSchemas">dropDatabaseSchemas</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <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/eclipse/persistence/tools/schemaframework/SchemaManager.html#dropSchemaWriter">dropSchemaWriter</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/SchemaManager.html#FAST_TABLE_CREATOR">FAST_TABLE_CREATOR</a></span></code> |
| <div class="block">Allow table creator to occur "fast" by just deleting all the rows.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/SchemaManager.html#FORCE_DROP">FORCE_DROP</a></span></code> |
| <div class="block">Allow replacing of table to force the drop, this may require several passes.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected org.eclipse.persistence.internal.sessions.DatabaseSessionImpl</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/SchemaManager.html#session">session</a></span></code> </td> |
| </tr> |
| </table> |
| </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/eclipse/persistence/tools/schemaframework/SchemaManager.html#SchemaManager-org.eclipse.persistence.sessions.DatabaseSession-">SchemaManager</a></span>(<a href="../../../../../org/eclipse/persistence/sessions/DatabaseSession.html" title="interface in org.eclipse.persistence.sessions">DatabaseSession</a> session)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/SchemaManager.html#SchemaManager-org.eclipse.persistence.internal.sessions.DatabaseSessionImpl-">SchemaManager</a></span>(org.eclipse.persistence.internal.sessions.DatabaseSessionImpl session)</code> </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="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/eclipse/persistence/tools/schemaframework/SchemaManager.html#alterSequence-org.eclipse.persistence.tools.schemaframework.SequenceDefinition-">alterSequence</a></span>(<a href="../../../../../org/eclipse/persistence/tools/schemaframework/SequenceDefinition.html" title="class in org.eclipse.persistence.tools.schemaframework">SequenceDefinition</a> sequenceDefinition)</code> |
| <div class="block">Use the definition to alter sequence.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/SchemaManager.html#appendToDDLWriter-java.lang.String-">appendToDDLWriter</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> stringToWrite)</code> |
| <div class="block">PUBLIC: If the schema manager is writing to a writer, append this string |
| to that writer.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/SchemaManager.html#appendToDDLWriter-java.io.Writer-java.lang.String-">appendToDDLWriter</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, |
| <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> stringToWrite)</code> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/SchemaManager.html#buildFieldTypes-org.eclipse.persistence.tools.schemaframework.TableDefinition-">buildFieldTypes</a></span>(<a href="../../../../../org/eclipse/persistence/tools/schemaframework/TableDefinition.html" title="class in org.eclipse.persistence.tools.schemaframework">TableDefinition</a> tableDef)</code> |
| <div class="block">INTERNAL: |
| builds the field names based on the type read in from the builder</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../../../../org/eclipse/persistence/tools/schemaframework/SequenceDefinition.html" title="class in org.eclipse.persistence.tools.schemaframework">SequenceDefinition</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/SchemaManager.html#buildSequenceDefinition-org.eclipse.persistence.sequencing.Sequence-">buildSequenceDefinition</a></span>(<a href="../../../../../org/eclipse/persistence/sequencing/Sequence.html" title="class in org.eclipse.persistence.sequencing">Sequence</a> sequence)</code> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/HashSet.html?is-external=true" title="class or interface in java.util">HashSet</a><<a href="../../../../../org/eclipse/persistence/tools/schemaframework/SequenceDefinition.html" title="class in org.eclipse.persistence.tools.schemaframework">SequenceDefinition</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/SchemaManager.html#buildSequenceDefinitions--">buildSequenceDefinitions</a></span>()</code> |
| <div class="block">INTERNAL: |
| Build the sequence definitions.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/SchemaManager.html#checkTableExists-org.eclipse.persistence.tools.schemaframework.TableDefinition-">checkTableExists</a></span>(<a href="../../../../../org/eclipse/persistence/tools/schemaframework/TableDefinition.html" title="class in org.eclipse.persistence.tools.schemaframework">TableDefinition</a> table)</code> |
| <div class="block">Check if the table exists by issuing a query.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/SchemaManager.html#checkTableExists-org.eclipse.persistence.tools.schemaframework.TableDefinition-boolean-">checkTableExists</a></span>(<a href="../../../../../org/eclipse/persistence/tools/schemaframework/TableDefinition.html" title="class in org.eclipse.persistence.tools.schemaframework">TableDefinition</a> table, |
| boolean suppressLogging)</code> |
| <div class="block">Check if the table exists by issuing a query.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/SchemaManager.html#closeDDLWriter--">closeDDLWriter</a></span>()</code> |
| <div class="block">PUBLIC: |
| Close the schema writer.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/SchemaManager.html#closeDDLWriter-java.io.Writer-">closeDDLWriter</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> </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/SchemaManager.html#collectDatabaseSchemasForDrop-org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition-">collectDatabaseSchemasForDrop</a></span>(<a href="../../../../../org/eclipse/persistence/tools/schemaframework/DatabaseObjectDefinition.html" title="class in org.eclipse.persistence.tools.schemaframework">DatabaseObjectDefinition</a> databaseObjectDefinition)</code> |
| <div class="block">INTERNAL: |
| Called when dropping tables.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/SchemaManager.html#createConstraints-org.eclipse.persistence.tools.schemaframework.TableDefinition-">createConstraints</a></span>(<a href="../../../../../org/eclipse/persistence/tools/schemaframework/TableDefinition.html" title="class in org.eclipse.persistence.tools.schemaframework">TableDefinition</a> tableDefinition)</code> |
| <div class="block">Use the table definition to add the constraints to the database, this is normally done |
| in two steps to avoid dependencies.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/SchemaManager.html#createDefaultTables-boolean-">createDefaultTables</a></span>(boolean generateFKConstraints)</code> |
| <div class="block">Create the default table schema for the project this session associated with.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/SchemaManager.html#createObject-org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition-">createObject</a></span>(<a href="../../../../../org/eclipse/persistence/tools/schemaframework/DatabaseObjectDefinition.html" title="class in org.eclipse.persistence.tools.schemaframework">DatabaseObjectDefinition</a> databaseObjectDefinition)</code> |
| <div class="block">Use the definition object to create the schema entity on the database.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/SchemaManager.html#createOrReplaceSequences-boolean-">createOrReplaceSequences</a></span>(boolean create)</code> |
| <div class="block">Common implementor for createSequence and replaceSequence</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/SchemaManager.html#createOrReplaceSequences-boolean-boolean-">createOrReplaceSequences</a></span>(boolean createSequenceTables, |
| boolean createSequences)</code> |
| <div class="block">Common implementor for createSequence and replaceSequence, distinguishes between sequence tables and sequence objects</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/SchemaManager.html#createSequences--">createSequences</a></span>()</code> |
| <div class="block">Create all the receiver's sequences on the database for all of the loaded descriptors.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/SchemaManager.html#dropConstraints-org.eclipse.persistence.tools.schemaframework.TableDefinition-">dropConstraints</a></span>(<a href="../../../../../org/eclipse/persistence/tools/schemaframework/TableDefinition.html" title="class in org.eclipse.persistence.tools.schemaframework">TableDefinition</a> tableDefinition)</code> |
| <div class="block">Use the table definition to drop the constraints from the table, this is normally done |
| in two steps to avoid dependencies.</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/eclipse/persistence/tools/schemaframework/SchemaManager.html#dropDatabaseSchemas--">dropDatabaseSchemas</a></span>()</code> |
| <div class="block">INTERNAL: |
| Iterate over the schemas that need to be dropped.</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/eclipse/persistence/tools/schemaframework/SchemaManager.html#dropDefaultTables--">dropDefaultTables</a></span>()</code> |
| <div class="block">Create the default table schema for the project this session associated with.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/SchemaManager.html#dropObject-org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition-">dropObject</a></span>(<a href="../../../../../org/eclipse/persistence/tools/schemaframework/DatabaseObjectDefinition.html" title="class in org.eclipse.persistence.tools.schemaframework">DatabaseObjectDefinition</a> databaseObjectDefinition)</code> |
| <div class="block">Use the definition object to drop the schema entity from the database.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/SchemaManager.html#dropSequences--">dropSequences</a></span>()</code> |
| <div class="block">This will drop the database schemas if managing the database schemas.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/SchemaManager.html#dropTable-java.lang.String-">dropTable</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> tableName)</code> |
| <div class="block">Drop (delete) the table named tableName from the database.</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/eclipse/persistence/tools/schemaframework/SchemaManager.html#extendDefaultTables-boolean-">extendDefaultTables</a></span>(boolean generateFKConstraints)</code> |
| <div class="block">Create or extend the default table schema for the project this session associated with.</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/eclipse/persistence/tools/schemaframework/SchemaManager.html#finalize--">finalize</a></span>()</code> |
| <div class="block">INTERNAL: |
| Close the schema writer when the schema manger is garbage collected</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/eclipse/persistence/tools/schemaframework/SchemaManager.html#generateStoredProcedures--">generateStoredProcedures</a></span>()</code> |
| <div class="block">PUBLIC: |
| Use this method to generate stored procedures based on the dynamic SQL generated |
| for your mappings and descriptors.</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/eclipse/persistence/tools/schemaframework/SchemaManager.html#generateStoredProcedures-java.io.Writer-">generateStoredProcedures</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> writer)</code> |
| <div class="block">PUBLIC: |
| Use this method to generate stored procedures based on the dynamic SQL generated |
| for your mappings and descriptors.</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/eclipse/persistence/tools/schemaframework/SchemaManager.html#generateStoredProceduresAndAmendmentClass-java.lang.String-java.lang.String-">generateStoredProceduresAndAmendmentClass</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> path, |
| <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> fullyQualifiedClassName)</code> |
| <div class="block">PUBLIC: |
| Use this method to generate stored procedures based on the dynamic SQL generated |
| for your mappings and descriptors.</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/eclipse/persistence/tools/schemaframework/SchemaManager.html#generateStoredProceduresAndAmendmentClass-java.io.Writer-java.lang.String-">generateStoredProceduresAndAmendmentClass</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> writer, |
| <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> fullyQualifiedClassName)</code> |
| <div class="block">PUBLIC: |
| Use this method to generate stored procedures based on the dynamic SQL generated |
| for your mappings and descriptors.</div> |
| </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code>protected org.eclipse.persistence.internal.databaseaccess.DatabaseAccessor</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/SchemaManager.html#getAccessor--">getAccessor</a></span>()</code> |
| <div class="block">Return the appropriate accessor.</div> |
| </td> |
| </tr> |
| <tr id="i30" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/SchemaManager.html#getAllColumnNames-java.lang.String-">getAllColumnNames</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> tableName)</code> |
| <div class="block">Get a description of table columns available in a catalog.</div> |
| </td> |
| </tr> |
| <tr id="i31" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/SchemaManager.html#getAllColumnNames-java.lang.String-java.lang.String-">getAllColumnNames</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> creatorName, |
| <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> tableName)</code> |
| <div class="block">Get a description of table columns available in a catalog.</div> |
| </td> |
| </tr> |
| <tr id="i32" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/SchemaManager.html#getAllTableNames--">getAllTableNames</a></span>()</code> |
| <div class="block">Get a description of tables available in a catalog.</div> |
| </td> |
| </tr> |
| <tr id="i33" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/SchemaManager.html#getAllTableNames-java.lang.String-">getAllTableNames</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> creatorName)</code> |
| <div class="block">Get a description of table columns available in a catalog.</div> |
| </td> |
| </tr> |
| <tr id="i34" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/SchemaManager.html#getColumnInfo-java.lang.String-java.lang.String-java.lang.String-java.lang.String-">getColumnInfo</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> catalog, |
| <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, |
| <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> tableName, |
| <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> columnName)</code> |
| <div class="block">Get a description of table columns available in a catalog.</div> |
| </td> |
| </tr> |
| <tr id="i35" class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../../../../../org/eclipse/persistence/tools/schemaframework/TableCreator.html" title="class in org.eclipse.persistence.tools.schemaframework">TableCreator</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/SchemaManager.html#getDefaultTableCreator-boolean-">getDefaultTableCreator</a></span>(boolean generateFKConstraints)</code> |
| <div class="block">Construct the default TableCreator.</div> |
| </td> |
| </tr> |
| <tr id="i36" class="altColor"> |
| <td class="colFirst"><code>protected <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/eclipse/persistence/tools/schemaframework/SchemaManager.html#getDropSchemaWriter--">getDropSchemaWriter</a></span>()</code> </td> |
| </tr> |
| <tr id="i37" class="rowColor"> |
| <td class="colFirst"><code>org.eclipse.persistence.internal.sessions.AbstractSession</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/SchemaManager.html#getSession--">getSession</a></span>()</code> </td> |
| </tr> |
| <tr id="i38" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/SchemaManager.html#getTableInfo-java.lang.String-java.lang.String-java.lang.String-java.lang.String:A-">getTableInfo</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> catalog, |
| <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, |
| <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> tableName, |
| <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>[] types)</code> |
| <div class="block">Get a description of tables available in a catalog.</div> |
| </td> |
| </tr> |
| <tr id="i39" class="rowColor"> |
| <td class="colFirst"><code>protected <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/eclipse/persistence/tools/schemaframework/SchemaManager.html#getWriter-java.lang.String-">getWriter</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> fileName)</code> </td> |
| </tr> |
| <tr id="i40" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/SchemaManager.html#outputCreateDDLToFile-java.lang.String-">outputCreateDDLToFile</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> fileName)</code> </td> |
| </tr> |
| <tr id="i41" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/SchemaManager.html#outputCreateDDLToWriter-java.io.Writer-">outputCreateDDLToWriter</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> createWriter)</code> </td> |
| </tr> |
| <tr id="i42" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/SchemaManager.html#outputDDLToDatabase--">outputDDLToDatabase</a></span>()</code> |
| <div class="block">PUBLIC: |
| Output all DDL statements directly to the database.</div> |
| </td> |
| </tr> |
| <tr id="i43" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/SchemaManager.html#outputDDLToFile-java.lang.String-">outputDDLToFile</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> fileName)</code> |
| <div class="block">PUBLIC: |
| Output all DDL statements to a file writer specified by the name in the parameter.</div> |
| </td> |
| </tr> |
| <tr id="i44" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/SchemaManager.html#outputDDLToWriter-java.io.Writer-">outputDDLToWriter</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">PUBLIC: |
| Output all DDL statements to a writer specified in the parameter.</div> |
| </td> |
| </tr> |
| <tr id="i45" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/SchemaManager.html#outputDropDDLToFile-java.lang.String-">outputDropDDLToFile</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> fileName)</code> </td> |
| </tr> |
| <tr id="i46" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/SchemaManager.html#outputDropDDLToWriter-java.io.Writer-">outputDropDDLToWriter</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> dropWriter)</code> </td> |
| </tr> |
| <tr id="i47" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/SchemaManager.html#processSequenceDefinition-org.eclipse.persistence.tools.schemaframework.SequenceDefinition-boolean-boolean-boolean-java.util.HashSet-java.util.HashSet-">processSequenceDefinition</a></span>(<a href="../../../../../org/eclipse/persistence/tools/schemaframework/SequenceDefinition.html" title="class in org.eclipse.persistence.tools.schemaframework">SequenceDefinition</a> definition, |
| boolean createTables, |
| boolean createSequences, |
| boolean replace, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/HashSet.html?is-external=true" title="class or interface in java.util">HashSet</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">String</a>> createdTableNames, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/HashSet.html?is-external=true" title="class or interface in java.util">HashSet</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">String</a>> droppedTableNames)</code> |
| <div class="block">Method creates database tables/objects.</div> |
| </td> |
| </tr> |
| <tr id="i48" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/SchemaManager.html#processSequenceDefinitions-boolean-boolean-boolean-">processSequenceDefinitions</a></span>(boolean createSequenceTables, |
| boolean createSequences, |
| boolean replaceSequences)</code> |
| <div class="block">Common implementor for createSequence and replaceSequence, distinguishes between sequence tables and sequence objects</div> |
| </td> |
| </tr> |
| <tr id="i49" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/SchemaManager.html#replaceDefaultTables--">replaceDefaultTables</a></span>()</code> |
| <div class="block">Drop and recreate the default table schema for the project this session associated with.</div> |
| </td> |
| </tr> |
| <tr id="i50" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/SchemaManager.html#replaceDefaultTables-boolean-boolean-">replaceDefaultTables</a></span>(boolean createSequenceTables, |
| boolean generateFKConstraints)</code> |
| <div class="block">Drop and recreate the default table schema for the project this session associated with.</div> |
| </td> |
| </tr> |
| <tr id="i51" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/SchemaManager.html#replaceDefaultTables-boolean-boolean-boolean-">replaceDefaultTables</a></span>(boolean createSequenceTables, |
| boolean createSequences, |
| boolean generateFKConstraints)</code> |
| <div class="block">Drop and recreate the default table schema for the project this session associated with.</div> |
| </td> |
| </tr> |
| <tr id="i52" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/SchemaManager.html#replaceObject-org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition-">replaceObject</a></span>(<a href="../../../../../org/eclipse/persistence/tools/schemaframework/DatabaseObjectDefinition.html" title="class in org.eclipse.persistence.tools.schemaframework">DatabaseObjectDefinition</a> databaseDefinition)</code> |
| <div class="block">Use the definition object to drop and recreate the schema entity on the database.</div> |
| </td> |
| </tr> |
| <tr id="i53" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/SchemaManager.html#replaceSequences--">replaceSequences</a></span>()</code> |
| <div class="block">Drop and recreate all the receiver's sequences on the database for all of the loaded descriptors.</div> |
| </td> |
| </tr> |
| <tr id="i54" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/SchemaManager.html#setCreateDatabaseSchemas-boolean-">setCreateDatabaseSchemas</a></span>(boolean createDatabaseSchemas)</code> |
| <div class="block">INTERNAL: |
| Set to true if database schemas should be built during the DDL generation.</div> |
| </td> |
| </tr> |
| <tr id="i55" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/SchemaManager.html#setCreateSQLFiles-boolean-">setCreateSQLFiles</a></span>(boolean genFlag)</code> </td> |
| </tr> |
| <tr id="i56" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/SchemaManager.html#setSession-org.eclipse.persistence.internal.sessions.DatabaseSessionImpl-">setSession</a></span>(org.eclipse.persistence.internal.sessions.DatabaseSessionImpl session)</code> </td> |
| </tr> |
| <tr id="i57" class="rowColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/SchemaManager.html#shouldCreateDatabaseSchema-org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition-java.util.Set-">shouldCreateDatabaseSchema</a></span>(<a href="../../../../../org/eclipse/persistence/tools/schemaframework/DatabaseObjectDefinition.html" title="class in org.eclipse.persistence.tools.schemaframework">DatabaseObjectDefinition</a> databaseObjectDefinition, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</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">String</a>> createdDatabaseSchemas)</code> |
| <div class="block">INTERNAL: |
| Returns true if a database schema should be created during ddl generation |
| for the given databaseObjectDefinition.</div> |
| </td> |
| </tr> |
| <tr id="i58" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/SchemaManager.html#shouldWriteToDatabase--">shouldWriteToDatabase</a></span>()</code> |
| <div class="block">PUBLIC: |
| Return true if this SchemaManager should write to the database directly</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#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="session"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>session</h4> |
| <pre>protected org.eclipse.persistence.internal.sessions.DatabaseSessionImpl session</pre> |
| </li> |
| </ul> |
| <a name="createSchemaWriter"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createSchemaWriter</h4> |
| <pre>protected <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> createSchemaWriter</pre> |
| </li> |
| </ul> |
| <a name="dropSchemaWriter"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>dropSchemaWriter</h4> |
| <pre>protected <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> dropSchemaWriter</pre> |
| </li> |
| </ul> |
| <a name="createSQLFiles"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createSQLFiles</h4> |
| <pre>protected boolean createSQLFiles</pre> |
| </li> |
| </ul> |
| <a name="defaultTableCreator"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>defaultTableCreator</h4> |
| <pre>protected <a href="../../../../../org/eclipse/persistence/tools/schemaframework/TableCreator.html" title="class in org.eclipse.persistence.tools.schemaframework">TableCreator</a> defaultTableCreator</pre> |
| </li> |
| </ul> |
| <a name="FAST_TABLE_CREATOR"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>FAST_TABLE_CREATOR</h4> |
| <pre>public static boolean FAST_TABLE_CREATOR</pre> |
| <div class="block">Allow table creator to occur "fast" by just deleting all the rows.</div> |
| </li> |
| </ul> |
| <a name="FORCE_DROP"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>FORCE_DROP</h4> |
| <pre>public static boolean FORCE_DROP</pre> |
| <div class="block">Allow replacing of table to force the drop, this may require several passes.</div> |
| </li> |
| </ul> |
| <a name="createDatabaseSchemas"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createDatabaseSchemas</h4> |
| <pre>protected boolean createDatabaseSchemas</pre> |
| <div class="block">Flag to determine if database schemas should be created during DDL generation</div> |
| </li> |
| </ul> |
| <a name="createdDatabaseSchemas"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createdDatabaseSchemas</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/HashSet.html?is-external=true" title="class or interface in java.util">HashSet</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">String</a>> createdDatabaseSchemas</pre> |
| </li> |
| </ul> |
| <a name="createdDatabaseSchemasOnDatabase"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createdDatabaseSchemasOnDatabase</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/HashSet.html?is-external=true" title="class or interface in java.util">HashSet</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">String</a>> createdDatabaseSchemasOnDatabase</pre> |
| </li> |
| </ul> |
| <a name="dropDatabaseSchemas"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>dropDatabaseSchemas</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/HashMap.html?is-external=true" title="class or interface in java.util">HashMap</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">String</a>,<a href="../../../../../org/eclipse/persistence/tools/schemaframework/DatabaseObjectDefinition.html" title="class in org.eclipse.persistence.tools.schemaframework">DatabaseObjectDefinition</a>> dropDatabaseSchemas</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="SchemaManager-org.eclipse.persistence.internal.sessions.DatabaseSessionImpl-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SchemaManager</h4> |
| <pre>public SchemaManager(org.eclipse.persistence.internal.sessions.DatabaseSessionImpl session)</pre> |
| </li> |
| </ul> |
| <a name="SchemaManager-org.eclipse.persistence.sessions.DatabaseSession-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>SchemaManager</h4> |
| <pre>public SchemaManager(<a href="../../../../../org/eclipse/persistence/sessions/DatabaseSession.html" title="interface in org.eclipse.persistence.sessions">DatabaseSession</a> session)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getDropSchemaWriter--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDropSchemaWriter</h4> |
| <pre>protected <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> getDropSchemaWriter()</pre> |
| </li> |
| </ul> |
| <a name="appendToDDLWriter-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>appendToDDLWriter</h4> |
| <pre>public void appendToDDLWriter(<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> stringToWrite)</pre> |
| <div class="block">PUBLIC: If the schema manager is writing to a writer, append this string |
| to that writer.</div> |
| </li> |
| </ul> |
| <a name="appendToDDLWriter-java.io.Writer-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>appendToDDLWriter</h4> |
| <pre>public void appendToDDLWriter(<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, |
| <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> stringToWrite)</pre> |
| </li> |
| </ul> |
| <a name="buildFieldTypes-org.eclipse.persistence.tools.schemaframework.TableDefinition-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>buildFieldTypes</h4> |
| <pre>public void buildFieldTypes(<a href="../../../../../org/eclipse/persistence/tools/schemaframework/TableDefinition.html" title="class in org.eclipse.persistence.tools.schemaframework">TableDefinition</a> tableDef)</pre> |
| <div class="block">INTERNAL: |
| builds the field names based on the type read in from the builder</div> |
| </li> |
| </ul> |
| <a name="closeDDLWriter--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>closeDDLWriter</h4> |
| <pre>public void closeDDLWriter()</pre> |
| <div class="block">PUBLIC: |
| Close the schema writer.</div> |
| </li> |
| </ul> |
| <a name="closeDDLWriter-java.io.Writer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>closeDDLWriter</h4> |
| <pre>public void closeDDLWriter(<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> |
| </li> |
| </ul> |
| <a name="collectDatabaseSchemasForDrop-org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>collectDatabaseSchemasForDrop</h4> |
| <pre>protected void collectDatabaseSchemasForDrop(<a href="../../../../../org/eclipse/persistence/tools/schemaframework/DatabaseObjectDefinition.html" title="class in org.eclipse.persistence.tools.schemaframework">DatabaseObjectDefinition</a> databaseObjectDefinition)</pre> |
| <div class="block">INTERNAL: |
| Called when dropping tables. Will build a map of those schemas (and a |
| table that references it) that should be dropped.</div> |
| </li> |
| </ul> |
| <a name="createConstraints-org.eclipse.persistence.tools.schemaframework.TableDefinition-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createConstraints</h4> |
| <pre>public void createConstraints(<a href="../../../../../org/eclipse/persistence/tools/schemaframework/TableDefinition.html" title="class in org.eclipse.persistence.tools.schemaframework">TableDefinition</a> tableDefinition) |
| throws <a href="../../../../../org/eclipse/persistence/exceptions/EclipseLinkException.html" title="class in org.eclipse.persistence.exceptions">EclipseLinkException</a></pre> |
| <div class="block">Use the table definition to add the constraints to the database, this is normally done |
| in two steps to avoid dependencies.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/eclipse/persistence/exceptions/EclipseLinkException.html" title="class in org.eclipse.persistence.exceptions">EclipseLinkException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createObject-org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createObject</h4> |
| <pre>public void createObject(<a href="../../../../../org/eclipse/persistence/tools/schemaframework/DatabaseObjectDefinition.html" title="class in org.eclipse.persistence.tools.schemaframework">DatabaseObjectDefinition</a> databaseObjectDefinition) |
| throws <a href="../../../../../org/eclipse/persistence/exceptions/EclipseLinkException.html" title="class in org.eclipse.persistence.exceptions">EclipseLinkException</a></pre> |
| <div class="block">Use the definition object to create the schema entity on the database. |
| This is used for creating tables, views, procedures ... etc ...</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/eclipse/persistence/exceptions/EclipseLinkException.html" title="class in org.eclipse.persistence.exceptions">EclipseLinkException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createSequences--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createSequences</h4> |
| <pre>public void createSequences() |
| throws <a href="../../../../../org/eclipse/persistence/exceptions/EclipseLinkException.html" title="class in org.eclipse.persistence.exceptions">EclipseLinkException</a></pre> |
| <div class="block">Create all the receiver's sequences on the database for all of the loaded descriptors.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/eclipse/persistence/exceptions/EclipseLinkException.html" title="class in org.eclipse.persistence.exceptions">EclipseLinkException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setCreateDatabaseSchemas-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCreateDatabaseSchemas</h4> |
| <pre>public void setCreateDatabaseSchemas(boolean createDatabaseSchemas)</pre> |
| <div class="block">INTERNAL: |
| Set to true if database schemas should be built during the DDL generation.</div> |
| </li> |
| </ul> |
| <a name="setCreateSQLFiles-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCreateSQLFiles</h4> |
| <pre>public void setCreateSQLFiles(boolean genFlag)</pre> |
| </li> |
| </ul> |
| <a name="replaceSequences--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>replaceSequences</h4> |
| <pre>public void replaceSequences() |
| throws <a href="../../../../../org/eclipse/persistence/exceptions/EclipseLinkException.html" title="class in org.eclipse.persistence.exceptions">EclipseLinkException</a></pre> |
| <div class="block">Drop and recreate all the receiver's sequences on the database for all of the loaded descriptors.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/eclipse/persistence/exceptions/EclipseLinkException.html" title="class in org.eclipse.persistence.exceptions">EclipseLinkException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createOrReplaceSequences-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createOrReplaceSequences</h4> |
| <pre>protected void createOrReplaceSequences(boolean create) |
| throws <a href="../../../../../org/eclipse/persistence/exceptions/EclipseLinkException.html" title="class in org.eclipse.persistence.exceptions">EclipseLinkException</a></pre> |
| <div class="block">Common implementor for createSequence and replaceSequence</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>create</code> - - true to create the sequences, false to replace them (dropped then create)</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/eclipse/persistence/exceptions/EclipseLinkException.html" title="class in org.eclipse.persistence.exceptions">EclipseLinkException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createOrReplaceSequences-boolean-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createOrReplaceSequences</h4> |
| <pre>protected void createOrReplaceSequences(boolean createSequenceTables, |
| boolean createSequences) |
| throws <a href="../../../../../org/eclipse/persistence/exceptions/EclipseLinkException.html" title="class in org.eclipse.persistence.exceptions">EclipseLinkException</a></pre> |
| <div class="block">Common implementor for createSequence and replaceSequence, distinguishes between sequence tables and sequence objects</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>createSequenceTables</code> - - true to create the sequences tables, false to replace them (dropped then create)</dd> |
| <dd><code>createSequences</code> - - true to create the sequences objects, false to replace them (dropped then create)</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/eclipse/persistence/exceptions/EclipseLinkException.html" title="class in org.eclipse.persistence.exceptions">EclipseLinkException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="dropSequences--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>dropSequences</h4> |
| <pre>protected void dropSequences()</pre> |
| <div class="block">This will drop the database schemas if managing the database schemas.</div> |
| </li> |
| </ul> |
| <a name="processSequenceDefinition-org.eclipse.persistence.tools.schemaframework.SequenceDefinition-boolean-boolean-boolean-java.util.HashSet-java.util.HashSet-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>processSequenceDefinition</h4> |
| <pre>protected void processSequenceDefinition(<a href="../../../../../org/eclipse/persistence/tools/schemaframework/SequenceDefinition.html" title="class in org.eclipse.persistence.tools.schemaframework">SequenceDefinition</a> definition, |
| boolean createTables, |
| boolean createSequences, |
| boolean replace, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/HashSet.html?is-external=true" title="class or interface in java.util">HashSet</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">String</a>> createdTableNames, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/HashSet.html?is-external=true" title="class or interface in java.util">HashSet</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">String</a>> droppedTableNames) |
| throws <a href="../../../../../org/eclipse/persistence/exceptions/EclipseLinkException.html" title="class in org.eclipse.persistence.exceptions">EclipseLinkException</a></pre> |
| <div class="block">Method creates database tables/objects. If create is true, it will |
| attempt to create the object and silently ignore exceptions. If create |
| is false, it will drop the object ignoring any exceptions, then create |
| it if the replace flag is true (otherwise a drop only).</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>definition</code> - - the sequence definition</dd> |
| <dd><code>createTables</code> - - true if table sequence table definitions should be created.</dd> |
| <dd><code>createSequences</code> - - true if the sequence definition should be created, |
| false if it should be dropped.</dd> |
| <dd><code>replace</code> - - true if table definitions and sequence definitions should be replaced.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/eclipse/persistence/exceptions/EclipseLinkException.html" title="class in org.eclipse.persistence.exceptions">EclipseLinkException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="processSequenceDefinitions-boolean-boolean-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>processSequenceDefinitions</h4> |
| <pre>protected void processSequenceDefinitions(boolean createSequenceTables, |
| boolean createSequences, |
| boolean replaceSequences) |
| throws <a href="../../../../../org/eclipse/persistence/exceptions/EclipseLinkException.html" title="class in org.eclipse.persistence.exceptions">EclipseLinkException</a></pre> |
| <div class="block">Common implementor for createSequence and replaceSequence, distinguishes between sequence tables and sequence objects</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>createSequenceTables</code> - - true to create the sequences tables, false to replace them (dropped then create)</dd> |
| <dd><code>createSequences</code> - - true to create the sequences objects, false to replace them (dropped then create)</dd> |
| <dd><code>replaceSequences</code> - - true to actually replace, false to drop only.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/eclipse/persistence/exceptions/EclipseLinkException.html" title="class in org.eclipse.persistence.exceptions">EclipseLinkException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="buildSequenceDefinitions--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>buildSequenceDefinitions</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/HashSet.html?is-external=true" title="class or interface in java.util">HashSet</a><<a href="../../../../../org/eclipse/persistence/tools/schemaframework/SequenceDefinition.html" title="class in org.eclipse.persistence.tools.schemaframework">SequenceDefinition</a>> buildSequenceDefinitions()</pre> |
| <div class="block">INTERNAL: |
| Build the sequence definitions.</div> |
| </li> |
| </ul> |
| <a name="checkTableExists-org.eclipse.persistence.tools.schemaframework.TableDefinition-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>checkTableExists</h4> |
| <pre>public boolean checkTableExists(<a href="../../../../../org/eclipse/persistence/tools/schemaframework/TableDefinition.html" title="class in org.eclipse.persistence.tools.schemaframework">TableDefinition</a> table, |
| boolean suppressLogging)</pre> |
| <div class="block">Check if the table exists by issuing a query.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>table</code> - database table meta-data</dd> |
| <dd><code>suppressLogging</code> - whether to suppress logging during query execution</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>value of <code>true</code> if given table exists or <code>false</code> otherwise</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="checkTableExists-org.eclipse.persistence.tools.schemaframework.TableDefinition-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>checkTableExists</h4> |
| <pre>public boolean checkTableExists(<a href="../../../../../org/eclipse/persistence/tools/schemaframework/TableDefinition.html" title="class in org.eclipse.persistence.tools.schemaframework">TableDefinition</a> table)</pre> |
| <div class="block">Check if the table exists by issuing a query. |
| Logging is suppressed during query execution.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>table</code> - database table meta-data</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>value of <code>true</code> if given table exists or <code>false</code> otherwise</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="buildSequenceDefinition-org.eclipse.persistence.sequencing.Sequence-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>buildSequenceDefinition</h4> |
| <pre>protected <a href="../../../../../org/eclipse/persistence/tools/schemaframework/SequenceDefinition.html" title="class in org.eclipse.persistence.tools.schemaframework">SequenceDefinition</a> buildSequenceDefinition(<a href="../../../../../org/eclipse/persistence/sequencing/Sequence.html" title="class in org.eclipse.persistence.sequencing">Sequence</a> sequence)</pre> |
| </li> |
| </ul> |
| <a name="dropConstraints-org.eclipse.persistence.tools.schemaframework.TableDefinition-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>dropConstraints</h4> |
| <pre>public void dropConstraints(<a href="../../../../../org/eclipse/persistence/tools/schemaframework/TableDefinition.html" title="class in org.eclipse.persistence.tools.schemaframework">TableDefinition</a> tableDefinition) |
| throws <a href="../../../../../org/eclipse/persistence/exceptions/EclipseLinkException.html" title="class in org.eclipse.persistence.exceptions">EclipseLinkException</a></pre> |
| <div class="block">Use the table definition to drop the constraints from the table, this is normally done |
| in two steps to avoid dependencies.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/eclipse/persistence/exceptions/EclipseLinkException.html" title="class in org.eclipse.persistence.exceptions">EclipseLinkException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="dropObject-org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>dropObject</h4> |
| <pre>public void dropObject(<a href="../../../../../org/eclipse/persistence/tools/schemaframework/DatabaseObjectDefinition.html" title="class in org.eclipse.persistence.tools.schemaframework">DatabaseObjectDefinition</a> databaseObjectDefinition) |
| throws <a href="../../../../../org/eclipse/persistence/exceptions/EclipseLinkException.html" title="class in org.eclipse.persistence.exceptions">EclipseLinkException</a></pre> |
| <div class="block">Use the definition object to drop the schema entity from the database. |
| This is used for dropping tables, views, procedures ... etc ...</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/eclipse/persistence/exceptions/EclipseLinkException.html" title="class in org.eclipse.persistence.exceptions">EclipseLinkException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="dropTable-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>dropTable</h4> |
| <pre>public void dropTable(<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> tableName) |
| throws <a href="../../../../../org/eclipse/persistence/exceptions/EclipseLinkException.html" title="class in org.eclipse.persistence.exceptions">EclipseLinkException</a></pre> |
| <div class="block">Drop (delete) the table named tableName from the database.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/eclipse/persistence/exceptions/EclipseLinkException.html" title="class in org.eclipse.persistence.exceptions">EclipseLinkException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="finalize--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>finalize</h4> |
| <pre>public void finalize()</pre> |
| <div class="block">INTERNAL: |
| Close the schema writer when the schema manger is garbage collected</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><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></code> in class <code><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></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="generateStoredProcedures--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>generateStoredProcedures</h4> |
| <pre>public void generateStoredProcedures() |
| throws <a href="../../../../../org/eclipse/persistence/exceptions/EclipseLinkException.html" title="class in org.eclipse.persistence.exceptions">EclipseLinkException</a></pre> |
| <div class="block">PUBLIC: |
| Use this method to generate stored procedures based on the dynamic SQL generated |
| for your mappings and descriptors. This should be used with caution as it maintenance |
| will be high. Stored procedures may be generated either directly on the database |
| or to a file.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/eclipse/persistence/exceptions/EclipseLinkException.html" title="class in org.eclipse.persistence.exceptions">EclipseLinkException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="generateStoredProcedures-java.io.Writer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>generateStoredProcedures</h4> |
| <pre>public void generateStoredProcedures(<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> writer) |
| throws <a href="../../../../../org/eclipse/persistence/exceptions/EclipseLinkException.html" title="class in org.eclipse.persistence.exceptions">EclipseLinkException</a></pre> |
| <div class="block">PUBLIC: |
| Use this method to generate stored procedures based on the dynamic SQL generated |
| for your mappings and descriptors. This should be used with caution as it maintenance |
| will be high. Stored procedures may be generated either directly on the database |
| or to a file.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/eclipse/persistence/exceptions/EclipseLinkException.html" title="class in org.eclipse.persistence.exceptions">EclipseLinkException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="generateStoredProceduresAndAmendmentClass-java.io.Writer-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>generateStoredProceduresAndAmendmentClass</h4> |
| <pre>public void generateStoredProceduresAndAmendmentClass(<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> writer, |
| <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> fullyQualifiedClassName) |
| throws <a href="../../../../../org/eclipse/persistence/exceptions/EclipseLinkException.html" title="class in org.eclipse.persistence.exceptions">EclipseLinkException</a></pre> |
| <div class="block">PUBLIC: |
| Use this method to generate stored procedures based on the dynamic SQL generated |
| for your mappings and descriptors. This should be used with caution as it maintenance |
| will be high. Stored procedures may be generated either directly on the database |
| or to a file.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/eclipse/persistence/exceptions/EclipseLinkException.html" title="class in org.eclipse.persistence.exceptions">EclipseLinkException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="generateStoredProceduresAndAmendmentClass-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>generateStoredProceduresAndAmendmentClass</h4> |
| <pre>public void generateStoredProceduresAndAmendmentClass(<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> path, |
| <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> fullyQualifiedClassName) |
| throws <a href="../../../../../org/eclipse/persistence/exceptions/EclipseLinkException.html" title="class in org.eclipse.persistence.exceptions">EclipseLinkException</a></pre> |
| <div class="block">PUBLIC: |
| Use this method to generate stored procedures based on the dynamic SQL generated |
| for your mappings and descriptors. This should be used with caution as it maintenance |
| will be high. Stored procedures may be generated either directly on the database |
| or to a file.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/eclipse/persistence/exceptions/EclipseLinkException.html" title="class in org.eclipse.persistence.exceptions">EclipseLinkException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAccessor--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAccessor</h4> |
| <pre>protected org.eclipse.persistence.internal.databaseaccess.DatabaseAccessor getAccessor()</pre> |
| <div class="block">Return the appropriate accessor. |
| Assume we are dealing with a JDBC accessor.</div> |
| </li> |
| </ul> |
| <a name="getAllColumnNames-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAllColumnNames</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a> getAllColumnNames(<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> tableName) |
| throws <a href="../../../../../org/eclipse/persistence/exceptions/DatabaseException.html" title="class in org.eclipse.persistence.exceptions">DatabaseException</a></pre> |
| <div class="block">Get a description of table columns available in a catalog. |
| |
| <P>Each column description has the following columns: |
| <OL> |
| <LI><B>TABLE_CAT</B> String => table catalog (may be null) |
| <LI><B>TABLE_SCHEM</B> String => table schema (may be null) |
| <LI><B>TABLE_NAME</B> String => table name |
| <LI><B>COLUMN_NAME</B> String => column name |
| <LI><B>DATA_TYPE</B> short => SQL type from java.sql.Types |
| <LI><B>TYPE_NAME</B> String => Data source dependent type name |
| <LI><B>COLUMN_SIZE</B> int => column size. For char or date |
| types this is the maximum number of characters, for numeric or |
| decimal types this is precision. |
| <LI><B>BUFFER_LENGTH</B> is not used. |
| <LI><B>DECIMAL_DIGITS</B> int => the number of fractional digits |
| <LI><B>NUM_PREC_RADIX</B> int => Radix (typically either 10 or 2) |
| <LI><B>NULLABLE</B> int => is NULL allowed? |
| <UL> |
| <LI> columnNoNulls - might not allow NULL values |
| <LI> columnNullable - definitely allows NULL values |
| <LI> columnNullableUnknown - nullability unknown |
| </UL> |
| <LI><B>REMARKS</B> String => comment describing column (may be null) |
| <LI><B>COLUMN_DEF</B> String => default value (may be null) |
| <LI><B>SQL_DATA_TYPE</B> int => unused |
| <LI><B>SQL_DATETIME_SUB</B> int => unused |
| <LI><B>CHAR_OCTET_LENGTH</B> int => for char types the |
| maximum number of bytes in the column |
| <LI><B>ORDINAL_POSITION</B> int => index of column in table |
| (starting at 1) |
| <LI><B>IS_NULLABLE</B> String => "NO" means column definitely |
| does not allow NULL values; "YES" means the column might |
| allow NULL values. An empty string means nobody knows. |
| </OL></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>tableName</code> - a table name pattern</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a Vector of Records.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/eclipse/persistence/exceptions/DatabaseException.html" title="class in org.eclipse.persistence.exceptions">DatabaseException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAllColumnNames-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAllColumnNames</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a> getAllColumnNames(<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> creatorName, |
| <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> tableName) |
| throws <a href="../../../../../org/eclipse/persistence/exceptions/DatabaseException.html" title="class in org.eclipse.persistence.exceptions">DatabaseException</a></pre> |
| <div class="block">Get a description of table columns available in a catalog. |
| |
| <P>Each column description has the following columns: |
| <OL> |
| <LI><B>TABLE_CAT</B> String => table catalog (may be null) |
| <LI><B>TABLE_SCHEM</B> String => table schema (may be null) |
| <LI><B>TABLE_NAME</B> String => table name |
| <LI><B>COLUMN_NAME</B> String => column name |
| <LI><B>DATA_TYPE</B> short => SQL type from java.sql.Types |
| <LI><B>TYPE_NAME</B> String => Data source dependent type name |
| <LI><B>COLUMN_SIZE</B> int => column size. For char or date |
| types this is the maximum number of characters, for numeric or |
| decimal types this is precision. |
| <LI><B>BUFFER_LENGTH</B> is not used. |
| <LI><B>DECIMAL_DIGITS</B> int => the number of fractional digits |
| <LI><B>NUM_PREC_RADIX</B> int => Radix (typically either 10 or 2) |
| <LI><B>NULLABLE</B> int => is NULL allowed? |
| <UL> |
| <LI> columnNoNulls - might not allow NULL values |
| <LI> columnNullable - definitely allows NULL values |
| <LI> columnNullableUnknown - nullability unknown |
| </UL> |
| <LI><B>REMARKS</B> String => comment describing column (may be null) |
| <LI><B>COLUMN_DEF</B> String => default value (may be null) |
| <LI><B>SQL_DATA_TYPE</B> int => unused |
| <LI><B>SQL_DATETIME_SUB</B> int => unused |
| <LI><B>CHAR_OCTET_LENGTH</B> int => for char types the |
| maximum number of bytes in the column |
| <LI><B>ORDINAL_POSITION</B> int => index of column in table |
| (starting at 1) |
| <LI><B>IS_NULLABLE</B> String => "NO" means column definitely |
| does not allow NULL values; "YES" means the column might |
| allow NULL values. An empty string means nobody knows. |
| </OL></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>creatorName</code> - a schema name pattern; "" retrieves those |
| without a schema</dd> |
| <dd><code>tableName</code> - a table name pattern</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a Vector of Records.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/eclipse/persistence/exceptions/DatabaseException.html" title="class in org.eclipse.persistence.exceptions">DatabaseException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAllTableNames--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAllTableNames</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a> getAllTableNames() |
| throws <a href="../../../../../org/eclipse/persistence/exceptions/DatabaseException.html" title="class in org.eclipse.persistence.exceptions">DatabaseException</a></pre> |
| <div class="block">Get a description of tables available in a catalog. |
| |
| <P>Each table description has the following columns: |
| <OL> |
| <LI><B>TABLE_CAT</B> String => table catalog (may be null) |
| <LI><B>TABLE_SCHEM</B> String => table schema (may be null) |
| <LI><B>TABLE_NAME</B> String => table name |
| <LI><B>TABLE_TYPE</B> String => table type. Typical types are "TABLE", |
| "VIEW", "SYSTEM TABLE", "GLOBAL TEMPORARY", |
| "LOCAL TEMPORARY", "ALIAS", "SYNONYM". |
| <LI><B>REMARKS</B> String => explanatory comment on the table |
| </OL> |
| |
| <P><B>Note:</B> Some databases may not return information for |
| all tables.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a Vector of Records.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/eclipse/persistence/exceptions/DatabaseException.html" title="class in org.eclipse.persistence.exceptions">DatabaseException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAllTableNames-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAllTableNames</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a> getAllTableNames(<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> creatorName) |
| throws <a href="../../../../../org/eclipse/persistence/exceptions/DatabaseException.html" title="class in org.eclipse.persistence.exceptions">DatabaseException</a></pre> |
| <div class="block">Get a description of table columns available in a catalog. |
| |
| <P>Each column description has the following columns: |
| <OL> |
| <LI><B>TABLE_CAT</B> String => table catalog (may be null) |
| <LI><B>TABLE_SCHEM</B> String => table schema (may be null) |
| <LI><B>TABLE_NAME</B> String => table name |
| <LI><B>COLUMN_NAME</B> String => column name |
| <LI><B>DATA_TYPE</B> short => SQL type from java.sql.Types |
| <LI><B>TYPE_NAME</B> String => Data source dependent type name |
| <LI><B>COLUMN_SIZE</B> int => column size. For char or date |
| types this is the maximum number of characters, for numeric or |
| decimal types this is precision. |
| <LI><B>BUFFER_LENGTH</B> is not used. |
| <LI><B>DECIMAL_DIGITS</B> int => the number of fractional digits |
| <LI><B>NUM_PREC_RADIX</B> int => Radix (typically either 10 or 2) |
| <LI><B>NULLABLE</B> int => is NULL allowed? |
| <UL> |
| <LI> columnNoNulls - might not allow NULL values |
| <LI> columnNullable - definitely allows NULL values |
| <LI> columnNullableUnknown - nullability unknown |
| </UL> |
| <LI><B>REMARKS</B> String => comment describing column (may be null) |
| <LI><B>COLUMN_DEF</B> String => default value (may be null) |
| <LI><B>SQL_DATA_TYPE</B> int => unused |
| <LI><B>SQL_DATETIME_SUB</B> int => unused |
| <LI><B>CHAR_OCTET_LENGTH</B> int => for char types the |
| maximum number of bytes in the column |
| <LI><B>ORDINAL_POSITION</B> int => index of column in table |
| (starting at 1) |
| <LI><B>IS_NULLABLE</B> String => "NO" means column definitely |
| does not allow NULL values; "YES" means the column might |
| allow NULL values. An empty string means nobody knows. |
| </OL></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>creatorName</code> - a schema name pattern; "" retrieves those |
| without a schema</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a Vector of Records.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/eclipse/persistence/exceptions/DatabaseException.html" title="class in org.eclipse.persistence.exceptions">DatabaseException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getColumnInfo-java.lang.String-java.lang.String-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getColumnInfo</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a> getColumnInfo(<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> catalog, |
| <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, |
| <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> tableName, |
| <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> columnName) |
| throws <a href="../../../../../org/eclipse/persistence/exceptions/DatabaseException.html" title="class in org.eclipse.persistence.exceptions">DatabaseException</a></pre> |
| <div class="block">Get a description of table columns available in a catalog. |
| |
| <P>Only column descriptions matching the catalog, schema, table |
| and column name criteria are returned. They are ordered by |
| TABLE_SCHEM, TABLE_NAME and ORDINAL_POSITION. |
| |
| <P>Each column description has the following columns: |
| <OL> |
| <LI><B>TABLE_CAT</B> String => table catalog (may be null) |
| <LI><B>TABLE_SCHEM</B> String => table schema (may be null) |
| <LI><B>TABLE_NAME</B> String => table name |
| <LI><B>COLUMN_NAME</B> String => column name |
| <LI><B>DATA_TYPE</B> short => SQL type from java.sql.Types |
| <LI><B>TYPE_NAME</B> String => Data source dependent type name |
| <LI><B>COLUMN_SIZE</B> int => column size. For char or date |
| types this is the maximum number of characters, for numeric or |
| decimal types this is precision. |
| <LI><B>BUFFER_LENGTH</B> is not used. |
| <LI><B>DECIMAL_DIGITS</B> int => the number of fractional digits |
| <LI><B>NUM_PREC_RADIX</B> int => Radix (typically either 10 or 2) |
| <LI><B>NULLABLE</B> int => is NULL allowed? |
| <UL> |
| <LI> columnNoNulls - might not allow NULL values |
| <LI> columnNullable - definitely allows NULL values |
| <LI> columnNullableUnknown - nullability unknown |
| </UL> |
| <LI><B>REMARKS</B> String => comment describing column (may be null) |
| <LI><B>COLUMN_DEF</B> String => default value (may be null) |
| <LI><B>SQL_DATA_TYPE</B> int => unused |
| <LI><B>SQL_DATETIME_SUB</B> int => unused |
| <LI><B>CHAR_OCTET_LENGTH</B> int => for char types the |
| maximum number of bytes in the column |
| <LI><B>ORDINAL_POSITION</B> int => index of column in table |
| (starting at 1) |
| <LI><B>IS_NULLABLE</B> String => "NO" means column definitely |
| does not allow NULL values; "YES" means the column might |
| allow NULL values. An empty string means nobody knows. |
| </OL></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>catalog</code> - a catalog name; "" retrieves those without a |
| catalog; null means drop catalog name from the selection criteria</dd> |
| <dd><code>schema</code> - a schema name pattern; "" retrieves those |
| without a schema</dd> |
| <dd><code>tableName</code> - a table name pattern</dd> |
| <dd><code>columnName</code> - a column name pattern</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a Vector of Records.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/eclipse/persistence/exceptions/DatabaseException.html" title="class in org.eclipse.persistence.exceptions">DatabaseException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSession--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSession</h4> |
| <pre>public org.eclipse.persistence.internal.sessions.AbstractSession getSession()</pre> |
| </li> |
| </ul> |
| <a name="getTableInfo-java.lang.String-java.lang.String-java.lang.String-java.lang.String:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTableInfo</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a> getTableInfo(<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> catalog, |
| <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, |
| <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> tableName, |
| <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>[] types) |
| throws <a href="../../../../../org/eclipse/persistence/exceptions/DatabaseException.html" title="class in org.eclipse.persistence.exceptions">DatabaseException</a></pre> |
| <div class="block">Get a description of tables available in a catalog. |
| |
| <P>Only table descriptions matching the catalog, schema, table |
| name and type criteria are returned. They are ordered by |
| TABLE_TYPE, TABLE_SCHEM and TABLE_NAME. |
| |
| <P>Each table description has the following columns: |
| <OL> |
| <LI><B>TABLE_CAT</B> String => table catalog (may be null) |
| <LI><B>TABLE_SCHEM</B> String => table schema (may be null) |
| <LI><B>TABLE_NAME</B> String => table name |
| <LI><B>TABLE_TYPE</B> String => table type. Typical types are "TABLE", |
| "VIEW", "SYSTEM TABLE", "GLOBAL TEMPORARY", |
| "LOCAL TEMPORARY", "ALIAS", "SYNONYM". |
| <LI><B>REMARKS</B> String => explanatory comment on the table |
| </OL> |
| |
| <P><B>Note:</B> Some databases may not return information for |
| all tables.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>catalog</code> - a catalog name; "" retrieves those without a |
| catalog; null means drop catalog name from the selection criteria</dd> |
| <dd><code>schema</code> - a schema name pattern; "" retrieves those |
| without a schema</dd> |
| <dd><code>tableName</code> - a table name pattern</dd> |
| <dd><code>types</code> - a list of table types to include; null returns all types</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a Vector of Records.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/eclipse/persistence/exceptions/DatabaseException.html" title="class in org.eclipse.persistence.exceptions">DatabaseException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="outputDDLToDatabase--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>outputDDLToDatabase</h4> |
| <pre>public void outputDDLToDatabase()</pre> |
| <div class="block">PUBLIC: |
| Output all DDL statements directly to the database.</div> |
| </li> |
| </ul> |
| <a name="outputDDLToFile-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>outputDDLToFile</h4> |
| <pre>public void outputDDLToFile(<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> fileName)</pre> |
| <div class="block">PUBLIC: |
| Output all DDL statements to a file writer specified by the name in the parameter.</div> |
| </li> |
| </ul> |
| <a name="outputCreateDDLToFile-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>outputCreateDDLToFile</h4> |
| <pre>public void outputCreateDDLToFile(<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> fileName)</pre> |
| </li> |
| </ul> |
| <a name="outputDropDDLToFile-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>outputDropDDLToFile</h4> |
| <pre>public void outputDropDDLToFile(<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> fileName)</pre> |
| </li> |
| </ul> |
| <a name="getWriter-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getWriter</h4> |
| <pre>protected <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> getWriter(<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> fileName)</pre> |
| </li> |
| </ul> |
| <a name="outputDDLToWriter-java.io.Writer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>outputDDLToWriter</h4> |
| <pre>public void outputDDLToWriter(<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">PUBLIC: |
| Output all DDL statements to a writer specified in the parameter.</div> |
| </li> |
| </ul> |
| <a name="outputCreateDDLToWriter-java.io.Writer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>outputCreateDDLToWriter</h4> |
| <pre>public void outputCreateDDLToWriter(<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> createWriter)</pre> |
| </li> |
| </ul> |
| <a name="outputDropDDLToWriter-java.io.Writer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>outputDropDDLToWriter</h4> |
| <pre>public void outputDropDDLToWriter(<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> dropWriter)</pre> |
| </li> |
| </ul> |
| <a name="replaceObject-org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>replaceObject</h4> |
| <pre>public void replaceObject(<a href="../../../../../org/eclipse/persistence/tools/schemaframework/DatabaseObjectDefinition.html" title="class in org.eclipse.persistence.tools.schemaframework">DatabaseObjectDefinition</a> databaseDefinition) |
| throws <a href="../../../../../org/eclipse/persistence/exceptions/EclipseLinkException.html" title="class in org.eclipse.persistence.exceptions">EclipseLinkException</a></pre> |
| <div class="block">Use the definition object to drop and recreate the schema entity on the database. |
| This is used for dropping tables, views, procedures ... etc ... |
| This handles and ignore any database error while dropping in case the object did not previously exist.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/eclipse/persistence/exceptions/EclipseLinkException.html" title="class in org.eclipse.persistence.exceptions">EclipseLinkException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDefaultTableCreator-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDefaultTableCreator</h4> |
| <pre>protected <a href="../../../../../org/eclipse/persistence/tools/schemaframework/TableCreator.html" title="class in org.eclipse.persistence.tools.schemaframework">TableCreator</a> getDefaultTableCreator(boolean generateFKConstraints)</pre> |
| <div class="block">Construct the default TableCreator. |
| If the default TableCreator is already created, just returns it.</div> |
| </li> |
| </ul> |
| <a name="createDefaultTables-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createDefaultTables</h4> |
| <pre>public void createDefaultTables(boolean generateFKConstraints)</pre> |
| <div class="block">Create the default table schema for the project this session associated with.</div> |
| </li> |
| </ul> |
| <a name="dropDatabaseSchemas--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>dropDatabaseSchemas</h4> |
| <pre>public void dropDatabaseSchemas()</pre> |
| <div class="block">INTERNAL: |
| Iterate over the schemas that need to be dropped.</div> |
| </li> |
| </ul> |
| <a name="dropDefaultTables--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>dropDefaultTables</h4> |
| <pre>public void dropDefaultTables()</pre> |
| <div class="block">Create the default table schema for the project this session associated with.</div> |
| </li> |
| </ul> |
| <a name="replaceDefaultTables--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>replaceDefaultTables</h4> |
| <pre>public void replaceDefaultTables() |
| throws <a href="../../../../../org/eclipse/persistence/exceptions/EclipseLinkException.html" title="class in org.eclipse.persistence.exceptions">EclipseLinkException</a></pre> |
| <div class="block">Drop and recreate the default table schema for the project this session associated with.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/eclipse/persistence/exceptions/EclipseLinkException.html" title="class in org.eclipse.persistence.exceptions">EclipseLinkException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="replaceDefaultTables-boolean-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>replaceDefaultTables</h4> |
| <pre>public void replaceDefaultTables(boolean createSequenceTables, |
| boolean generateFKConstraints) |
| throws <a href="../../../../../org/eclipse/persistence/exceptions/EclipseLinkException.html" title="class in org.eclipse.persistence.exceptions">EclipseLinkException</a></pre> |
| <div class="block">Drop and recreate the default table schema for the project this session associated with.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/eclipse/persistence/exceptions/EclipseLinkException.html" title="class in org.eclipse.persistence.exceptions">EclipseLinkException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="replaceDefaultTables-boolean-boolean-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>replaceDefaultTables</h4> |
| <pre>public void replaceDefaultTables(boolean createSequenceTables, |
| boolean createSequences, |
| boolean generateFKConstraints) |
| throws <a href="../../../../../org/eclipse/persistence/exceptions/EclipseLinkException.html" title="class in org.eclipse.persistence.exceptions">EclipseLinkException</a></pre> |
| <div class="block">Drop and recreate the default table schema for the project this session associated with.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/eclipse/persistence/exceptions/EclipseLinkException.html" title="class in org.eclipse.persistence.exceptions">EclipseLinkException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setSession-org.eclipse.persistence.internal.sessions.DatabaseSessionImpl-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSession</h4> |
| <pre>public void setSession(org.eclipse.persistence.internal.sessions.DatabaseSessionImpl session)</pre> |
| </li> |
| </ul> |
| <a name="shouldCreateDatabaseSchema-org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition-java.util.Set-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>shouldCreateDatabaseSchema</h4> |
| <pre>protected boolean shouldCreateDatabaseSchema(<a href="../../../../../org/eclipse/persistence/tools/schemaframework/DatabaseObjectDefinition.html" title="class in org.eclipse.persistence.tools.schemaframework">DatabaseObjectDefinition</a> databaseObjectDefinition, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</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">String</a>> createdDatabaseSchemas)</pre> |
| <div class="block">INTERNAL: |
| Returns true if a database schema should be created during ddl generation |
| for the given databaseObjectDefinition.</div> |
| </li> |
| </ul> |
| <a name="shouldWriteToDatabase--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>shouldWriteToDatabase</h4> |
| <pre>public boolean shouldWriteToDatabase()</pre> |
| <div class="block">PUBLIC: |
| Return true if this SchemaManager should write to the database directly</div> |
| </li> |
| </ul> |
| <a name="alterSequence-org.eclipse.persistence.tools.schemaframework.SequenceDefinition-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>alterSequence</h4> |
| <pre>public void alterSequence(<a href="../../../../../org/eclipse/persistence/tools/schemaframework/SequenceDefinition.html" title="class in org.eclipse.persistence.tools.schemaframework">SequenceDefinition</a> sequenceDefinition) |
| throws <a href="../../../../../org/eclipse/persistence/exceptions/EclipseLinkException.html" title="class in org.eclipse.persistence.exceptions">EclipseLinkException</a></pre> |
| <div class="block">Use the definition to alter sequence.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/eclipse/persistence/exceptions/EclipseLinkException.html" title="class in org.eclipse.persistence.exceptions">EclipseLinkException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="extendDefaultTables-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>extendDefaultTables</h4> |
| <pre>public void extendDefaultTables(boolean generateFKConstraints) |
| throws <a href="../../../../../org/eclipse/persistence/exceptions/EclipseLinkException.html" title="class in org.eclipse.persistence.exceptions">EclipseLinkException</a></pre> |
| <div class="block">Create or extend the default table schema for the project this session associated with.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/eclipse/persistence/exceptions/EclipseLinkException.html" title="class in org.eclipse.persistence.exceptions">EclipseLinkException</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="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">EclipseLink 3.0.2, API Reference</div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/eclipse/persistence/tools/schemaframework/PopulationManager.html" title="class in org.eclipse.persistence.tools.schemaframework"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/eclipse/persistence/tools/schemaframework/SequenceDefinition.html" title="class in org.eclipse.persistence.tools.schemaframework"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/eclipse/persistence/tools/schemaframework/SchemaManager.html" target="_top">Frames</a></li> |
| <li><a href="SchemaManager.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>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 name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2007–2021 <a href="http://www.eclipse.org/eclipselink">Eclipse.org - EclipseLink Project</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
