Google Git
Sign in
apache / cayenne-website / 626d8c1d90628349118d991467d8b423be9e228e / . / src / main / site / static / docs / 4.2 / api / org / apache / cayenne / dba / openbase / OpenBasePkGenerator.html
blob: eab666fceaed2df669cf43d7443e2bf53e39bec2 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.10) on Mon Dec 05 10:27:04 MSK 2022 -->
<title>OpenBasePkGenerator (cayenne-doc: Cayenne Documentation 4.2.RC2 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-12-05">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="OpenBasePkGenerator (cayenne-doc: Cayenne Documentation 4.2.RC2 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":42,"i1":42,"i2":42,"i3":42,"i4":42,"i5":42,"i6":42,"i7":42,"i8":42,"i9":42,"i10":42,"i11":42,"i12":42};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../../";
var useModuleDirectories = false;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/OpenBasePkGenerator.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><a href="http://cayenne.apache.org" target="top">Apache Cayenne</a></div>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.cayenne.dba.openbase</a></div>
<h2 title="Class OpenBasePkGenerator" class="title">Class OpenBasePkGenerator</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../JdbcPkGenerator.html" title="class in org.apache.cayenne.dba">org.apache.cayenne.dba.JdbcPkGenerator</a></li>
<li>
<ul class="inheritance">
<li>org.apache.cayenne.dba.openbase.OpenBasePkGenerator</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="../PkGenerator.html" title="interface in org.apache.cayenne.dba">PkGenerator</a></code></dd>
</dl>
<hr>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a>
public class <span class="typeNameLabel">OpenBasePkGenerator</span>
extends <a href="../JdbcPkGenerator.html" title="class in org.apache.cayenne.dba">JdbcPkGenerator</a></pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">since 4.2</div>
</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.1</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a id="fields.inherited.from.class.org.apache.cayenne.dba.JdbcPkGenerator">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.cayenne.dba.<a href="../JdbcPkGenerator.html" title="class in org.apache.cayenne.dba">JdbcPkGenerator</a></h3>
<code><a href="../JdbcPkGenerator.html#adapter">adapter</a>, <a href="../JdbcPkGenerator.html#DEFAULT_PK_CACHE_SIZE">DEFAULT_PK_CACHE_SIZE</a>, <a href="../JdbcPkGenerator.html#pkCache">pkCache</a>, <a href="../JdbcPkGenerator.html#pkCacheSize">pkCacheSize</a>, <a href="../JdbcPkGenerator.html#pkStartValue">pkStartValue</a></code></li>
</ul>
</li>
</ul>
</section>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier</th>
<th class="colSecond" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>&nbsp;</code></td>
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">OpenBasePkGenerator</a></span>()</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
<div class="block">Used by DI</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected </code></td>
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.cayenne.dba.JdbcAdapter)">OpenBasePkGenerator</a></span>&#8203;(<a href="../JdbcAdapter.html" title="class in org.apache.cayenne.dba">JdbcAdapter</a>&nbsp;adapter)</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>protected boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#canCreatePK(org.apache.cayenne.map.DbEntity)">canCreatePK</a></span>&#8203;(<a href="../../map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a>&nbsp;entity)</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createAutoPk(org.apache.cayenne.access.DataNode,java.util.List)">createAutoPk</a></span>&#8203;(<a href="../../access/DataNode.html" title="class in org.apache.cayenne.access">DataNode</a>&nbsp;node,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="../../map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a>&gt;&nbsp;dbEntities)</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
<div class="block">Generates necessary database objects to provide automatic primary key support.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createAutoPkStatements(java.util.List)">createAutoPkStatements</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="../../map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a>&gt;&nbsp;dbEntities)</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
<div class="block">Returns a list of SQL strings needed to generates database objects to provide
automatic primary support for the list of entities.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createPKString(org.apache.cayenne.map.DbEntity)">createPKString</a></span>&#8203;(<a href="../../map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a>&nbsp;entity)</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
<div class="block">Returns a String to create PK support for an entity.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createUniquePKIndexString(org.apache.cayenne.map.DbEntity)">createUniquePKIndexString</a></span>&#8203;(<a href="../../map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a>&nbsp;entity)</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
<div class="block">Returns a String to create a unique index on table primary key columns
per OpenBase recommendations.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dropAutoPk(org.apache.cayenne.access.DataNode,java.util.List)">dropAutoPk</a></span>&#8203;(<a href="../../access/DataNode.html" title="class in org.apache.cayenne.access">DataNode</a>&nbsp;node,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="../../map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a>&gt;&nbsp;dbEntities)</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
<div class="block">Drops table named "AUTO_PK_SUPPORT" if it exists in the database.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dropAutoPkStatements(java.util.List)">dropAutoPkStatements</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="../../map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a>&gt;&nbsp;dbEntities)</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
<div class="block">Returns an empty list, since OpenBase doesn't support this operation.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><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" class="externalLink">Object</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#generatePk(org.apache.cayenne.access.DataNode,org.apache.cayenne.map.DbAttribute)">generatePk</a></span>&#8203;(<a href="../../access/DataNode.html" title="class in org.apache.cayenne.access">DataNode</a>&nbsp;node,
<a href="../../map/DbAttribute.html" title="class in org.apache.cayenne.map">DbAttribute</a>&nbsp;pk)</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
<div class="block">Returns a non-repeating primary key for a given PK attribute.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPkCacheSize()">getPkCacheSize</a></span>()</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
<div class="block">Returns zero, since PK caching is not feasible with OpenBase PK
generation mechanism.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>protected long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#longPkFromDatabase(org.apache.cayenne.access.DataNode,org.apache.cayenne.map.DbEntity)">longPkFromDatabase</a></span>&#8203;(<a href="../../access/DataNode.html" title="class in org.apache.cayenne.access">DataNode</a>&nbsp;node,
<a href="../../map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a>&nbsp;entity)</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
<div class="block">Generates new (unique and non-repeating) primary key for specified
DbEntity.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#newIDString(org.apache.cayenne.map.DbEntity)">newIDString</a></span>&#8203;(<a href="../../map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a>&nbsp;ent)</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
<div class="block">Returns SQL string that can generate new (unique and non-repeating)
primary key for specified DbEntity.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#reset()">reset</a></span>()</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
<div class="block">Resets any cached primary keys forcing generator to go to the database next time id
generation is requested.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setPkCacheSize(int)">setPkCacheSize</a></span>&#8203;(int&nbsp;pkCacheSize)</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
<div class="block">Sets the size of the entity primary key cache.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.cayenne.dba.JdbcPkGenerator">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.cayenne.dba.<a href="../JdbcPkGenerator.html" title="class in org.apache.cayenne.dba">JdbcPkGenerator</a></h3>
<code><a href="../JdbcPkGenerator.html#autoPkTableExists(org.apache.cayenne.access.DataNode)">autoPkTableExists</a>, <a href="../JdbcPkGenerator.html#dropAutoPkString()">dropAutoPkString</a>, <a href="../JdbcPkGenerator.html#getAdapter()">getAdapter</a>, <a href="../JdbcPkGenerator.html#pkCreateString(java.lang.String)">pkCreateString</a>, <a href="../JdbcPkGenerator.html#pkDeleteString(java.util.List)">pkDeleteString</a>, <a href="../JdbcPkGenerator.html#pkSelectString(java.lang.String)">pkSelectString</a>, <a href="../JdbcPkGenerator.html#pkTableCreateString()">pkTableCreateString</a>, <a href="../JdbcPkGenerator.html#pkUpdateString(java.lang.String)">pkUpdateString</a>, <a href="../JdbcPkGenerator.html#runUpdate(org.apache.cayenne.access.DataNode,java.lang.String)">runUpdate</a>, <a href="../JdbcPkGenerator.html#setAdapter(org.apache.cayenne.dba.DbAdapter)">setAdapter</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>OpenBasePkGenerator</h4>
<pre>public&nbsp;OpenBasePkGenerator()</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div>
<div class="block">Used by DI</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>4.1</dd>
</dl>
</li>
</ul>
<a id="&lt;init&gt;(org.apache.cayenne.dba.JdbcAdapter)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>OpenBasePkGenerator</h4>
<pre>protected&nbsp;OpenBasePkGenerator&#8203;(<a href="../JdbcAdapter.html" title="class in org.apache.cayenne.dba">JdbcAdapter</a>&nbsp;adapter)</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="generatePk(org.apache.cayenne.access.DataNode,org.apache.cayenne.map.DbAttribute)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>generatePk</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;generatePk&#8203;(<a href="../../access/DataNode.html" title="class in org.apache.cayenne.access">DataNode</a>&nbsp;node,
<a href="../../map/DbAttribute.html" title="class in org.apache.cayenne.map">DbAttribute</a>&nbsp;pk)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div>
<div class="block">Returns a non-repeating primary key for a given PK attribute. Since
OpenBase-specific mechanism is used, key caching is disabled. Instead a
database operation is performed on every call.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../PkGenerator.html#generatePk(org.apache.cayenne.access.DataNode,org.apache.cayenne.map.DbAttribute)">generatePk</a></code>&nbsp;in interface&nbsp;<code><a href="../PkGenerator.html" title="interface in org.apache.cayenne.dba">PkGenerator</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../JdbcPkGenerator.html#generatePk(org.apache.cayenne.access.DataNode,org.apache.cayenne.map.DbAttribute)">generatePk</a></code>&nbsp;in class&nbsp;<code><a href="../JdbcPkGenerator.html" title="class in org.apache.cayenne.dba">JdbcPkGenerator</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.0</dd>
</dl>
</li>
</ul>
<a id="longPkFromDatabase(org.apache.cayenne.access.DataNode,org.apache.cayenne.map.DbEntity)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>longPkFromDatabase</h4>
<pre class="methodSignature">protected&nbsp;long&nbsp;longPkFromDatabase&#8203;(<a href="../../access/DataNode.html" title="class in org.apache.cayenne.access">DataNode</a>&nbsp;node,
<a href="../../map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a>&nbsp;entity)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div>
<div class="block">Generates new (unique and non-repeating) primary key for specified
DbEntity. Executed SQL looks like this:
<pre>
NEWID FOR Table Column
</pre>
<p>
COLUMN must be marked as UNIQUE in order for this to work properly.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../JdbcPkGenerator.html#longPkFromDatabase(org.apache.cayenne.access.DataNode,org.apache.cayenne.map.DbEntity)">longPkFromDatabase</a></code>&nbsp;in class&nbsp;<code><a href="../JdbcPkGenerator.html" title="class in org.apache.cayenne.dba">JdbcPkGenerator</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.0</dd>
</dl>
</li>
</ul>
<a id="newIDString(org.apache.cayenne.map.DbEntity)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newIDString</h4>
<pre class="methodSignature">protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;newIDString&#8203;(<a href="../../map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a>&nbsp;ent)</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div>
<div class="block">Returns SQL string that can generate new (unique and non-repeating)
primary key for specified DbEntity. No actual database operations are
performed.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.2</dd>
</dl>
</li>
</ul>
<a id="createAutoPk(org.apache.cayenne.access.DataNode,java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createAutoPk</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;createAutoPk&#8203;(<a href="../../access/DataNode.html" title="class in org.apache.cayenne.access">DataNode</a>&nbsp;node,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="../../map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a>&gt;&nbsp;dbEntities)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../PkGenerator.html#createAutoPk(org.apache.cayenne.access.DataNode,java.util.List)">PkGenerator</a></code></span></div>
<div class="block">Generates necessary database objects to provide automatic primary key support.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../PkGenerator.html#createAutoPk(org.apache.cayenne.access.DataNode,java.util.List)">createAutoPk</a></code>&nbsp;in interface&nbsp;<code><a href="../PkGenerator.html" title="interface in org.apache.cayenne.dba">PkGenerator</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../JdbcPkGenerator.html#createAutoPk(org.apache.cayenne.access.DataNode,java.util.List)">createAutoPk</a></code>&nbsp;in class&nbsp;<code><a href="../JdbcPkGenerator.html" title="class in org.apache.cayenne.dba">JdbcPkGenerator</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>node</code> - node that provides access to a DataSource.</dd>
<dd><code>dbEntities</code> - a list of entities that require primary key auto-generation
support</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd>
</dl>
</li>
</ul>
<a id="createAutoPkStatements(java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createAutoPkStatements</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&gt;&nbsp;createAutoPkStatements&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="../../map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a>&gt;&nbsp;dbEntities)</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../PkGenerator.html#createAutoPkStatements(java.util.List)">PkGenerator</a></code></span></div>
<div class="block">Returns a list of SQL strings needed to generates database objects to provide
automatic primary support for the list of entities. No actual database operations
are performed.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../PkGenerator.html#createAutoPkStatements(java.util.List)">createAutoPkStatements</a></code>&nbsp;in interface&nbsp;<code><a href="../PkGenerator.html" title="interface in org.apache.cayenne.dba">PkGenerator</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../JdbcPkGenerator.html#createAutoPkStatements(java.util.List)">createAutoPkStatements</a></code>&nbsp;in class&nbsp;<code><a href="../JdbcPkGenerator.html" title="class in org.apache.cayenne.dba">JdbcPkGenerator</a></code></dd>
</dl>
</li>
</ul>
<a id="canCreatePK(org.apache.cayenne.map.DbEntity)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>canCreatePK</h4>
<pre class="methodSignature">protected&nbsp;boolean&nbsp;canCreatePK&#8203;(<a href="../../map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a>&nbsp;entity)</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div>
</li>
</ul>
<a id="dropAutoPk(org.apache.cayenne.access.DataNode,java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dropAutoPk</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;dropAutoPk&#8203;(<a href="../../access/DataNode.html" title="class in org.apache.cayenne.access">DataNode</a>&nbsp;node,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="../../map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a>&gt;&nbsp;dbEntities)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../JdbcPkGenerator.html#dropAutoPk(org.apache.cayenne.access.DataNode,java.util.List)">JdbcPkGenerator</a></code></span></div>
<div class="block">Drops table named "AUTO_PK_SUPPORT" if it exists in the database.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../PkGenerator.html#dropAutoPk(org.apache.cayenne.access.DataNode,java.util.List)">dropAutoPk</a></code>&nbsp;in interface&nbsp;<code><a href="../PkGenerator.html" title="interface in org.apache.cayenne.dba">PkGenerator</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../JdbcPkGenerator.html#dropAutoPk(org.apache.cayenne.access.DataNode,java.util.List)">dropAutoPk</a></code>&nbsp;in class&nbsp;<code><a href="../JdbcPkGenerator.html" title="class in org.apache.cayenne.dba">JdbcPkGenerator</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>node</code> - node that provides access to a DataSource.</dd>
<dd><code>dbEntities</code> - a list of entities whose primary key auto-generation support
should be dropped.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd>
</dl>
</li>
</ul>
<a id="dropAutoPkStatements(java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dropAutoPkStatements</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&gt;&nbsp;dropAutoPkStatements&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="../../map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a>&gt;&nbsp;dbEntities)</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div>
<div class="block">Returns an empty list, since OpenBase doesn't support this operation.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../PkGenerator.html#dropAutoPkStatements(java.util.List)">dropAutoPkStatements</a></code>&nbsp;in interface&nbsp;<code><a href="../PkGenerator.html" title="interface in org.apache.cayenne.dba">PkGenerator</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../JdbcPkGenerator.html#dropAutoPkStatements(java.util.List)">dropAutoPkStatements</a></code>&nbsp;in class&nbsp;<code><a href="../JdbcPkGenerator.html" title="class in org.apache.cayenne.dba">JdbcPkGenerator</a></code></dd>
</dl>
</li>
</ul>
<a id="createPKString(org.apache.cayenne.map.DbEntity)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createPKString</h4>
<pre class="methodSignature">protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;createPKString&#8203;(<a href="../../map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a>&nbsp;entity)</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div>
<div class="block">Returns a String to create PK support for an entity.</div>
</li>
</ul>
<a id="createUniquePKIndexString(org.apache.cayenne.map.DbEntity)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createUniquePKIndexString</h4>
<pre class="methodSignature">protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;createUniquePKIndexString&#8203;(<a href="../../map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a>&nbsp;entity)</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div>
<div class="block">Returns a String to create a unique index on table primary key columns
per OpenBase recommendations.</div>
</li>
</ul>
<a id="reset()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>reset</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;reset()</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../PkGenerator.html#reset()">PkGenerator</a></code></span></div>
<div class="block">Resets any cached primary keys forcing generator to go to the database next time id
generation is requested. May not be applicable for all generator implementations.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../PkGenerator.html#reset()">reset</a></code>&nbsp;in interface&nbsp;<code><a href="../PkGenerator.html" title="interface in org.apache.cayenne.dba">PkGenerator</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../JdbcPkGenerator.html#reset()">reset</a></code>&nbsp;in class&nbsp;<code><a href="../JdbcPkGenerator.html" title="class in org.apache.cayenne.dba">JdbcPkGenerator</a></code></dd>
</dl>
</li>
</ul>
<a id="getPkCacheSize()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPkCacheSize</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getPkCacheSize()</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div>
<div class="block">Returns zero, since PK caching is not feasible with OpenBase PK
generation mechanism.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../JdbcPkGenerator.html#getPkCacheSize()">getPkCacheSize</a></code>&nbsp;in class&nbsp;<code><a href="../JdbcPkGenerator.html" title="class in org.apache.cayenne.dba">JdbcPkGenerator</a></code></dd>
</dl>
</li>
</ul>
<a id="setPkCacheSize(int)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setPkCacheSize</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setPkCacheSize&#8203;(int&nbsp;pkCacheSize)</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../JdbcPkGenerator.html#setPkCacheSize(int)">JdbcPkGenerator</a></code></span></div>
<div class="block">Sets the size of the entity primary key cache. If
<code>pkCacheSize</code> parameter is less than 1, cache size is set to
"one".
<p>
<i>Note that our tests show that setting primary key cache value to
anything much bigger than 20 does not give any significant performance
increase. Therefore it does not make sense to use bigger values, since
this may potentially create big gaps in the database primary key
sequences in cases like application crashes or restarts. </i>
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../JdbcPkGenerator.html#setPkCacheSize(int)">setPkCacheSize</a></code>&nbsp;in class&nbsp;<code><a href="../JdbcPkGenerator.html" title="class in org.apache.cayenne.dba">JdbcPkGenerator</a></code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/OpenBasePkGenerator.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><a href="http://cayenne.apache.org" target="top">Apache Cayenne</a></div>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2001&#x2013;2022 <a href="https://cayenne.apache.org/">Apache Cayenne</a>. All rights reserved.</small></p>
</footer>
</body>
</html>