blob: 78ae01853794e203058adb731d6a01cc13ab7d8c [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 information</title>
<meta name="generator" content="Oracle DARB XHTML Converter (Mode = ohj/ohw) - Version 5.1.1" />
<meta name="date" content="2010-05-19T8:12:47Z" />
<meta name="robots" content="noarchive" />
<meta name="doctitle" content="Primary Key Generation information" />
<meta name="relnum" content="Release 2.3" />
<meta name="copyright" content="Copyright (c) 2000, 2008 oracle . All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License v1.0 which accompanies this distribution, and is available at http://www.eclipse.org/legal/epl-v10.html. Contributors: Oracle - initial API and implementation" />
<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" />
<!-- contents -->
</head>
<body>
<p><a id="CACFCCAB" name="CACFCCAB"></a></p>
<div class="sect3"><!-- infolevel="all" infotype="General" -->
<h1>Primary Key Generation information</h1>
<p>This table lists the fields available in the <span class="gui-object-title">Primary Key Generation</span> area in JPA Details view for <a href="tasks013.htm#BABGCBHG">ID mapping</a> types.</p>
<div class="inftblruleinformal">
<table class="RuleInformal" title="This table describes the options on the Join Columns tab." summary="This table describes the options on the Join Columns tab." dir="ltr" border="1" width="100%" frame="border" rules="all" cellpadding="3" cellspacing="0">
<col width="26%" />
<col width="*" />
<col width="34%" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t19">Property</th>
<th align="left" valign="bottom" id="r1c2-t19">Description</th>
<th align="left" valign="bottom" id="r1c3-t19">Default</th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t19" headers="r1c1-t19"><a id="CACBAJBC" name="CACBAJBC"></a>Primary Key Generation</td>
<td align="left" headers="r2c1-t19 r1c2-t19"><a id="sthref251" name="sthref251"></a><a id="sthref252" name="sthref252"></a>These fields define how the primary key is generated. These fields correspond to the <code>@GeneratedValue</code> annotation.</td>
<td align="left" headers="r2c1-t19 r1c3-t19">Generated Value</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r3c1-t19" headers="r1c1-t19"><a id="CACJEEEC" name="CACJEEEC"></a>&nbsp;&nbsp;&nbsp;Strategy</td>
<td align="left" headers="r3c1-t19 r1c2-t19">
<ul>
<li>Auto</li>
<li>
<p>Identity &ndash; Values are assigned by the database's <span class="bold">Identity</span> column.</p>
</li>
<li>
<p>Sequence &ndash; Values are assigned by a sequence table (see <a href="#CACFFHEH">Sequence&nbsp;Generator</a>).</p>
</li>
<li>
<p>Table &ndash; Values are assigned by a database table (see <a href="#CACGFEAH">Table Generator</a>).</p>
</li>
</ul>
</td>
<td align="left" headers="r3c1-t19 r1c3-t19">Auto</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r4c1-t19" headers="r1c1-t19"><a id="BABEEAHJ" name="BABEEAHJ"></a>&nbsp;&nbsp;Generator Name</td>
<td align="left" headers="r4c1-t19 r1c2-t19">Unique name of the generated value.</td>
<td align="left" headers="r4c1-t19 r1c3-t19"><br /></td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r5c1-t19" headers="r1c1-t19"><a id="CACGFEAH" name="CACGFEAH"></a>Table Generator</td>
<td align="left" headers="r5c1-t19 r1c2-t19">These fields define the database table used for generating the primary key and correspond to the <code>@TableGenerator</code> annotation.
<p>These fields apply only when <span class="bold">Strategy</span>&nbsp;=&nbsp;<span class="bold">Table</span>.</p>
</td>
<td align="left" headers="r5c1-t19 r1c3-t19"><br /></td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r6c1-t19" headers="r1c1-t19">&nbsp;&nbsp;Name</td>
<td align="left" headers="r6c1-t19 r1c2-t19">Unique name of the generator.</td>
<td align="left" headers="r6c1-t19 r1c3-t19"><br /></td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r7c1-t19" headers="r1c1-t19">&nbsp;&nbsp;Table</td>
<td align="left" headers="r7c1-t19 r1c2-t19">Database table that stores the generated ID values.</td>
<td align="left" headers="r7c1-t19 r1c3-t19"><br /></td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r8c1-t19" headers="r1c1-t19">&nbsp;&nbsp;Primary Key Column</td>
<td align="left" headers="r8c1-t19 r1c2-t19">The column in the table generator's <span class="bold">Table</span> that contains the primary key.</td>
<td align="left" headers="r8c1-t19 r1c3-t19"><br /></td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r9c1-t19" headers="r1c1-t19">&nbsp;&nbsp;Value Column</td>
<td align="left" headers="r9c1-t19 r1c2-t19">The column that stores the generated ID values.</td>
<td align="left" headers="r9c1-t19 r1c3-t19"><br /></td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r10c1-t19" headers="r1c1-t19">&nbsp;&nbsp;Primary Key Column Value</td>
<td align="left" headers="r10c1-t19 r1c2-t19">The value for the <span class="bold">Primary Key Column</span> in the generator table.</td>
<td align="left" headers="r10c1-t19 r1c3-t19"><br /></td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r11c1-t19" headers="r1c1-t19"><a id="CACFFHEH" name="CACFFHEH"></a>Sequence&nbsp;Generator</td>
<td align="left" headers="r11c1-t19 r1c2-t19"><a id="sthref253" name="sthref253"></a><a id="sthref254" name="sthref254"></a>These fields define the specific sequence used for generating the primary key and correspond to the <code>@SequenceGenerator</code> annotation.
<p>These fields apply only when <span class="bold">Strategy</span> = <span class="bold">Sequence</span>.</p>
</td>
<td align="left" headers="r11c1-t19 r1c3-t19"><br /></td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r12c1-t19" headers="r1c1-t19">&nbsp;&nbsp;Name</td>
<td align="left" headers="r12c1-t19 r1c2-t19">Name of the sequence table to use for defining primary key values.</td>
<td align="left" headers="r12c1-t19 r1c3-t19"><br /></td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r13c1-t19" headers="r1c1-t19">&nbsp;&nbsp;Sequence</td>
<td align="left" headers="r13c1-t19 r1c2-t19">Unique name of the sequence.</td>
<td align="left" headers="r13c1-t19 r1c3-t19"><br /></td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="inftblruleinformal" -->
<p>&nbsp;</p>
<img src="img/ngrelt.png" alt="Related task" title="Related task" /><br />
<br />
<a href="tasks013.htm#BABGCBHG">ID mapping</a>
<p>&nbsp;</p>
<img src="img/ngrelr.png" alt="Related task" title="Related task" /><br />
<br />
<a href="ref_persistence_map_view.htm#BABIFBAF">JPA Details view (for attributes)</a></div>
<!-- class="sect3" -->
<!-- class="sect2" -->
<!-- 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;2006, 2010,&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>