blob: ed718b09a92a07c88c2234032872f9a939dc37c3 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<meta http-equiv="Content-Script-Type" content="text/javascript" />
<title>Primary Key Generation</title>
<meta name="copyright" content="Copyright (c) 2000, 2009 oracle . All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which accompanies this distribution, and is available at http://www.eclipse.org/legal/epl-2.0/. Contributors: Oracle - initial API and implementation" />
<meta name="generator" content="Oracle DARB XHTML Converter (Mode = ohj/ohw) - Version 1.0.11" />
<meta name="date" content="2013-04-05T12:21:40Z" />
<meta name="robots" content="noarchive" />
<meta name="doctitle" content="Primary Key Generation" />
<meta name="relnum" content="Release 3.3" />
<meta name="partnum" content="Release 3.3" />
<link rel="copyright" href="dcommon/html/cpyr.htm" title="Copyright" type="text/html" />
<link rel="stylesheet" href="dcommon/css/blafdoc.css" title="Oracle BLAFDoc" type="text/css" />
</head>
<body>
<p><a id="CACCJJDC" name="CACCJJDC"></a></p>
<div class="sect3"><!-- infolevel="all" infotype="General" -->
<h1><a id="sthref502" name="sthref502"></a><a id="sthref503" name="sthref503"></a>Primary Key Generation</h1>
<p>Use the Primary Key Generation area in the <span class="gui-object-title">JPA Details</span> view to specify how to generate a primary key for a given entity.</p>
<div class="inftblhruleinformalwide">
<table class="HRuleInformalWide" title="JPA Details view, Primary key page" summary="JPA Details view, Primary key page" dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="16%" />
<col width="*" />
<col width="17%" />
<col width="25%" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t31">Property</th>
<th align="left" valign="bottom" id="r1c2-t31">Description</th>
<th align="left" valign="bottom" id="r1c3-t31">Default</th>
<th align="left" valign="bottom" id="r1c4-t31">Available for Entity&nbsp;Type</th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t31" headers="r1c1-t31">
<p><span class="bold">Table Generator</span></p>
</td>
<td align="left" headers="r2c1-t31 r1c2-t31">
<p>These fields define the database table used for generating the primary key and correspond to the <code>@TableGenerator</code> annotation.</p>
</td>
<td align="left" headers="r2c1-t31 r1c3-t31"><br /></td>
<td align="left" headers="r2c1-t31 r1c4-t31">
<p><a href="tasks004.htm#BABGBIEE">Entity</a></p>
<br /></td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r3c1-t31" headers="r1c1-t31">
<p>Name</p>
</td>
<td align="left" headers="r3c1-t31 r1c2-t31">
<p>Unique name of the generator.</p>
</td>
<td align="left" headers="r3c1-t31 r1c3-t31"><br /></td>
<td align="left" headers="r3c1-t31 r1c4-t31">
<p><a href="tasks004.htm#BABGBIEE">Entity</a></p>
<br /></td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r4c1-t31" headers="r1c1-t31">
<p>Table</p>
</td>
<td align="left" headers="r4c1-t31 r1c2-t31">
<p>Database table that stores the generated ID values.</p>
</td>
<td align="left" headers="r4c1-t31 r1c3-t31"><br /></td>
<td align="left" headers="r4c1-t31 r1c4-t31">
<p><a href="tasks004.htm#BABGBIEE">Entity</a></p>
<br /></td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r5c1-t31" headers="r1c1-t31">
<p>Schema</p>
</td>
<td align="left" headers="r5c1-t31 r1c2-t31">
<p>Database schema of the <span class="bold">Table</span>.</p>
</td>
<td align="left" headers="r5c1-t31 r1c3-t31"><br /></td>
<td align="left" headers="r5c1-t31 r1c4-t31">
<p><a href="tasks004.htm#BABGBIEE">Entity</a></p>
<br /></td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r6c1-t31" headers="r1c1-t31">
<p>Catalog</p>
</td>
<td align="left" headers="r6c1-t31 r1c2-t31">
<p>Database catalog of the <span class="bold">Table</span>.</p>
</td>
<td align="left" headers="r6c1-t31 r1c3-t31"><br /></td>
<td align="left" headers="r6c1-t31 r1c4-t31">
<p><a href="tasks004.htm#BABGBIEE">Entity</a></p>
<br /></td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r7c1-t31" headers="r1c1-t31">
<p>Primary key column</p>
</td>
<td align="left" headers="r7c1-t31 r1c2-t31">
<p>The column in the table generator's <span class="bold">Table</span> that contains the primary key.</p>
</td>
<td align="left" headers="r7c1-t31 r1c3-t31"><br /></td>
<td align="left" headers="r7c1-t31 r1c4-t31">
<p><a href="tasks004.htm#BABGBIEE">Entity</a></p>
<br /></td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r8c1-t31" headers="r1c1-t31">
<p>Value column</p>
</td>
<td align="left" headers="r8c1-t31 r1c2-t31">
<p>The column that stores the generated ID values.</p>
</td>
<td align="left" headers="r8c1-t31 r1c3-t31"><br /></td>
<td align="left" headers="r8c1-t31 r1c4-t31">
<p><a href="tasks004.htm#BABGBIEE">Entity</a></p>
<br /></td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r9c1-t31" headers="r1c1-t31">
<p>Allocation size</p>
</td>
<td align="left" headers="r9c1-t31 r1c2-t31">
<p>The value for the <span class="bold">Primary Key Column</span> in the generator table.</p>
</td>
<td align="left" headers="r9c1-t31 r1c3-t31">
<p>50</p>
</td>
<td align="left" headers="r9c1-t31 r1c4-t31">
<p><a href="tasks004.htm#BABGBIEE">Entity</a></p>
<br /></td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r10c1-t31" headers="r1c1-t31">
<p>Initial value</p>
</td>
<td align="left" headers="r10c1-t31 r1c2-t31">
<p>The starting value of the generated primary key.</p>
</td>
<td align="left" headers="r10c1-t31 r1c3-t31">
<p>0</p>
</td>
<td align="left" headers="r10c1-t31 r1c4-t31">
<p><a href="tasks004.htm#BABGBIEE">Entity</a></p>
<br /></td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r11c1-t31" headers="r1c1-t31">
<p><span class="bold">Sequence Generator</span></p>
</td>
<td align="left" headers="r11c1-t31 r1c2-t31">
<p><a id="sthref504" name="sthref504"></a><a id="sthref505" name="sthref505"></a>These fields define the specific sequence used for generating the primary key and correspond to the <code>@SequenceGenerator</code> annotation.</p>
<p>These fields apply only when <span class="bold">Strategy</span> = <span class="bold">Sequence</span>.</p>
</td>
<td align="left" headers="r11c1-t31 r1c3-t31"><br /></td>
<td align="left" headers="r11c1-t31 r1c4-t31">
<p><a href="tasks004.htm#BABGBIEE">Entity</a></p>
<br /></td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r12c1-t31" headers="r1c1-t31">
<p>Name</p>
</td>
<td align="left" headers="r12c1-t31 r1c2-t31">
<p>Name of the sequence table to use for defining primary key values.</p>
</td>
<td align="left" headers="r12c1-t31 r1c3-t31"><br /></td>
<td align="left" headers="r12c1-t31 r1c4-t31">
<p><a href="tasks004.htm#BABGBIEE">Entity</a></p>
<br /></td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r13c1-t31" headers="r1c1-t31">
<p>Sequence</p>
</td>
<td align="left" headers="r13c1-t31 r1c2-t31">
<p>Unique name of the sequence.</p>
</td>
<td align="left" headers="r13c1-t31 r1c3-t31"><br /></td>
<td align="left" headers="r13c1-t31 r1c4-t31">
<p><a href="tasks004.htm#BABGBIEE">Entity</a></p>
<br /></td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r14c1-t31" headers="r1c1-t31">
<p>Schema</p>
</td>
<td align="left" headers="r14c1-t31 r1c2-t31">
<p>Database schema of the <span class="bold">Sequence</span>.</p>
</td>
<td align="left" headers="r14c1-t31 r1c3-t31"><br /></td>
<td align="left" headers="r14c1-t31 r1c4-t31">
<p><a href="tasks004.htm#BABGBIEE">Entity</a></p>
<br /></td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r15c1-t31" headers="r1c1-t31">
<p>Catalog</p>
</td>
<td align="left" headers="r15c1-t31 r1c2-t31">
<p>Database catalog of the <span class="bold">Sequence</span>.</p>
</td>
<td align="left" headers="r15c1-t31 r1c3-t31"><br /></td>
<td align="left" headers="r15c1-t31 r1c4-t31">
<p><a href="tasks004.htm#BABGBIEE">Entity</a></p>
<br /></td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r16c1-t31" headers="r1c1-t31">
<p>Allocation size</p>
</td>
<td align="left" headers="r16c1-t31 r1c2-t31">
<p><a id="sthref506" name="sthref506"></a><a id="sthref507" name="sthref507"></a>These fields define the specific sequence used for generating the primary key and correspond to the <code>@SequenceGenerator</code> annotation.</p>
<p>These fields apply only when <span class="bold">Strategy</span> = <span class="bold">Sequence</span>.</p>
</td>
<td align="left" headers="r16c1-t31 r1c3-t31">
<p>50</p>
</td>
<td align="left" headers="r16c1-t31 r1c4-t31">
<p><a href="tasks004.htm#BABGBIEE">Entity</a></p>
<br /></td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r17c1-t31" headers="r1c1-t31">
<p>Initial value</p>
</td>
<td align="left" headers="r17c1-t31 r1c2-t31">
<p>The starting value of the generated primary key.</p>
</td>
<td align="left" headers="r17c1-t31 r1c3-t31">
<p>1</p>
</td>
<td align="left" headers="r17c1-t31 r1c4-t31">
<p><a href="tasks004.htm#BABGBIEE">Entity</a></p>
<br /></td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="inftblhruleinformalwide" -->
<a id="sthref508" name="sthref508"></a>
<p class="subhead2">Related reference</p>
<ul>
<li>
<p><a href="ref_persistence_prop_view.htm#BABFAEBB">JPA Details view (for entities)</a></p>
</li>
</ul>
</div>
<!-- class="sect3" -->
<!-- Start Footer -->
<div class="footer">
<table class="simple oac_no_warn" summary="" cellspacing="0" cellpadding="0" width="100%">
<col width="86%" />
<col width="*" />
<tr>
<td align="left"><span class="copyrightlogo">Copyright&nbsp;&copy;&nbsp;2011, 2013,&nbsp;Oracle&nbsp;and/or&nbsp;its&nbsp;affiliates.&nbsp;All&nbsp;rights&nbsp;reserved.</span><br />
<a href="dcommon/html/cpyr.htm"><span class="copyrightlogo">Legal Notices</span></a></td>
</tr>
</table>
</div>
<!-- class="footer" -->
</body>
</html>