blob: cdd83c749a686333faa2c2fa81aa75a9cd2f0abd [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>JPA Query Customization Extensions | EclipseLink 2.5.x Java Persistence API (JPA) Extensions Reference</title>
<meta name="generator" content="Oracle DARB XHTML Converter (Mode = document) - Version 1.0.17" />
<meta name="date" content="2013-10-03T12:33:25Z" />
<meta name="robots" content="noarchive" />
<meta name="doctitle" content="JPA Query Customization Extensions" />
<meta name="relnum" content="Release 2.5" />
<link rel="stylesheet" type="text/css" href="../../../dcommon/style.css" media="screen" />
<link rel="copyright" href="http://www.eclipse.org/org/documents/epl-v10.php" title="Copyright" type="text/html" />
<link rel="start" href="../../index.htm" title="Home" type="text/html" />
<link rel="contents" href="toc.htm" title="Contents" type="text/html" />
<link rel="prev" href="j_union.htm" title="Previous" type="text/html" />
<link rel="next" href="q_batch.htm" title="Next" type="text/html" />
<!-- START: Disqus --><script type="text/javascript"> var disqus_developer = 0; </script><!-- END: Disqus --><!-- START: Sharethis --><script type="text/javascript">var switchTo5x=true;</script><script type="text/javascript" src="http://w.sharethis.com/button/buttons.js"></script><script type="text/javascript" src="http://s.sharethis.com/loader.js"></script> <!-- END: Sharethis --></head>
<body bgcolor="#FFFFFF"><iframe id="docheader" frameborder="0" framemargin="0" scrolling="no" src="../../../dcommon/header.html"></iframe><script src="http://www.google.com/jsapi" type="text/javascript"></script><script type="text/javascript"> google.load('search', '1', {language : 'en'}); google.setOnLoadCallback(function() { var customSearchOptions = {}; var googleAnalyticsOptions = {}; googleAnalyticsOptions['queryParameter'] = 'q'; googleAnalyticsOptions['categoryParameter'] = ''; customSearchOptions['googleAnalyticsOptions'] = googleAnalyticsOptions; var customSearchControl = new google.search.CustomSearchControl( '016171230611334810008:4sqnhke2any', customSearchOptions); customSearchControl.setResultSetSize(google.search.Search.FILTERED_CSE_RESULTSET); var options = new google.search.DrawOptions(); options.setSearchFormRoot('cse-search-form'); customSearchControl.draw('cse', options); }, true);</script><link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" /><div id="cse" style="width:100%;"></div>
<div class="header"><a id="top" name="top"></a>
<table class="simple oac_no_warn" summary="" cellspacing="0" cellpadding="0" width="100%">
<tr>
<td align="left" valign="top"><div class="booktitle">Java Persistence API (JPA) Extensions Reference for EclipseLink,
<b>Release 2.5</b><br /></font></td>
<td valign="bottom" align="right" width="144">
<table class="simple oac_no_warn" summary="" cellspacing="0" cellpadding="0" width="100%">
<tr>
<td>&nbsp;</td>
<td align="center" valign="top"><a href="toc.htm"><img src="../../../dcommon/images/contents.png" alt="Go To Table Of Contents" border="0" height="16" width="16" /><br />
</td><td>&nbsp;</td><td align="center"><a href="../../../" target="_top" class="external text" title="Search" rel="nofollow"><img src="../../../dcommon/images/search.png" alt="Search" style="border:0;" /><br /><span class="mini"></span></a></td><td>&nbsp;</td><td align="center"><a href="../../eclipselink_jpa_extensions.pdf" title="PDF" target="_blank"><img src="../../../dcommon/images/pdf_icon.png" style="padding-right:5px;border:0" alt="PDF"></a></td><td align="center"><a href="#disqus_thread" title="Comments""><img src="../../../dcommon/images/comments.png" style="padding-right:5px;border:0" alt="Comments"><br /><span class="mini">Comments</span></a>
</tr>
</table>
</td>
</tr>
</table>
<hr />
<table class="navigation simple oac_no_warn" summary="" cellspacing="0" cellpadding="0" width="100" align="center">
<tr>
<td align="center"><a href="j_union.htm"><img src="../../../dcommon/images/larrow.png" alt="Previous" border="0" height="16" width="16" /></a></td>
<td align="center"><a href="q_batch.htm"><img src="../../../dcommon/images/rarrow.png" alt="Next" border="0" height="16" width="16" /></a></td>
<td>&nbsp;</td>
</tr>
</table>
</div>
<!-- class="header" -->
<div class="ind"><!-- End Header --><a id="TLJPA634" name="TLJPA634"></a><a id="sthref499" name="sthref499"></a>
<h1 class="chapter"><font face="arial, helvetica, sans-serif" color="#330099"><span class="secnum">4</span> JPA Query Customization Extensions</font></h1>
<p>You can specify EclipseLink query hints (JPA query extensions) by:</p>
<ul>
<li>
<p>Using the <code>@QueryHint</code> annotation</p>
</li>
<li>
<p>Including the hints in the <code>orm.xml</code> or <code>eclipselink-orm.xml</code> file</p>
</li>
<li>
<p>Using the <code>setHint()</code> method when executing a named or dynamic query (JPQL or Criteria)</p>
</li>
</ul>
<p>EclipseLink supplies the following query hints:</p>
<ul>
<li>
<p><code><a href="q_batch.htm#batch">batch</a></code></p>
</li>
<li>
<p><code><a href="q_batch_size.htm#BABHCJIH">batch.size</a></code></p>
</li>
<li>
<p><code><a href="q_batch_type.htm#BABFGHAA">batch.type</a></code></p>
</li>
<li>
<p><code><a href="q_cacheusage.htm#cacheusage">cache-usage</a></code></p>
</li>
<li>
<p><code><a href="q_cache-usage_indirection-policy.htm#BABDBIDI">cache-usage.indirection-policy</a></code></p>
</li>
<li>
<p><code><a href="p_composite_unit_member.htm#CHDHCIDH">composite-unit.member</a></code></p>
</li>
<li>
<p><code><a href="q_cursor.htm#BABBGFJA">cursor</a></code></p>
</li>
<li>
<p><code><a href="q_cursor_initial-size.htm#CHDJJCHG">cursor.initial-size</a></code></p>
</li>
<li>
<p><code><a href="q_cursor_page-size.htm#CACIGJGE">cursor.page-size</a></code></p>
</li>
<li>
<p><code><a href="q_exclusive-connection.htm#BABJFGGC">exclusive-connection</a></code></p>
</li>
<li>
<p><a href="a_fetchgroup.htm"><code>fetch-group</code></a></p>
</li>
<li>
<p><a href="a_fetchgroup.htm"><code>fetch-group.attribute</code></a></p>
</li>
<li>
<p><a href="a_fetchgroup.htm"><code>fetch-group.default</code></a></p>
</li>
<li>
<p><a href="a_fetchgroup.htm"><code>fetch-group.load</code></a></p>
</li>
<li>
<p><a href="a_fetchgroup.htm"><code>fetch-group.name</code></a></p>
</li>
<li>
<p><code><a href="q_flush.htm#CBHFHGEB">flush</a></code></p>
</li>
<li>
<p><code><a href="q_history.htm#CACDJCBE">history.as-of</a></code></p>
</li>
<li>
<p><code><a href="q_history_as-of_scn.htm#BDCBGEJG">history.as-of.scn</a></code></p>
</li>
<li>
<p><code><a href="q_inheritance_outer-join.htm#BABEDHJB">inheritance.outer-join</a></code></p>
</li>
<li>
<p><code><a href="p_jdbc_allownativesql.htm#CIHHJBFB">jdbc.allow-native-sql-queries</a></code></p>
</li>
<li>
<p><code><a href="q_bindparameters.htm#bindparameters">jdbc.bind-parameters</a></code></p>
</li>
<li>
<p><code><a href="q_jdbc_cache-statement.htm#BABCHAFD">jdbc.cache-statement</a></code></p>
</li>
<li>
<p><code><a href="q_jdbc_fetch_size.htm#fetchsize">jdbc.fetch-size</a></code></p>
</li>
<li>
<p><code><a href="q_jdbc_first-result.htm#BHAGGAIA">jdbc.first-result</a></code></p>
</li>
<li>
<p><code><a href="q_jdbc_max_rows.htm#maxrows">jdbc.max-rows</a></code></p>
</li>
<li>
<p><code><a href="q_jdbc_native-connection.htm#CACCHBBG">jdbc.native-connection</a></code></p>
</li>
<li>
<p><code><a href="q_jdbc_parameter-delimiter.htm#CHDEBFHE">jdbc.parameter-delimiter</a></code></p>
</li>
<li>
<p><code><a href="q_jdbc_timeout.htm#timeout">jdbc.timeout</a></code></p>
</li>
<li>
<p><code><a href="q_join_fetch.htm#fetch">join-fetch</a></code></p>
</li>
<li>
<p><code><a href="q_left-join-fetch.htm#CHDEFDDC">left-join-fetch</a></code></p>
</li>
<li>
<p><code><a href="q_load-group.htm#BABIJCGD">load-group</a></code></p>
</li>
<li>
<p><code><a href="q_load-group_attribute.htm#CACEDHDG">load-group.attribute</a></code></p>
</li>
<li>
<p><code><a href="q_maintain_cache.htm#maintaincache">maintain-cache</a></code></p>
</li>
<li>
<p><code><a href="p_partitioning.htm#partitioning">partitioning</a></code></p>
</li>
<li>
<p><code><a href="q_pessimistic_lock.htm#pessimisticlock">pessimistic-lock</a></code></p>
</li>
<li>
<p><code><a href="q_prepare.htm#CHDGDECH">prepare</a></code></p>
</li>
<li>
<p><code><a href="q_query-results-cache.htm#CHDGEADJ">query-results-cache</a></code></p>
</li>
<li>
<p><code><a href="q_query-results-cache_expiry.htm#BABHGIHG">query-results-cache.expiry</a></code></p>
</li>
<li>
<p><code><a href="q_query-results-cache_expiry-time-of-day.htm#CBAFBFJA">query-results-cache.expiry-time-of-day</a></code></p>
</li>
<li>
<p><code><a href="q_query-results-cache_ignore-null.htm#CHDHGGBD">query-results-cache.ignore-null</a></code></p>
</li>
<li>
<p><code><a href="q_query-results-cache_randomize-expiry.htm#BGBEBGHI">query-results-cache.randomize-expiry</a></code></p>
</li>
<li>
<p><code><a href="q_query-results-cache_size.htm#CACJDDDG">query-results-cache.size</a></code></p>
</li>
<li>
<p><code><a href="q_query-results-cache_type.htm#CACCFFDA">query-results-cache.type</a></code></p>
</li>
<li>
<p><code><a href="q_querytype.htm#querytype">query-type</a></code></p>
</li>
<li>
<p><a href="a_queryredirectors.htm"><code>query.redirection</code></a></p>
</li>
<li>
<p><code><a href="q_read_only.htm#readonly">read-only</a></code></p>
</li>
<li>
<p><code><a href="q_refresh.htm#refresh">refresh</a></code></p>
</li>
<li>
<p><code><a href="q_refresh_cache.htm#refreshcache">refresh.cascade</a></code></p>
</li>
<li>
<p><code><a href="q_resultcollectiontype.htm#BABCJADG">result-collection-type</a></code></p>
</li>
<li>
<p><code><a href="q_sql_hint.htm#CIHHAEDE">sql.hint</a></code></p>
</li>
</ul>
<p>All EclipseLink query hints are defined in the <code>QueryHints</code> class in the <code>org.eclipse.persistence.config package</code>. When you set a hint, you can set the value using the public static final field in the appropriate configuration class in <code>org.eclipse.persistence.config</code> package, including the following:</p>
<ul>
<li>
<p><code>HintValues</code></p>
</li>
<li>
<p><code>CacheUsage</code></p>
</li>
<li>
<p><code>PessimisticLock</code></p>
</li>
<li>
<p><code>QueryType</code></p>
</li>
</ul>
<p>For more information, see Section 10.3.1 "NamedQuery Annotation" in the JPA Specification (<code><a href="http://jcp.org/en/jsr/detail?id=317">http://jcp.org/en/jsr/detail?id=317</a></code>).</p>
</div>
<!-- class="ind" -->
<!-- Start Footer -->
<div class="footer">
<hr />
<table class="simple oac_no_warn" summary="" cellspacing="0" cellpadding="0" width="100%">
<col width="33%" />
<col width="*" />
<col width="33%" />
<tr>
<td valign="bottom">
<table class="navigation simple oac_no_warn" summary="" cellspacing="0" cellpadding="0" width="100" align="center">
<col width="*" />
<col width="48%" />
<col width="48%" />
<tr>
<td>&nbsp;</td>
<td align="center"><a href="j_union.htm"><img src="../../../dcommon/images/larrow.png" alt="Previous" border="0" height="16" width="16" /></a></td>
<td align="center"><a href="q_batch.htm"><img src="../../../dcommon/images/rarrow.png" alt="Next" border="0" height="16" width="16" /></a></td>
</tr>
</table>
</td>
<td align="center" width="34%"><a href="http://www.eclipse.org/eclipselink/" title="EclipseLink home"><img src="../../../dcommon/images/ellogo.png" alt="EclipseLink" width="150" border="0" /></a><br />
</td>
<td valign="bottom" align="right">
<table class="simple oac_no_warn" summary="" cellspacing="0" cellpadding="0" width="225">
<tr>
<td>&nbsp;</td>
<td align="center" valign="top"><a href="toc.htm"><img src="../../../dcommon/images/contents.png" alt="Go To Table Of Contents" border="0" height="16" width="16" /><br />
</td><td>&nbsp;</td><td align="center"><a href="../../../" target="_top" class="external text" title="Search" rel="nofollow"><img src="../../../dcommon/images/search.png" alt="Search" style="border:0;" /><br /><span class="mini"></span></a></td><td>&nbsp;</td><td align="center"><a href="../../eclipselink_jpa_extensions.pdf" title="PDF" target="_blank"><img src="../../../dcommon/images/pdf_icon.png" style="padding-right:5px;border:0" alt="PDF"></a></td><td align="center"><a href="#disqus_thread" title="Comments""><img src="../../../dcommon/images/comments.png" style="padding-right:5px;border:0" alt="Comments"><br /><span class="mini">Comments</span></a>
</tr>
</table>
</td>
</tr>
</table>
</div>
<!-- class="footer" -->
<div id="copyright">Copyright &copy; 2012 by The Eclipse Foundation under the <a href="http://www.eclipse.org/org/documents/epl-v10.php">Eclipse Public License (EPL)</a><br /> <script type="text/javascript">var LastUpdated = document.lastModified;document.writeln ("Updated: " + LastUpdated);</script> </div><!-- START: Analytics --><script type="text/javascript"> var _gaq = _gaq || []; _gaq.push(['_setAccount', 'UA-1608008-2']); _gaq.push(['_trackPageview']); (function() { var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); })(); </script><!-- END: Analytics --><!-- START: Sharethis --><script>var options={ "publisher": "e2fe9e07-fab6-4f84-83ea-0991b429842c", "position": "right", "ad": { "visible": false, "openDelay": 5, "closeDelay": 0}};var st_hover_widget = new sharethis.widgets.hoverbuttons(options);</script><!-- END: Sharethis --></body>
</html>