| <!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:38:49 UTC 2021 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>QueryHints (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="QueryHints (EclipseLink 3.0.2, API Reference)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| </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/config/PropertiesUtils.html" title="class in org.eclipse.persistence.config"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/eclipse/persistence/config/QueryType.html" title="class in org.eclipse.persistence.config"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/eclipse/persistence/config/QueryHints.html" target="_top">Frames</a></li> |
| <li><a href="QueryHints.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="#methods.inherited.from.class.java.lang.Object">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>Method</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.config</div> |
| <h2 title="Class QueryHints" class="title">Class QueryHints</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.config.QueryHints</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/jpa/rs/QueryParameters.html" title="class in org.eclipse.persistence.jpa.rs">QueryParameters</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">QueryHints</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">The class defines EclipseLink query hints. |
| These query hints allow a JPA Query to be customized or optimized beyond |
| what is available in the JPA specification. |
| |
| <p>JPA Query Hint Usage: |
| |
| <p><code>query.setHint(QueryHints.CACHE_USAGE, CacheUsage.CheckCacheOnly);</code> |
| <p>or |
| <p><code>@QueryHint(name=QueryHints.CACHE_USAGE, value=CacheUsage.CheckCacheOnly)</code> |
| |
| <p>Hint values are case-insensitive; "" could be used instead of default value.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/config/HintValues.html" title="class in org.eclipse.persistence.config"><code>HintValues</code></a>, |
| <a href="../../../../org/eclipse/persistence/config/CacheUsage.html" title="class in org.eclipse.persistence.config"><code>CacheUsage</code></a>, |
| <a href="../../../../org/eclipse/persistence/config/PessimisticLock.html" title="class in org.eclipse.persistence.config"><code>PessimisticLock</code></a>, |
| <a href="../../../../org/eclipse/persistence/config/QueryType.html" title="class in org.eclipse.persistence.config"><code>QueryType</code></a></dd> |
| </dl> |
| </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>static <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/config/QueryHints.html#ALLOW_NATIVE_SQL_QUERY">ALLOW_NATIVE_SQL_QUERY</a></span></code> |
| <div class="block">The <code>"eclipselink.jdbc.allow-native-sql-query"</code> property |
| specifies whether a single native SQL query should override a persistence |
| unit level setting (eclipselink.jdbc.allow-native-sql-queries).</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <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/config/QueryHints.html#AS_OF">AS_OF</a></span></code> |
| <div class="block">"eclipselink.history.as-of"</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <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/config/QueryHints.html#AS_OF_SCN">AS_OF_SCN</a></span></code> |
| <div class="block">"eclipselink.history.as-of.scn"</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <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/config/QueryHints.html#BATCH">BATCH</a></span></code> |
| <div class="block">"eclipselink.batch"</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <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/config/QueryHints.html#BATCH_SIZE">BATCH_SIZE</a></span></code> |
| <div class="block">"eclipselink.batch.size"</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <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/config/QueryHints.html#BATCH_TYPE">BATCH_TYPE</a></span></code> |
| <div class="block">"eclipselink.batch.type"</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <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/config/QueryHints.html#BATCH_WRITING">BATCH_WRITING</a></span></code> |
| <div class="block">"eclipselink.jdbc.batch-writing"</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <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/config/QueryHints.html#BIND_PARAMETERS">BIND_PARAMETERS</a></span></code> |
| <div class="block">"eclipselink.jdbc.bind-parameters"</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <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/config/QueryHints.html#CACHE_RETRIEVE_MODE">CACHE_RETRIEVE_MODE</a></span></code> |
| <div class="block">"jakarta.persistence.cache.retrieveMode"</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <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/config/QueryHints.html#CACHE_STATMENT">CACHE_STATMENT</a></span></code> |
| <div class="block">"eclipselink.jdbc.cache-statement"</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <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/config/QueryHints.html#CACHE_STORE_MODE">CACHE_STORE_MODE</a></span></code> |
| <div class="block">"jakarta.persistence.cache.storeMode"</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <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/config/QueryHints.html#CACHE_USAGE">CACHE_USAGE</a></span></code> |
| <div class="block">"eclipselink.cache-usage"</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <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/config/QueryHints.html#COMPOSITE_UNIT_MEMBER">COMPOSITE_UNIT_MEMBER</a></span></code> |
| <div class="block">"eclipselink.composite-unit.member"</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <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/config/QueryHints.html#CURSOR">CURSOR</a></span></code> |
| <div class="block">"eclipselink.cursor"</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <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/config/QueryHints.html#CURSOR_INITIAL_SIZE">CURSOR_INITIAL_SIZE</a></span></code> |
| <div class="block">"eclipselink.cursor.initial-size"</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <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/config/QueryHints.html#CURSOR_PAGE_SIZE">CURSOR_PAGE_SIZE</a></span></code> |
| <div class="block">"eclipselink.cursor.page-size"</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <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/config/QueryHints.html#CURSOR_SIZE">CURSOR_SIZE</a></span></code> |
| <div class="block">"eclipselink.cursor.size-sql"</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <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/config/QueryHints.html#EXCLUSIVE_CONNECTION">EXCLUSIVE_CONNECTION</a></span></code> |
| <div class="block">"eclipselink.exclusive-connection"</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <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/config/QueryHints.html#FETCH">FETCH</a></span></code> |
| <div class="block">"eclipselink.join-fetch"</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <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/config/QueryHints.html#FETCH_GROUP">FETCH_GROUP</a></span></code> |
| <div class="block">"eclipselink.fetch-group"</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <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/config/QueryHints.html#FETCH_GROUP_ATTRIBUTE">FETCH_GROUP_ATTRIBUTE</a></span></code> |
| <div class="block">"eclipselink.fetch-group.attribute"</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <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/config/QueryHints.html#FETCH_GROUP_DEFAULT">FETCH_GROUP_DEFAULT</a></span></code> |
| <div class="block">"eclipselink.fetch-group.default"</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <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/config/QueryHints.html#FETCH_GROUP_LOAD">FETCH_GROUP_LOAD</a></span></code> |
| <div class="block">"eclipselink.fetch-group.load"</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <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/config/QueryHints.html#FETCH_GROUP_NAME">FETCH_GROUP_NAME</a></span></code> |
| <div class="block">"eclipselink.fetch-group.name"</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <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/config/QueryHints.html#FLUSH">FLUSH</a></span></code> |
| <div class="block">"eclipselink.flush"</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <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/config/QueryHints.html#HINT">HINT</a></span></code> |
| <div class="block">"eclipselink.sql.hint"</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <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/config/QueryHints.html#INDIRECTION_POLICY">INDIRECTION_POLICY</a></span></code> |
| <div class="block">"eclipselink.cache-usage.indirection-policy"</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <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/config/QueryHints.html#INHERITANCE_OUTER_JOIN">INHERITANCE_OUTER_JOIN</a></span></code> |
| <div class="block">"eclipselink.inheritance.outer-join"</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <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/config/QueryHints.html#JDBC_FETCH_SIZE">JDBC_FETCH_SIZE</a></span></code> |
| <div class="block">"eclipselink.jdbc.fetch-size"</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <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/config/QueryHints.html#JDBC_FIRST_RESULT">JDBC_FIRST_RESULT</a></span></code> |
| <div class="block">"eclipselink.jdbc.first-result"</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <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/config/QueryHints.html#JDBC_MAX_ROWS">JDBC_MAX_ROWS</a></span></code> |
| <div class="block">"eclipselink.jdbc.max-rows"</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <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/config/QueryHints.html#JDBC_TIMEOUT">JDBC_TIMEOUT</a></span></code> |
| <div class="block">"eclipselink.jdbc.timeout"</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <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/config/QueryHints.html#JPA_FETCH_GRAPH">JPA_FETCH_GRAPH</a></span></code> |
| <div class="block">"jakarta.persistence.fetchgraph"</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <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/config/QueryHints.html#JPA_LOAD_GRAPH">JPA_LOAD_GRAPH</a></span></code> |
| <div class="block">"jakarta.persistence.loadgraph"</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <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/config/QueryHints.html#LEFT_FETCH">LEFT_FETCH</a></span></code> |
| <div class="block">"eclipselink.left-join-fetch"</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <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/config/QueryHints.html#LOAD_GROUP">LOAD_GROUP</a></span></code> |
| <div class="block">"eclipselink.load-group"</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <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/config/QueryHints.html#LOAD_GROUP_ATTRIBUTE">LOAD_GROUP_ATTRIBUTE</a></span></code> |
| <div class="block">"eclipselink.load-group.attribute"</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <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/config/QueryHints.html#MAINTAIN_CACHE">MAINTAIN_CACHE</a></span></code> |
| <div class="block">"eclipselink.maintain-cache"</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <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/config/QueryHints.html#NATIVE_CONNECTION">NATIVE_CONNECTION</a></span></code> |
| <div class="block">"eclipselink.jdbc.native-connection"</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <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/config/QueryHints.html#PARAMETER_DELIMITER">PARAMETER_DELIMITER</a></span></code> |
| <div class="block">"eclipselink.jdbc.parameter-delimiter"</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <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/config/QueryHints.html#PARTITIONING">PARTITIONING</a></span></code> |
| <div class="block">"eclipselink.partitioning"</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <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/config/QueryHints.html#PESSIMISTIC_LOCK">PESSIMISTIC_LOCK</a></span></code> |
| <div class="block">"eclipselink.pessimistic-lock"</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <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/config/QueryHints.html#PESSIMISTIC_LOCK_SCOPE">PESSIMISTIC_LOCK_SCOPE</a></span></code> |
| <div class="block">"jakarta.persistence.lock.scope"</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <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/config/QueryHints.html#PESSIMISTIC_LOCK_TIMEOUT">PESSIMISTIC_LOCK_TIMEOUT</a></span></code> |
| <div class="block">"jakarta.persistence.lock.timeout"</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <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/config/QueryHints.html#PESSIMISTIC_LOCK_TIMEOUT_UNIT">PESSIMISTIC_LOCK_TIMEOUT_UNIT</a></span></code> |
| <div class="block">"eclipselink.pessimistic.lock.timeout.unit"</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <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/config/QueryHints.html#PREPARE">PREPARE</a></span></code> |
| <div class="block">"eclipselink.prepare"</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <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/config/QueryHints.html#QUERY_REDIRECTOR">QUERY_REDIRECTOR</a></span></code> |
| <div class="block">"eclipselink.query.redirector"</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <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/config/QueryHints.html#QUERY_RESULTS_CACHE">QUERY_RESULTS_CACHE</a></span></code> |
| <div class="block">"eclipselink.query-results-cache"</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <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/config/QueryHints.html#QUERY_RESULTS_CACHE_EXPIRY">QUERY_RESULTS_CACHE_EXPIRY</a></span></code> |
| <div class="block">"eclipselink.query-results-cache.expiry"</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <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/config/QueryHints.html#QUERY_RESULTS_CACHE_EXPIRY_TIME_OF_DAY">QUERY_RESULTS_CACHE_EXPIRY_TIME_OF_DAY</a></span></code> |
| <div class="block">"eclipselink.query-results-cache.expiry-time-of-day"</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <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/config/QueryHints.html#QUERY_RESULTS_CACHE_IGNORE_NULL">QUERY_RESULTS_CACHE_IGNORE_NULL</a></span></code> |
| <div class="block">"eclipselink.query-results-cache.ignore-null"</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <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/config/QueryHints.html#QUERY_RESULTS_CACHE_INVALIDATE">QUERY_RESULTS_CACHE_INVALIDATE</a></span></code> |
| <div class="block">"eclipselink.query-results-cache.invalidate-on-change"</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <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/config/QueryHints.html#QUERY_RESULTS_CACHE_RANDOMIZE_EXPIRY">QUERY_RESULTS_CACHE_RANDOMIZE_EXPIRY</a></span></code> |
| <div class="block">"eclipselink.query-results-cache.randomize-expiry"</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <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/config/QueryHints.html#QUERY_RESULTS_CACHE_SIZE">QUERY_RESULTS_CACHE_SIZE</a></span></code> |
| <div class="block">"eclipselink.query-results-cache.size"</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <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/config/QueryHints.html#QUERY_RESULTS_CACHE_TYPE">QUERY_RESULTS_CACHE_TYPE</a></span></code> |
| <div class="block">"eclipselink.query-results-cache.type"</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <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/config/QueryHints.html#QUERY_TIMEOUT">QUERY_TIMEOUT</a></span></code> |
| <div class="block">"jakarta.persistence.query.timeout"</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <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/config/QueryHints.html#QUERY_TIMEOUT_UNIT">QUERY_TIMEOUT_UNIT</a></span></code> |
| <div class="block">"eclipselink.jdbc.timeout.unit"</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <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/config/QueryHints.html#QUERY_TYPE">QUERY_TYPE</a></span></code> |
| <div class="block">"eclipselink.query-type"</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <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/config/QueryHints.html#READ_ONLY">READ_ONLY</a></span></code> |
| <div class="block">"eclipselink.read-only"</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <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/config/QueryHints.html#REFRESH">REFRESH</a></span></code> |
| <div class="block">"eclipselink.refresh"</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <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/config/QueryHints.html#REFRESH_CASCADE">REFRESH_CASCADE</a></span></code> |
| <div class="block">"eclipselink.refresh.cascade"</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <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/config/QueryHints.html#RESULT_COLLECTION_TYPE">RESULT_COLLECTION_TYPE</a></span></code> |
| <div class="block">"eclipselink.result-collection-type"</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <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/config/QueryHints.html#RESULT_SET_ACCESS">RESULT_SET_ACCESS</a></span></code> |
| <div class="block">"eclipselink.result-set-access"</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <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/config/QueryHints.html#RESULT_SET_CONCURRENCY">RESULT_SET_CONCURRENCY</a></span></code> |
| <div class="block">"eclipselink.cursor.scrollable.result-set-concurrency"</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <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/config/QueryHints.html#RESULT_SET_TYPE">RESULT_SET_TYPE</a></span></code> |
| <div class="block">"eclipselink.cursor.scrollable.result-set-type"</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <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/config/QueryHints.html#RESULT_TYPE">RESULT_TYPE</a></span></code> |
| <div class="block">"eclipselink.result-type"</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <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/config/QueryHints.html#RETURN_NAME_VALUE_PAIRS">RETURN_NAME_VALUE_PAIRS</a></span></code> |
| <div class="block">"eclipselink.query-return-name-value-pairs"</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <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/config/QueryHints.html#SCROLLABLE_CURSOR">SCROLLABLE_CURSOR</a></span></code> |
| <div class="block">"eclipselink.cursor.scrollable"</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <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/config/QueryHints.html#SERIALIZED_OBJECT">SERIALIZED_OBJECT</a></span></code> |
| <div class="block">"eclipselink.serialized-object"</div> |
| </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/config/QueryHints.html#QueryHints--">QueryHints</a></span>()</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <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#finalize--" title="class or interface in java.lang">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">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="BIND_PARAMETERS"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>BIND_PARAMETERS</h4> |
| <pre>public static final <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> BIND_PARAMETERS</pre> |
| <div class="block">"eclipselink.jdbc.bind-parameters" |
| <p>Configures parameter binding to be disabled or enabled just for this query (overrides persistent unit setting, which default to true). |
| Valid values are: HintValues.PERSISTENCE_UNIT_DEFAULT, HintValues.TRUE, HintValues.FALSE, |
| "" could be used instead of default value HintValues.PERSISTENCE_UNIT_DEFAULT</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/config/PersistenceUnitProperties.html#JDBC_BIND_PARAMETERS"><code>PersistenceUnitProperties.JDBC_BIND_PARAMETERS</code></a>, |
| <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setShouldBindAllParameters-boolean-"><code>DatabaseQuery.setShouldBindAllParameters(boolean)</code></a>, |
| <a href="../../../../constant-values.html#org.eclipse.persistence.config.QueryHints.BIND_PARAMETERS">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="PARAMETER_DELIMITER"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>PARAMETER_DELIMITER</h4> |
| <pre>public static final <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> PARAMETER_DELIMITER</pre> |
| <div class="block">"eclipselink.jdbc.parameter-delimiter" |
| <p>Configures parameter binding char to a user defined character (overrides default hash symbol). |
| Valid values are: ParameterDelimiterType.DEFAULT, other valid single character, |
| "" can not be used and will instead default to ParameterDelimiterType.DEFAULT</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/config/PersistenceUnitProperties.html#JDBC_BIND_PARAMETERS"><code>PersistenceUnitProperties.JDBC_BIND_PARAMETERS</code></a>, |
| <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setShouldBindAllParameters-boolean-"><code>DatabaseQuery.setShouldBindAllParameters(boolean)</code></a>, |
| <a href="../../../../constant-values.html#org.eclipse.persistence.config.QueryHints.PARAMETER_DELIMITER">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="CACHE_RETRIEVE_MODE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>CACHE_RETRIEVE_MODE</h4> |
| <pre>public static final <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> CACHE_RETRIEVE_MODE</pre> |
| <div class="block">"jakarta.persistence.cache.retrieveMode" |
| <p>Configures the behavior when data is retrieved by the find methods and |
| by the execution of queries. The cache retrieve mode is ignored for the |
| refresh method, which always causes data to be retrieved from the |
| database and not the cache.</p></div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#dontMaintainCache--"><code>DatabaseQuery.dontMaintainCache()</code></a>, |
| <a href="../../../../org/eclipse/persistence/queries/ObjectLevelReadQuery.html#shouldCheckDescriptorForCacheUsage--"><code>ObjectLevelReadQuery.shouldCheckDescriptorForCacheUsage()</code></a>, |
| <a href="../../../../constant-values.html#org.eclipse.persistence.config.QueryHints.CACHE_RETRIEVE_MODE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="CACHE_STORE_MODE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>CACHE_STORE_MODE</h4> |
| <pre>public static final <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> CACHE_STORE_MODE</pre> |
| <div class="block">"jakarta.persistence.cache.storeMode" |
| <p>Configures the behavior when data is read from the database and when |
| data is committed into the database.</p></div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#dontMaintainCache--"><code>DatabaseQuery.dontMaintainCache()</code></a>, |
| <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#maintainCache--"><code>DatabaseQuery.maintainCache()</code></a>, |
| <a href="../../../../org/eclipse/persistence/queries/ObjectLevelReadQuery.html#refreshIdentityMapResult--"><code>ObjectLevelReadQuery.refreshIdentityMapResult()</code></a>, |
| <a href="../../../../constant-values.html#org.eclipse.persistence.config.QueryHints.CACHE_STORE_MODE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="CACHE_USAGE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>CACHE_USAGE</h4> |
| <pre>public static final <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> CACHE_USAGE</pre> |
| <div class="block">"eclipselink.cache-usage" |
| <p>Configures the query to utilize the EclipseLink cache, by default the cache is not checked on queries before accessing the database. |
| Valid values are all declared in CacheUsage class. |
| For primary key cache hits the QUERY_TYPE hint must also be set to QueryType.ReadObject.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/config/CacheUsage.html" title="class in org.eclipse.persistence.config"><code>CacheUsage</code></a>, |
| <a href="../../../../org/eclipse/persistence/config/QueryHints.html#QUERY_TYPE"><code>QUERY_TYPE</code></a>, |
| <a href="../../../../org/eclipse/persistence/queries/ReadObjectQuery.html" title="class in org.eclipse.persistence.queries"><code>ReadObjectQuery</code></a>, |
| <a href="../../../../org/eclipse/persistence/queries/ObjectLevelReadQuery.html#setCacheUsage-int-"><code>ObjectLevelReadQuery.setCacheUsage(int)</code></a>, |
| <a href="../../../../constant-values.html#org.eclipse.persistence.config.QueryHints.CACHE_USAGE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="QUERY_RESULTS_CACHE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>QUERY_RESULTS_CACHE</h4> |
| <pre>public static final <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> QUERY_RESULTS_CACHE</pre> |
| <div class="block">"eclipselink.query-results-cache" |
| <p>Configures the query to use a results cache. |
| By default the query will cache 100 query results, such that the same named query with the same arguments |
| is re-executed it will skip the database and just return the cached results. |
| Valid values are: HintValues.PERSISTENCE_UNIT_DEFAULT, HintValues.TRUE, HintValues.FALSE, |
| "" could be used instead of default value HintValues.PERSISTENCE_UNIT_DEFAULT. |
| By default query results are not cached. |
| This is not, and is independent from the object cache.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/queries/QueryResultsCachePolicy.html" title="class in org.eclipse.persistence.queries"><code>QueryResultsCachePolicy</code></a>, |
| <a href="../../../../org/eclipse/persistence/queries/ReadQuery.html#setQueryResultsCachePolicy-org.eclipse.persistence.queries.QueryResultsCachePolicy-"><code>ReadQuery.setQueryResultsCachePolicy(org.eclipse.persistence.queries.QueryResultsCachePolicy)</code></a>, |
| <a href="../../../../constant-values.html#org.eclipse.persistence.config.QueryHints.QUERY_RESULTS_CACHE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="QUERY_RESULTS_CACHE_SIZE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>QUERY_RESULTS_CACHE_SIZE</h4> |
| <pre>public static final <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> QUERY_RESULTS_CACHE_SIZE</pre> |
| <div class="block">"eclipselink.query-results-cache.size" |
| <p>Configures the size of the query's results cache. |
| By default the query will cache 100 query results, such that the same named query with the same arguments |
| is re-executed it will skip the database and just return the cached results. |
| If the query has no arguments a size of 1 should be used (as there is only a single result). |
| Valid values are Integer or Strings that can be parsed to int values.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/queries/QueryResultsCachePolicy.html#setMaximumCachedResults-int-"><code>QueryResultsCachePolicy.setMaximumCachedResults(int)</code></a>, |
| <a href="../../../../constant-values.html#org.eclipse.persistence.config.QueryHints.QUERY_RESULTS_CACHE_SIZE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="QUERY_RESULTS_CACHE_EXPIRY"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>QUERY_RESULTS_CACHE_EXPIRY</h4> |
| <pre>public static final <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> QUERY_RESULTS_CACHE_EXPIRY</pre> |
| <div class="block">"eclipselink.query-results-cache.expiry" |
| <p>Configures the time to live, or expiry time of the query's results cache. |
| By default the query results cache will not expiry results. |
| Valid values are number of milliseconds, Integer or Strings that can be parsed to int values.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/descriptors/invalidation/CacheInvalidationPolicy.html" title="class in org.eclipse.persistence.descriptors.invalidation"><code>CacheInvalidationPolicy</code></a>, |
| <a href="../../../../org/eclipse/persistence/queries/QueryResultsCachePolicy.html#setCacheInvalidationPolicy-org.eclipse.persistence.descriptors.invalidation.CacheInvalidationPolicy-"><code>QueryResultsCachePolicy.setCacheInvalidationPolicy(org.eclipse.persistence.descriptors.invalidation.CacheInvalidationPolicy)</code></a>, |
| <a href="../../../../constant-values.html#org.eclipse.persistence.config.QueryHints.QUERY_RESULTS_CACHE_EXPIRY">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="QUERY_RESULTS_CACHE_RANDOMIZE_EXPIRY"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>QUERY_RESULTS_CACHE_RANDOMIZE_EXPIRY</h4> |
| <pre>public static final <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> QUERY_RESULTS_CACHE_RANDOMIZE_EXPIRY</pre> |
| <div class="block">"eclipselink.query-results-cache.randomize-expiry" |
| <p>Configures a randomization on the expiry invalidation time. |
| This can be used to avoid bottlenecks from the cached values expiring at the same time. |
| By default expiry is not randomized. |
| Valid values are "true" and "false", false is the default.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/descriptors/invalidation/CacheInvalidationPolicy.html#setIsInvalidationRandomized-boolean-"><code>CacheInvalidationPolicy.setIsInvalidationRandomized(boolean)</code></a>, |
| <a href="../../../../constant-values.html#org.eclipse.persistence.config.QueryHints.QUERY_RESULTS_CACHE_RANDOMIZE_EXPIRY">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="QUERY_RESULTS_CACHE_IGNORE_NULL"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>QUERY_RESULTS_CACHE_IGNORE_NULL</h4> |
| <pre>public static final <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> QUERY_RESULTS_CACHE_IGNORE_NULL</pre> |
| <div class="block">"eclipselink.query-results-cache.ignore-null" |
| <p>Configures null results to not be cached. |
| This can be used to use the query cache as a secondary key index, and allow inserts of new objects. |
| By default null results are cached. |
| Valid values are "true" and "false", false is the default.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/queries/QueryResultsCachePolicy.html#setIsNullIgnored-boolean-"><code>QueryResultsCachePolicy.setIsNullIgnored(boolean)</code></a>, |
| <a href="../../../../constant-values.html#org.eclipse.persistence.config.QueryHints.QUERY_RESULTS_CACHE_IGNORE_NULL">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="QUERY_RESULTS_CACHE_INVALIDATE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>QUERY_RESULTS_CACHE_INVALIDATE</h4> |
| <pre>public static final <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> QUERY_RESULTS_CACHE_INVALIDATE</pre> |
| <div class="block">"eclipselink.query-results-cache.invalidate-on-change" |
| <p>Configures if the query cache results should be invalidated if any object of any class used in the query if modified. |
| |
| Valid values are "true" and "false", true is the default.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/queries/QueryResultsCachePolicy.html#setInvalidateOnChange-boolean-"><code>QueryResultsCachePolicy.setInvalidateOnChange(boolean)</code></a>, |
| <a href="../../../../constant-values.html#org.eclipse.persistence.config.QueryHints.QUERY_RESULTS_CACHE_INVALIDATE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="QUERY_RESULTS_CACHE_TYPE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>QUERY_RESULTS_CACHE_TYPE</h4> |
| <pre>public static final <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> QUERY_RESULTS_CACHE_TYPE</pre> |
| <div class="block">"eclipselink.query-results-cache.type" |
| <p>Configures the cache type of the query's results cache. |
| By default the a fixed sized LRU cache is used (CACHE). |
| Valid values are defined in the CacheType enum (as Strings).</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/annotations/CacheType.html" title="enum in org.eclipse.persistence.annotations"><code>CacheType</code></a>, |
| <a href="../../../../org/eclipse/persistence/queries/QueryResultsCachePolicy.html#setCacheType-java.lang.Class-"><code>QueryResultsCachePolicy.setCacheType(java.lang.Class)</code></a>, |
| <a href="../../../../constant-values.html#org.eclipse.persistence.config.QueryHints.QUERY_RESULTS_CACHE_TYPE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="QUERY_RESULTS_CACHE_EXPIRY_TIME_OF_DAY"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>QUERY_RESULTS_CACHE_EXPIRY_TIME_OF_DAY</h4> |
| <pre>public static final <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> QUERY_RESULTS_CACHE_EXPIRY_TIME_OF_DAY</pre> |
| <div class="block">"eclipselink.query-results-cache.expiry-time-of-day" |
| <p>Configures the time of day expiry time of the query's results cache. |
| By default the query results cache will not expiry results. |
| Valid values are String Time format, "HH:MM:SS".</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/descriptors/invalidation/CacheInvalidationPolicy.html" title="class in org.eclipse.persistence.descriptors.invalidation"><code>CacheInvalidationPolicy</code></a>, |
| <a href="../../../../org/eclipse/persistence/queries/QueryResultsCachePolicy.html#setCacheInvalidationPolicy-org.eclipse.persistence.descriptors.invalidation.CacheInvalidationPolicy-"><code>QueryResultsCachePolicy.setCacheInvalidationPolicy(org.eclipse.persistence.descriptors.invalidation.CacheInvalidationPolicy)</code></a>, |
| <a href="../../../../constant-values.html#org.eclipse.persistence.config.QueryHints.QUERY_RESULTS_CACHE_EXPIRY_TIME_OF_DAY">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="QUERY_REDIRECTOR"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>QUERY_REDIRECTOR</h4> |
| <pre>public static final <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> QUERY_REDIRECTOR</pre> |
| <div class="block">"eclipselink.query.redirector" |
| <p>Used to provide a QueryRedirector to the executing query. |
| The redirector must implement the QueryRedirector interface. |
| This can be used to perform advanced query operations in code, |
| or dynamically customize the query in code before execution. |
| The value should be the name of the QueryRedirector class. |
| <p>i.e. "org.acme.persistence.MyQueryRedirector" |
| <p> The value could also be a Class, or an instance that implements the QueryRedirector interface.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/queries/QueryRedirector.html" title="interface in org.eclipse.persistence.queries"><code>QueryRedirector</code></a>, |
| <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setRedirector-org.eclipse.persistence.queries.QueryRedirector-"><code>DatabaseQuery.setRedirector(org.eclipse.persistence.queries.QueryRedirector)</code></a>, |
| <a href="../../../../constant-values.html#org.eclipse.persistence.config.QueryHints.QUERY_REDIRECTOR">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="PARTITIONING"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>PARTITIONING</h4> |
| <pre>public static final <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> PARTITIONING</pre> |
| <div class="block">"eclipselink.partitioning" |
| <p>Used to provide a PartitioningPolicy instance or name to the query. |
| This allows the query to execute on a specific, or on multiple connection pools.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/annotations/Partitioning.html" title="annotation in org.eclipse.persistence.annotations"><code>Partitioning</code></a>, |
| <a href="../../../../org/eclipse/persistence/descriptors/partitioning/PartitioningPolicy.html" title="class in org.eclipse.persistence.descriptors.partitioning"><code>PartitioningPolicy</code></a>, |
| <a href="../../../../constant-values.html#org.eclipse.persistence.config.QueryHints.PARTITIONING">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="QUERY_TYPE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>QUERY_TYPE</h4> |
| <pre>public static final <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> QUERY_TYPE</pre> |
| <div class="block">"eclipselink.query-type" |
| <p>Configures the EclipseLink query type to use for the query. |
| By default EclipseLink ReportQuery or ReadAllQuery are used for most JPQL queries, this allows other query types to be used, |
| such as ReadObjectQuery which can be used for queries that are know to return a single object, and has different caching semantics. |
| Valid values are all declared in QueryType class. |
| A fully qualified class name of a valid subclass of DatabaseQuery can also be used. |
| <p>i.e. "org.acme.persistence.CustomQuery"</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/config/QueryType.html" title="class in org.eclipse.persistence.config"><code>QueryType</code></a>, |
| <a href="../../../../constant-values.html#org.eclipse.persistence.config.QueryHints.QUERY_TYPE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="PESSIMISTIC_LOCK"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>PESSIMISTIC_LOCK</h4> |
| <pre>public static final <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> PESSIMISTIC_LOCK</pre> |
| <div class="block">"eclipselink.pessimistic-lock" |
| <p>Configures the query to acquire a pessimistic lock (write-lock) on the resulting rows in the database. |
| Valid values are all declared in PessimisticLock class. |
| Pessimistic locking support and behavior may differ on difference database platforms.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/config/PessimisticLock.html" title="class in org.eclipse.persistence.config"><code>PessimisticLock</code></a>, |
| <a href="../../../../org/eclipse/persistence/queries/ObjectLevelReadQuery.html#setLockMode-short-"><code><B>Note:</B> As of JPA 2.0 there is a standard way to configure pessimistic locking.</code></a>, |
| <code>LockModeType</code>, |
| <code>(find(), refresh(), lock())</code>, |
| <code>(setLockMode())</code>, |
| <a href="../../../../constant-values.html#org.eclipse.persistence.config.QueryHints.PESSIMISTIC_LOCK">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="PESSIMISTIC_LOCK_TIMEOUT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>PESSIMISTIC_LOCK_TIMEOUT</h4> |
| <pre>public static final <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> PESSIMISTIC_LOCK_TIMEOUT</pre> |
| <div class="block">"jakarta.persistence.lock.timeout" |
| <p>Configures the WAIT timeout used in pessimistic locking, if the database |
| query exceeds the timeout the database will terminate the query and |
| return an exception. Valid values are Integer or Strings that can be |
| parsed to int values. |
| Some database platforms may not support lock timeouts, you may consider |
| setting a JDBC_TIMEOUT hint for these platforms.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/config/QueryHints.html#JDBC_TIMEOUT"><code>JDBC_TIMEOUT</code></a>, |
| <a href="../../../../org/eclipse/persistence/queries/ObjectLevelReadQuery.html#setWaitTimeout-java.lang.Integer-"><code>ObjectLevelReadQuery.setWaitTimeout(Integer)</code></a>, |
| <a href="../../../../constant-values.html#org.eclipse.persistence.config.QueryHints.PESSIMISTIC_LOCK_TIMEOUT">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="PESSIMISTIC_LOCK_TIMEOUT_UNIT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>PESSIMISTIC_LOCK_TIMEOUT_UNIT</h4> |
| <pre>public static final <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> PESSIMISTIC_LOCK_TIMEOUT_UNIT</pre> |
| <div class="block">"eclipselink.pessimistic.lock.timeout.unit" |
| <p>Configures the pessimistic lock timeout unit value. Allows users more refinement. |
| <b>Valid Values:</b> |
| <ul> |
| <li>"<code>java.util.concurrent.TimeUnit.MILLISECONDS</code>" (DEFAULT), |
| <li>"<code>java.util.concurrent.TimeUnit.SECONDS</code>", |
| <li>"<code>java.util.concurrent.TimeUnit.MINUTES</code>". |
| </ul></div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/queries/ObjectLevelReadQuery.html#setWaitTimeoutUnit-java.util.concurrent.TimeUnit-"><code>ObjectLevelReadQuery.setWaitTimeoutUnit(TimeUnit)</code></a>, |
| <a href="../../../../constant-values.html#org.eclipse.persistence.config.QueryHints.PESSIMISTIC_LOCK_TIMEOUT_UNIT">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="REFRESH"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>REFRESH</h4> |
| <pre>public static final <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> REFRESH</pre> |
| <div class="block">"eclipselink.refresh" |
| <p>Configures the query to refresh the resulting objects in the cache and persistent context with the current state of the database. |
| This will also refresh the objects in the shared cache, unless a flush has occurred. |
| Any unflushed changes made to the objects will be lost (unless this query triggers a flush before execution). |
| The refresh will cascade relationships based on the REFRESH_CASCADE hint value. |
| Valid values are: HintValues.FALSE, HintValues.TRUE, |
| "" could be used instead of default value HintValues.FALSE</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/config/QueryHints.html#REFRESH_CASCADE"><code>REFRESH_CASCADE</code></a>, |
| <a href="../../../../org/eclipse/persistence/queries/ObjectBuildingQuery.html#setShouldRefreshIdentityMapResult-boolean-"><code>ObjectBuildingQuery.setShouldRefreshIdentityMapResult(boolean)</code></a>, |
| <a href="../../../../constant-values.html#org.eclipse.persistence.config.QueryHints.REFRESH">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="BATCH"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>BATCH</h4> |
| <pre>public static final <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> BATCH</pre> |
| <div class="block">"eclipselink.batch" |
| <p>Configures the query to optimize the retrieval of the related objects, |
| the related objects for all the resulting objects will be read in a single query (instead of n queries). |
| Batch reading is normally more efficient than join fetch, especially for collection relationships. |
| Valid values are strings that represent JPQL style navigations to a relationship. |
| <p>e.g. "e.manager.phoneNumbers" |
| <p>Note: Batch reading produces two lines of SQL to read the requested object graph and uses the |
| 'where clause' of the first SQL as part of the 'where clause' of the second. When indirect attributes |
| of the objects returned from the first query are referenced the second query is executed to return those attributes. |
| If changes are made to data referenced in the 'where clause' after the first SQL results are returned but before the |
| second query executes then these attributes may not be returned by the second query. To prevent this reference these |
| attributes before changing data associated with the query."</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/annotations/BatchFetch.html" title="annotation in org.eclipse.persistence.annotations"><code>BatchFetch</code></a>, |
| <a href="../../../../org/eclipse/persistence/config/QueryHints.html#BATCH_TYPE"><code>BATCH_TYPE</code></a>, |
| <a href="../../../../org/eclipse/persistence/annotations/BatchFetchType.html" title="enum in org.eclipse.persistence.annotations"><code>BatchFetchType</code></a>, |
| <a href="../../../../org/eclipse/persistence/queries/ObjectLevelReadQuery.html#addBatchReadAttribute-java.lang.String-"><code>ObjectLevelReadQuery.addBatchReadAttribute(String)</code></a>, |
| <a href="../../../../constant-values.html#org.eclipse.persistence.config.QueryHints.BATCH">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="BATCH_TYPE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>BATCH_TYPE</h4> |
| <pre>public static final <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> BATCH_TYPE</pre> |
| <div class="block">"eclipselink.batch.type" |
| <p>Configures the type of batch fetching to use for any batch fetched relationships on the query. |
| Valid values are defined in BatchFetchType ("JOIN", "EXISTS", "IN").</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/config/QueryHints.html#BATCH"><code>BATCH</code></a>, |
| <a href="../../../../org/eclipse/persistence/annotations/BatchFetchType.html" title="enum in org.eclipse.persistence.annotations"><code>BatchFetchType</code></a>, |
| <a href="../../../../org/eclipse/persistence/annotations/BatchFetch.html" title="annotation in org.eclipse.persistence.annotations"><code>BatchFetch</code></a>, |
| <a href="../../../../org/eclipse/persistence/queries/ObjectLevelReadQuery.html#setBatchFetchType-org.eclipse.persistence.annotations.BatchFetchType-"><code>ObjectLevelReadQuery.setBatchFetchType(BatchFetchType)</code></a>, |
| <a href="../../../../constant-values.html#org.eclipse.persistence.config.QueryHints.BATCH_TYPE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="BATCH_SIZE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>BATCH_SIZE</h4> |
| <pre>public static final <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> BATCH_SIZE</pre> |
| <div class="block">"eclipselink.batch.size" |
| <p>Configures the batch size for batch fetching using the IN batch type. |
| Valid values are integer values > 0. |
| The default size is 256, or the cursor pageSize.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/config/QueryHints.html#BATCH"><code>BATCH</code></a>, |
| <a href="../../../../org/eclipse/persistence/config/QueryHints.html#BATCH_TYPE"><code>BATCH_TYPE</code></a>, |
| <a href="../../../../org/eclipse/persistence/annotations/BatchFetchType.html" title="enum in org.eclipse.persistence.annotations"><code>BatchFetchType</code></a>, |
| <a href="../../../../org/eclipse/persistence/annotations/BatchFetch.html" title="annotation in org.eclipse.persistence.annotations"><code>BatchFetch</code></a>, |
| <a href="../../../../org/eclipse/persistence/queries/ObjectLevelReadQuery.html#setBatchFetchSize-int-"><code>ObjectLevelReadQuery.setBatchFetchSize(int)</code></a>, |
| <a href="../../../../constant-values.html#org.eclipse.persistence.config.QueryHints.BATCH_SIZE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="FETCH"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>FETCH</h4> |
| <pre>public static final <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> FETCH</pre> |
| <div class="block">"eclipselink.join-fetch" |
| <p>Configures the query to optimize the retrieval of the related objects, |
| the related objects will be joined into the query instead of being queried independently. |
| This allow for nested join fetching which is not supported in JPQL. |
| It also allows for join fetching with native queries. |
| This uses an INNER join and will filter null or empty values, see LEFT_FETCH for outer joins. |
| Valid values are strings that represent JPQL style navigations to a relationship. |
| <p>e.g. e.manager.phoneNumbers</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/config/QueryHints.html#BATCH"><code>BATCH</code></a>, |
| <a href="../../../../org/eclipse/persistence/config/QueryHints.html#LEFT_FETCH"><code>LEFT_FETCH</code></a>, |
| <a href="../../../../org/eclipse/persistence/queries/ObjectLevelReadQuery.html#addJoinedAttribute-java.lang.String-"><code>ObjectLevelReadQuery.addJoinedAttribute(String)</code></a>, |
| <a href="../../../../constant-values.html#org.eclipse.persistence.config.QueryHints.FETCH">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="LEFT_FETCH"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>LEFT_FETCH</h4> |
| <pre>public static final <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> LEFT_FETCH</pre> |
| <div class="block">"eclipselink.left-join-fetch" |
| <p>Configures the query to optimize the retrieval of the related objects, |
| the related objects will be joined into the query instead of being queried independently. |
| This allow for nested join fetching which is not supported in JPQL. |
| It also allows for join fetching with native queries. |
| This uses an OUTER join to allow null or empty values. |
| Valid values are strings that represent JPQL style navigations to a relationship. |
| <p>e.g. e.manager.phoneNumbers</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/config/QueryHints.html#BATCH"><code>BATCH</code></a>, |
| <a href="../../../../org/eclipse/persistence/config/QueryHints.html#FETCH"><code>FETCH</code></a>, |
| <a href="../../../../org/eclipse/persistence/queries/ObjectLevelReadQuery.html#addJoinedAttribute-java.lang.String-"><code>ObjectLevelReadQuery.addJoinedAttribute(String)</code></a>, |
| <a href="../../../../constant-values.html#org.eclipse.persistence.config.QueryHints.LEFT_FETCH">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="READ_ONLY"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>READ_ONLY</h4> |
| <pre>public static final <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> READ_ONLY</pre> |
| <div class="block">"eclipselink.read-only" |
| <p>Configures the query to return shared (read-only) objects from the cache, |
| instead of objects registered with the persistence context. |
| This improves performance by avoiding the persistence context registration and change tracking overhead to read-only objects. |
| Valid values are: HintValues.FALSE, HintValues.TRUE, |
| "" could be used instead of default value HintValues.FALSE</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/queries/ObjectLevelReadQuery.html#setIsReadOnly-boolean-"><code>ObjectLevelReadQuery.setIsReadOnly(boolean)</code></a>, |
| <a href="../../../../constant-values.html#org.eclipse.persistence.config.QueryHints.READ_ONLY">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="JDBC_TIMEOUT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>JDBC_TIMEOUT</h4> |
| <pre>public static final <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> JDBC_TIMEOUT</pre> |
| <div class="block">"eclipselink.jdbc.timeout" |
| <p>Configures the JDBC timeout of the query execution, if the database query exceeds the timeout |
| the database will terminate the query and return an exception. |
| Valid values are Integer or Strings that can be parsed to int values.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setQueryTimeout-int-"><code>DatabaseQuery.setQueryTimeout(int)</code></a>, |
| <a href="../../../../constant-values.html#org.eclipse.persistence.config.QueryHints.JDBC_TIMEOUT">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="QUERY_TIMEOUT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>QUERY_TIMEOUT</h4> |
| <pre>public static final <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> QUERY_TIMEOUT</pre> |
| <div class="block">"jakarta.persistence.query.timeout" |
| <p>Configures the default query timeout value per the JPA specification. |
| Valid values are strings containing a zero or greater integer value |
| Defaults to use seconds as the unit of time.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setQueryTimeout-int-"><code>DatabaseQuery.setQueryTimeout(int)</code></a>, |
| <a href="../../../../constant-values.html#org.eclipse.persistence.config.QueryHints.QUERY_TIMEOUT">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="QUERY_TIMEOUT_UNIT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>QUERY_TIMEOUT_UNIT</h4> |
| <pre>public static final <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> QUERY_TIMEOUT_UNIT</pre> |
| <div class="block">"eclipselink.jdbc.timeout.unit" |
| <p>Configures the query timeout unit value. Allows users more refinement. |
| <b>Valid Values:</b> |
| <ul> |
| <li>"<code>java.util.concurrent.TimeUnit.MILLISECONDS</code>" (DEFAULT), |
| <li>"<code>java.util.concurrent.TimeUnit.SECONDS</code>", |
| <li>"<code>java.util.concurrent.TimeUnit.MINUTES</code>". |
| </ul></div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setQueryTimeoutUnit-java.util.concurrent.TimeUnit-"><code>DatabaseQuery.setQueryTimeoutUnit(TimeUnit)</code></a>, |
| <a href="../../../../constant-values.html#org.eclipse.persistence.config.QueryHints.QUERY_TIMEOUT_UNIT">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="JDBC_FETCH_SIZE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>JDBC_FETCH_SIZE</h4> |
| <pre>public static final <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> JDBC_FETCH_SIZE</pre> |
| <div class="block">"eclipselink.jdbc.fetch-size" |
| <p>Configures the JDBC fetch-size for the queries result-set. |
| This can improve the performance for queries that return large result-sets. |
| Valid values are Integer or Strings that can be parsed to int values.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/queries/ReadQuery.html#setFetchSize-int-"><code>ReadQuery.setFetchSize(int)</code></a>, |
| <a href="../../../../constant-values.html#org.eclipse.persistence.config.QueryHints.JDBC_FETCH_SIZE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="JDBC_MAX_ROWS"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>JDBC_MAX_ROWS</h4> |
| <pre>public static final <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> JDBC_MAX_ROWS</pre> |
| <div class="block">"eclipselink.jdbc.max-rows" |
| <p>Configures the JDBC max-rows, if the query returns more rows than the max-rows |
| the trailing rows will not be returned by the database. |
| This is the same as JPA Query setMaxResults(), but can be set in meta-data for NamedQuerys. |
| Valid values are Integer or Strings that can be parsed to int values.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><code>Query.setMaxResults(int)</code>, |
| <a href="../../../../org/eclipse/persistence/queries/ReadQuery.html#setMaxRows-int-"><code>ReadQuery.setMaxRows(int)</code></a>, |
| <a href="../../../../constant-values.html#org.eclipse.persistence.config.QueryHints.JDBC_MAX_ROWS">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="JDBC_FIRST_RESULT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>JDBC_FIRST_RESULT</h4> |
| <pre>public static final <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> JDBC_FIRST_RESULT</pre> |
| <div class="block">"eclipselink.jdbc.first-result" |
| <p>Configures the query to skip the firstResult number of rows. |
| This is the same as JPA Query setFirstResults(), but can be set in meta-data for NamedQuerys. |
| Valid values are Integer or Strings that can be parsed to int values.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><code>Query.setFirstResult(int)</code>, |
| <a href="../../../../org/eclipse/persistence/queries/ReadQuery.html#setFirstResult-int-"><code>ReadQuery.setFirstResult(int)</code></a>, |
| <a href="../../../../constant-values.html#org.eclipse.persistence.config.QueryHints.JDBC_FIRST_RESULT">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="RESULT_COLLECTION_TYPE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>RESULT_COLLECTION_TYPE</h4> |
| <pre>public static final <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> RESULT_COLLECTION_TYPE</pre> |
| <div class="block">"eclipselink.result-collection-type" |
| <p>Configures the collection class implementation for the queries result. |
| The fully qualified class name must be used, without the .class. |
| Valid values are a Class representing a collection type or a String representing the class' name |
| of the collection type. |
| If a Collection type that is not a List is used, getResultCollection() or getSingleResult() must be used instead of |
| getResultList(). |
| <p>e.g. "java.util.ArrayList"</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd>"org.eclipse.persistence.jpa.JpaQuery#getResultCollection()", |
| <a href="../../../../org/eclipse/persistence/queries/ReadAllQuery.html#useCollectionClass-java.lang.Class-"><code>ReadAllQuery.useCollectionClass(Class)</code></a>, |
| <a href="../../../../constant-values.html#org.eclipse.persistence.config.QueryHints.RESULT_COLLECTION_TYPE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="REFRESH_CASCADE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>REFRESH_CASCADE</h4> |
| <pre>public static final <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> REFRESH_CASCADE</pre> |
| <div class="block">"eclipselink.refresh.cascade" |
| <p>Defines if a refresh query should cascade the refresh to relationships. |
| Valid values are all declared in CascadePolicy class. |
| The REFRESH hint should also be set to cause a refresh.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/config/CascadePolicy.html" title="class in org.eclipse.persistence.config"><code>CascadePolicy</code></a>, |
| <a href="../../../../org/eclipse/persistence/config/QueryHints.html#REFRESH"><code>REFRESH</code></a>, |
| <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setCascadePolicy-int-"><code>DatabaseQuery.setCascadePolicy(int)</code></a>, |
| <a href="../../../../constant-values.html#org.eclipse.persistence.config.QueryHints.REFRESH_CASCADE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="MAINTAIN_CACHE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>MAINTAIN_CACHE</h4> |
| <pre>public static final <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> MAINTAIN_CACHE</pre> |
| <div class="block">"eclipselink.maintain-cache" |
| <p>Configures the query to not use both the shared cache, and the transactional cache/persistence context. |
| Resulting objects will be read and built directly from the database, and not registered in the persistence context. |
| Changes made to the objects will not be updated unless merged, object identity will not be maintained. |
| This can be used to read the current state of the database, without affecting the current persistence context. |
| By default the cache is always maintained. |
| Valid values are: HintValues.FALSE, HintValues.TRUE, |
| "" could be used instead of default value HintValues.FALSE</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setShouldMaintainCache-boolean-"><code>DatabaseQuery.setShouldMaintainCache(boolean)</code></a>, |
| <a href="../../../../constant-values.html#org.eclipse.persistence.config.QueryHints.MAINTAIN_CACHE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="PREPARE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>PREPARE</h4> |
| <pre>public static final <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> PREPARE</pre> |
| <div class="block">"eclipselink.prepare" |
| <p>Configures the query to not prepare its SQL. |
| By default queries generate their SQL the first time they are executed, |
| and avoid the cost of generating the SQL on subsequent executions. |
| This can be used to generate the SQL on every execution if the |
| query requires usage of dynamic SQL, such as to handle null parameters (use IS NULL instead of = null). |
| This only effects the SQL generation, not parameter binding or statement caching. |
| Valid values are: HintValues.FALSE, HintValues.TRUE, |
| "" could be used instead of default value HintValues.FALSE</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setShouldPrepare-boolean-"><code>DatabaseQuery.setShouldPrepare(boolean)</code></a>, |
| <a href="../../../../constant-values.html#org.eclipse.persistence.config.QueryHints.PREPARE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="CACHE_STATMENT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>CACHE_STATMENT</h4> |
| <pre>public static final <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> CACHE_STATMENT</pre> |
| <div class="block">"eclipselink.jdbc.cache-statement" |
| <p>Configures if the query will cache its JDBC statement. |
| This allows queries to use parameterized SQL with statement caching. |
| It also allows a specific query to not cache its statement, |
| if statement caching is enable for the persistence unit. |
| If statement caching is desired, it should normally be set for the entire persistence unit |
| in the persistence.xml, not in each query. |
| If a DataSource is used statement caching must be set in the DataSource configuration, |
| not in EclipseLink. |
| Valid values are: HintValues.FALSE, HintValues.TRUE, |
| "" could be used instead of default value HintValues.FALSE</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/config/PersistenceUnitProperties.html#CACHE_STATEMENTS"><code>PersistenceUnitProperties.CACHE_STATEMENTS</code></a>, |
| <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setShouldCacheStatement-boolean-"><code>DatabaseQuery.setShouldCacheStatement(boolean)</code></a>, |
| <a href="../../../../constant-values.html#org.eclipse.persistence.config.QueryHints.CACHE_STATMENT">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="FLUSH"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>FLUSH</h4> |
| <pre>public static final <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> FLUSH</pre> |
| <div class="block">"eclipselink.flush" |
| <p>Configures if the query should trigger a flush of the persistence context before execution. |
| If the query may access objects that have been changed in the persistence context, |
| trigger a flush is required for the query to see these changes. |
| If the query does not require seeing the changes, then avoid the flush can improve performance. |
| The default flush-mode can be set on the EntityManager or configured as a persistence unit property. |
| By default the flush-mode is AUTO, which requires a flush before any query execution. |
| Conforming can also be used to query changes without requiring a flush, |
| refer to the CACHE_USAGE query hint for conforming. |
| Valid values are: HintValues.FALSE, HintValues.TRUE, |
| "" could be used instead of default value HintValues.FALSE</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><code>EntityManager.setFlushMode(jakarta.persistence.FlushModeType)</code>, |
| <a href="../../../../org/eclipse/persistence/config/PersistenceUnitProperties.html#PERSISTENCE_CONTEXT_FLUSH_MODE"><code>PersistenceUnitProperties.PERSISTENCE_CONTEXT_FLUSH_MODE</code></a>, |
| <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setFlushOnExecute-java.lang.Boolean-"><code>DatabaseQuery.setFlushOnExecute(Boolean)</code></a>, |
| <a href="../../../../constant-values.html#org.eclipse.persistence.config.QueryHints.FLUSH">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="HINT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>HINT</h4> |
| <pre>public static final <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> HINT</pre> |
| <div class="block">"eclipselink.sql.hint" |
| <p> |
| Sets a SQL hint string into the query that will be generated into the SQL statement after |
| the SELECT/INSERT/UPDATE/DELETE command. |
| <p> |
| A SQL hint can be used on certain database platforms to define how the query uses indexes |
| and other such low level usages. This should be the full hint string including the comment \ |
| delimiters.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setHintString-java.lang.String-"><code>DatabaseQuery.setHintString(String)</code></a>, |
| <a href="../../../../constant-values.html#org.eclipse.persistence.config.QueryHints.HINT">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="NATIVE_CONNECTION"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>NATIVE_CONNECTION</h4> |
| <pre>public static final <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> NATIVE_CONNECTION</pre> |
| <div class="block">"eclipselink.jdbc.native-connection" |
| <p>Configures if the query requires a native JDBC connection. |
| This may be required for some queries on some server platforms that |
| have DataSource implementations that wrap the JDBC connection in their own proxy. |
| If the query requires custom JDBC access, it may require a native connection. |
| A ServerPlatform is required to be set as a persistence property to be able to use a native connection. |
| For features that are known by EclipseLink to require native connections this |
| will default to true, otherwise is false. |
| Valid values are: HintValues.FALSE, HintValues.TRUE, |
| "" could be used instead of default value HintValues.FALSE</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/config/PersistenceUnitProperties.html#TARGET_SERVER"><code>PersistenceUnitProperties.TARGET_SERVER</code></a>, |
| <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setIsNativeConnectionRequired-boolean-"><code>DatabaseQuery.setIsNativeConnectionRequired(boolean)</code></a>, |
| <a href="../../../../constant-values.html#org.eclipse.persistence.config.QueryHints.NATIVE_CONNECTION">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="CURSOR"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>CURSOR</h4> |
| <pre>public static final <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> CURSOR</pre> |
| <div class="block">"eclipselink.cursor" |
| <p>Configures the query to return a CursoredStream. |
| A cursor is a stream of the JDBC ResultSet. |
| Cursor implements Enumeration, when the each next() will fetch the next from the JDBC ResultSet, |
| and build the resulting Object or value. |
| A Cursor requires and will keep a live JDBC connection, close() must be called |
| to free the Cursor's resources. |
| A Cursor can be accessed from a JPA Query through getSingleResult(), or from JpaQuery using getResultCursor(). |
| Cursors are useful for large results sets, and if only the first few results are desired. |
| MAX_ROWS and FIRST_RESULT can also be used instead of cursors to obtain a page of results. |
| Valid values are: HintValues.FALSE, HintValues.TRUE, |
| "" could be used instead of default value HintValues.FALSE</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd>"org.eclipse.persistence.jpa.JpaQuery#getSingleResult()", |
| "org.eclipse.persistence.jpa.JpaQuery#getResultCursor()", |
| <a href="../../../../org/eclipse/persistence/queries/Cursor.html" title="class in org.eclipse.persistence.queries"><code>Cursor</code></a>, |
| <a href="../../../../org/eclipse/persistence/queries/CursoredStream.html" title="class in org.eclipse.persistence.queries"><code>CursoredStream</code></a>, |
| <a href="../../../../org/eclipse/persistence/queries/ReadAllQuery.html#useCursoredStream--"><code>ReadAllQuery.useCursoredStream()</code></a>, |
| <a href="../../../../constant-values.html#org.eclipse.persistence.config.QueryHints.CURSOR">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="CURSOR_INITIAL_SIZE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>CURSOR_INITIAL_SIZE</h4> |
| <pre>public static final <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> CURSOR_INITIAL_SIZE</pre> |
| <div class="block">"eclipselink.cursor.initial-size" |
| <p>Configures the query to return a CursoredStream with the initial threshold size. |
| The initial size is the initial number of objects that are prebuilt for the stream before a next() is called. |
| Valid values are Integer or Strings that can be parsed to int values.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/queries/ReadAllQuery.html#useCursoredStream-int-int-"><code>ReadAllQuery.useCursoredStream(int, int)</code></a>, |
| <a href="../../../../constant-values.html#org.eclipse.persistence.config.QueryHints.CURSOR_INITIAL_SIZE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="CURSOR_PAGE_SIZE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>CURSOR_PAGE_SIZE</h4> |
| <pre>public static final <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> CURSOR_PAGE_SIZE</pre> |
| <div class="block">"eclipselink.cursor.page-size" |
| <p>Configures the query to return a CursoredStream with the page size. |
| The page size is the number of objects that are fetched from the stream on a next() called, |
| if the buffer of objects is empty. |
| Valid values are Integer or Strings that can be parsed to int values.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/queries/ReadAllQuery.html#useCursoredStream-int-int-"><code>ReadAllQuery.useCursoredStream(int, int)</code></a>, |
| <a href="../../../../constant-values.html#org.eclipse.persistence.config.QueryHints.CURSOR_PAGE_SIZE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="CURSOR_SIZE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>CURSOR_SIZE</h4> |
| <pre>public static final <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> CURSOR_SIZE</pre> |
| <div class="block">"eclipselink.cursor.size-sql" |
| <p>Configures the SQL string for the size query of a Cursor query. |
| This is only required for cursor queries that use native SQL or procedures. |
| The size query is only used if the size() is called on the Cursor. |
| The SQL should perform a COUNT of the rows returned by the original query.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/config/QueryHints.html#CURSOR"><code>CURSOR</code></a>, |
| <a href="../../../../org/eclipse/persistence/queries/Cursor.html#size--"><code>Cursor.size()</code></a>, |
| <a href="../../../../org/eclipse/persistence/queries/ReadAllQuery.html#useCursoredStream-int-int-org.eclipse.persistence.queries.ValueReadQuery-"><code>ReadAllQuery.useCursoredStream(int, int, org.eclipse.persistence.queries.ValueReadQuery)</code></a>, |
| <a href="../../../../constant-values.html#org.eclipse.persistence.config.QueryHints.CURSOR_SIZE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="SCROLLABLE_CURSOR"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SCROLLABLE_CURSOR</h4> |
| <pre>public static final <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> SCROLLABLE_CURSOR</pre> |
| <div class="block">"eclipselink.cursor.scrollable" |
| <p>Configures the query to return a ScrollableCursor. |
| A cursor is a stream of the JDBC ResultSet. |
| ScrollableCursor implements ListIterator, when the each next() will fetch the next from the JDBC ResultSet, |
| and build the resulting Object or value. |
| ScrollableCursor can scroll forwards and backwards and position into the ResultSet. |
| A Cursor requires and will keep a live JDBC connection, close() must be called |
| to free the Cursor's resources. |
| A Cursor can be accessed from a JPA Query through getSingleResult(), or from JpaQuery using getResultCursor(). |
| Cursors are useful for large results sets, and if only some of the results are desired. |
| MAX_ROWS and FIRST_RESULT can also be used instead of cursors to obtain a page of results. |
| Valid values are: HintValues.FALSE, HintValues.TRUE, |
| "" could be used instead of default value HintValues.FALSE</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd>"org.eclipse.persistence.jpa.JpaQuery#getSingleResult()", |
| "org.eclipse.persistence.jpa.JpaQuery#getResultCursor()", |
| <a href="../../../../org/eclipse/persistence/queries/Cursor.html" title="class in org.eclipse.persistence.queries"><code>Cursor</code></a>, |
| <a href="../../../../org/eclipse/persistence/queries/ScrollableCursor.html" title="class in org.eclipse.persistence.queries"><code>ScrollableCursor</code></a>, |
| <a href="../../../../org/eclipse/persistence/queries/ReadAllQuery.html#useScrollableCursor--"><code>ReadAllQuery.useScrollableCursor()</code></a>, |
| <a href="../../../../constant-values.html#org.eclipse.persistence.config.QueryHints.SCROLLABLE_CURSOR">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="RESULT_SET_TYPE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>RESULT_SET_TYPE</h4> |
| <pre>public static final <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> RESULT_SET_TYPE</pre> |
| <div class="block">"eclipselink.cursor.scrollable.result-set-type" |
| <p>This can be used on ScrollableCursor queries to set the JDBC ResultSet scroll type.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/config/ResultSetType.html" title="class in org.eclipse.persistence.config"><code>ResultSetType</code></a>, |
| <a href="../../../../org/eclipse/persistence/config/QueryHints.html#SCROLLABLE_CURSOR"><code>SCROLLABLE_CURSOR</code></a>, |
| <a href="../../../../org/eclipse/persistence/queries/ScrollableCursorPolicy.html#setResultSetType-int-"><code>ScrollableCursorPolicy.setResultSetType(int)</code></a>, |
| <a href="../../../../constant-values.html#org.eclipse.persistence.config.QueryHints.RESULT_SET_TYPE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="RESULT_SET_CONCURRENCY"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>RESULT_SET_CONCURRENCY</h4> |
| <pre>public static final <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> RESULT_SET_CONCURRENCY</pre> |
| <div class="block">"eclipselink.cursor.scrollable.result-set-concurrency" |
| <p>This can be used on ScrollableCursor queries to set the JDBC ResultSet concurrency.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/config/ResultSetConcurrency.html" title="class in org.eclipse.persistence.config"><code>ResultSetConcurrency</code></a>, |
| <a href="../../../../org/eclipse/persistence/config/QueryHints.html#SCROLLABLE_CURSOR"><code>SCROLLABLE_CURSOR</code></a>, |
| <a href="../../../../org/eclipse/persistence/queries/ScrollableCursorPolicy.html#setResultSetConcurrency-int-"><code>ScrollableCursorPolicy.setResultSetConcurrency(int)</code></a>, |
| <a href="../../../../constant-values.html#org.eclipse.persistence.config.QueryHints.RESULT_SET_CONCURRENCY">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="FETCH_GROUP"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>FETCH_GROUP</h4> |
| <pre>public static final <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> FETCH_GROUP</pre> |
| <div class="block">"eclipselink.fetch-group" |
| <p>Configures the query to use the fetch group object. |
| This is an instance of FetchGroup. |
| The query will only fetch the attributes defined in the fetch group, if any other attribute is accessed |
| it will cause the object to be refreshed. |
| To load all FetchGroup's relationship attributes set the FetchGroup's boolean flag "shouldLoad" to true. |
| FetchGroups are only supported for queries returning objects (only a single alias can be the select clause). |
| Weaving is required to allow usage of fetch groups.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/config/QueryHints.html#FETCH_GROUP_NAME"><code>FETCH_GROUP_NAME</code></a>, |
| <a href="../../../../org/eclipse/persistence/config/QueryHints.html#FETCH_GROUP_ATTRIBUTE"><code>FETCH_GROUP_ATTRIBUTE</code></a>, |
| <a href="../../../../org/eclipse/persistence/config/QueryHints.html#FETCH_GROUP_DEFAULT"><code>FETCH_GROUP_DEFAULT</code></a>, |
| <a href="../../../../org/eclipse/persistence/config/QueryHints.html#LOAD_GROUP"><code>LOAD_GROUP</code></a>, |
| <a href="../../../../org/eclipse/persistence/queries/FetchGroup.html" title="class in org.eclipse.persistence.queries"><code>FetchGroup</code></a>, |
| <a href="../../../../org/eclipse/persistence/queries/FetchGroup.html#setShouldLoad-boolean-"><code>FetchGroup.setShouldLoad(boolean)</code></a>, |
| <a href="../../../../org/eclipse/persistence/descriptors/FetchGroupManager.html" title="class in org.eclipse.persistence.descriptors"><code>FetchGroupManager</code></a>, |
| <a href="../../../../org/eclipse/persistence/queries/ObjectLevelReadQuery.html#setFetchGroup-org.eclipse.persistence.queries.FetchGroup-"><code>ObjectLevelReadQuery.setFetchGroup(org.eclipse.persistence.queries.FetchGroup)</code></a>, |
| <a href="../../../../constant-values.html#org.eclipse.persistence.config.QueryHints.FETCH_GROUP">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="FETCH_GROUP_NAME"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>FETCH_GROUP_NAME</h4> |
| <pre>public static final <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> FETCH_GROUP_NAME</pre> |
| <div class="block">"eclipselink.fetch-group.name" |
| <p>Configures the query to use a named fetch group defined for the result class. |
| This is the name of the fetch group, as defined on the ClassDescriptor. |
| Currently FetchGroups can only be defined on the ClassDescriptor using a DescriptorCustomizer. |
| The query will only fetch the attributes defined in the fetch group, if any other attribute is accessed |
| it will cause the object to be refreshed. |
| To load all FetchGroup's relationship attributes set the FetchGroup's boolean flag "load" to true. |
| FetchGroups are only supported for queries returning objects (only a single alias can be the select clause). |
| Weaving is required to allow usage of fetch groups.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/config/QueryHints.html#FETCH_GROUP_ATTRIBUTE"><code>FETCH_GROUP_ATTRIBUTE</code></a>, |
| <a href="../../../../org/eclipse/persistence/config/QueryHints.html#FETCH_GROUP_DEFAULT"><code>FETCH_GROUP_DEFAULT</code></a>, |
| <a href="../../../../org/eclipse/persistence/config/QueryHints.html#LOAD_GROUP"><code>LOAD_GROUP</code></a>, |
| <a href="../../../../org/eclipse/persistence/descriptors/FetchGroupManager.html" title="class in org.eclipse.persistence.descriptors"><code>FetchGroupManager</code></a>, |
| <a href="../../../../org/eclipse/persistence/queries/FetchGroup.html" title="class in org.eclipse.persistence.queries"><code>FetchGroup</code></a>, |
| <a href="../../../../org/eclipse/persistence/queries/ObjectLevelReadQuery.html#setFetchGroupName-java.lang.String-"><code>ObjectLevelReadQuery.setFetchGroupName(String)</code></a>, |
| <a href="../../../../constant-values.html#org.eclipse.persistence.config.QueryHints.FETCH_GROUP_NAME">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="FETCH_GROUP_ATTRIBUTE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>FETCH_GROUP_ATTRIBUTE</h4> |
| <pre>public static final <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> FETCH_GROUP_ATTRIBUTE</pre> |
| <div class="block">"eclipselink.fetch-group.attribute" |
| <p>Configures the query to use a dynamic fetch group that includes a list of attributes. |
| Each attribute must be defined using a separate hint. |
| The primary key and version are always included. |
| The query will only fetch the attributes defined in the fetch group, if any other attribute is accessed |
| it will cause the object to be refreshed. |
| To load all FetchGroup's relationship attributes set FETCH_GROUP_LOAD to "true". |
| FetchGroups are only supported for queries returning objects (only a single alias can be the select clause). |
| Weaving is required to allow usage of fetch groups. |
| Both local and nested attributes are supported.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/config/QueryHints.html#FETCH_GROUP_NAME"><code>FETCH_GROUP_NAME</code></a>, |
| <a href="../../../../org/eclipse/persistence/config/QueryHints.html#FETCH_GROUP_DEFAULT"><code>FETCH_GROUP_DEFAULT</code></a>, |
| <a href="../../../../org/eclipse/persistence/config/QueryHints.html#FETCH_GROUP_LOAD"><code>FETCH_GROUP_LOAD</code></a>, |
| <a href="../../../../org/eclipse/persistence/config/QueryHints.html#LOAD_GROUP"><code>LOAD_GROUP</code></a>, |
| <a href="../../../../org/eclipse/persistence/queries/FetchGroup.html" title="class in org.eclipse.persistence.queries"><code>FetchGroup</code></a>, |
| <a href="../../../../org/eclipse/persistence/queries/ObjectLevelReadQuery.html#setFetchGroup-org.eclipse.persistence.queries.FetchGroup-"><code>ObjectLevelReadQuery.setFetchGroup(org.eclipse.persistence.queries.FetchGroup)</code></a>, |
| <a href="../../../../constant-values.html#org.eclipse.persistence.config.QueryHints.FETCH_GROUP_ATTRIBUTE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="FETCH_GROUP_LOAD"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>FETCH_GROUP_LOAD</h4> |
| <pre>public static final <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> FETCH_GROUP_LOAD</pre> |
| <div class="block">"eclipselink.fetch-group.load" |
| <p>Configures a dynamic fetch group to load (default) or not to load its attributes. |
| Could be used with FETCH_ATTRIBUTES hint. |
| To load all FetchGroup's relationship attributes set this hint to "true". |
| Weaving is required to allow usage of fetch groups. |
| Valid values are: HintValues.FALSE, HintValues.TRUE, |
| "" could be used instead of default value HintValues.TRUE</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/config/QueryHints.html#FETCH_GROUP_ATTRIBUTE"><code>FETCH_GROUP_ATTRIBUTE</code></a>, |
| <a href="../../../../org/eclipse/persistence/queries/FetchGroup.html" title="class in org.eclipse.persistence.queries"><code>FetchGroup</code></a>, |
| <a href="../../../../org/eclipse/persistence/queries/FetchGroup.html#setShouldLoad-boolean-"><code>FetchGroup.setShouldLoad(boolean)</code></a>, |
| <a href="../../../../constant-values.html#org.eclipse.persistence.config.QueryHints.FETCH_GROUP_LOAD">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="JPA_FETCH_GRAPH"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>JPA_FETCH_GRAPH</h4> |
| <pre>public static final <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> JPA_FETCH_GRAPH</pre> |
| <div class="block">"jakarta.persistence.fetchgraph" |
| <p> Configures a jpa entity graph to be used as a fetch graph template. |
| Those attributes included in the entity graph will have their values fetched and populated. |
| Attributes of the represented entity that are not present in the entity graph will be treated |
| as FetchType.LAZY.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.eclipse.persistence.config.QueryHints.JPA_FETCH_GRAPH">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="FETCH_GROUP_DEFAULT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>FETCH_GROUP_DEFAULT</h4> |
| <pre>public static final <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> FETCH_GROUP_DEFAULT</pre> |
| <div class="block">"eclipselink.fetch-group.default" |
| <p>Configures the query not to use the default fetch group. |
| The default fetch group is defined by all non-lazy Basic mappings. |
| If set to FALSE all attributes will be fetched, including lazy Basics, |
| this still excludes lazy relationships, they will fetch their foreign keys, but not their values. |
| FetchGroups are only supported for queries returning objects (only a single alias can be the select clause). |
| Weaving is required to allow usage of fetch groups. |
| Valid values are: HintValues.FALSE, HintValues.TRUE, |
| "" could be used instead of default value HintValues.TRUE</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/config/QueryHints.html#FETCH_GROUP_NAME"><code>FETCH_GROUP_NAME</code></a>, |
| <a href="../../../../org/eclipse/persistence/config/QueryHints.html#FETCH_GROUP_ATTRIBUTE"><code>FETCH_GROUP_ATTRIBUTE</code></a>, |
| <a href="../../../../org/eclipse/persistence/queries/FetchGroup.html" title="class in org.eclipse.persistence.queries"><code>FetchGroup</code></a>, |
| <a href="../../../../org/eclipse/persistence/queries/ObjectLevelReadQuery.html#setShouldUseDefaultFetchGroup-boolean-"><code>ObjectLevelReadQuery.setShouldUseDefaultFetchGroup(boolean)</code></a>, |
| <a href="../../../../constant-values.html#org.eclipse.persistence.config.QueryHints.FETCH_GROUP_DEFAULT">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="LOAD_GROUP"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>LOAD_GROUP</h4> |
| <pre>public static final <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> LOAD_GROUP</pre> |
| <div class="block">"eclipselink.load-group" |
| <p>Configures the query to use the load group object. |
| This is an instance of LoadGroup. |
| Ensures that all relational attributes an the group are loaded. |
| LoadGroups are only supported for queries returning objects (only a single alias can be the select clause).</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/config/QueryHints.html#LOAD_GROUP_ATTRIBUTE"><code>LOAD_GROUP_ATTRIBUTE</code></a>, |
| <a href="../../../../org/eclipse/persistence/queries/LoadGroup.html" title="class in org.eclipse.persistence.queries"><code>LoadGroup</code></a>, |
| <a href="../../../../org/eclipse/persistence/queries/ObjectLevelReadQuery.html#setLoadGroup-org.eclipse.persistence.queries.LoadGroup-"><code>ObjectLevelReadQuery.setLoadGroup(org.eclipse.persistence.queries.LoadGroup)</code></a>, |
| <a href="../../../../constant-values.html#org.eclipse.persistence.config.QueryHints.LOAD_GROUP">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="JPA_LOAD_GRAPH"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>JPA_LOAD_GRAPH</h4> |
| <pre>public static final <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> JPA_LOAD_GRAPH</pre> |
| <div class="block">"jakarta.persistence.loadgraph" |
| <p> Configures a jpa entity graph to be used as a load graph template. |
| Those attributes included in the entity graph will have their values fetched and populated. |
| Attributes of the represented entity that are not present in the entity graph will be loaded based |
| on their mapping based FetchType settings.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.eclipse.persistence.config.QueryHints.JPA_LOAD_GRAPH">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="LOAD_GROUP_ATTRIBUTE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>LOAD_GROUP_ATTRIBUTE</h4> |
| <pre>public static final <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> LOAD_GROUP_ATTRIBUTE</pre> |
| <div class="block">"eclipselink.load-group.attribute" |
| <p>Configures the query to use load group that includes a list of attributes. |
| Each attribute must be defined using a separate hint. |
| The query will load all relational attributes defined in the load group. |
| LoadGroups are only supported for queries returning objects (only a single alias can be the select clause). |
| Both local and nested attributes are supported.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/config/QueryHints.html#LOAD_GROUP"><code>LOAD_GROUP</code></a>, |
| <a href="../../../../org/eclipse/persistence/queries/LoadGroup.html" title="class in org.eclipse.persistence.queries"><code>LoadGroup</code></a>, |
| <a href="../../../../org/eclipse/persistence/queries/ObjectLevelReadQuery.html#setLoadGroup-org.eclipse.persistence.queries.LoadGroup-"><code>ObjectLevelReadQuery.setLoadGroup(org.eclipse.persistence.queries.LoadGroup)</code></a>, |
| <a href="../../../../constant-values.html#org.eclipse.persistence.config.QueryHints.LOAD_GROUP_ATTRIBUTE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="EXCLUSIVE_CONNECTION"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>EXCLUSIVE_CONNECTION</h4> |
| <pre>public static final <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> EXCLUSIVE_CONNECTION</pre> |
| <div class="block">"eclipselink.exclusive-connection" |
| <p>Configures the query to use the exclusive (transactional/write) connection. |
| This is only relevant if a EXCLUSIVE_CONNECTION_MODE property has been set for the persistence unit (such as VPD). |
| If an EXCLUSIVE_CONNECTION_MODE has been configured, |
| this will ensure that the query is executed through the exclusive connection. |
| This may be required in certain cases. An example being |
| where database security will prevent a query joining to a secure table |
| from returning the correct results when executed through the shared |
| connection. |
| Valid values are: HintValues.FALSE, HintValues.TRUE.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/config/PersistenceUnitProperties.html#EXCLUSIVE_CONNECTION_MODE"><code>PersistenceUnitProperties.EXCLUSIVE_CONNECTION_MODE</code></a>, |
| <a href="../../../../org/eclipse/persistence/sessions/server/ConnectionPolicy.html#setExclusiveMode-org.eclipse.persistence.sessions.server.ConnectionPolicy.ExclusiveMode-"><code>ConnectionPolicy.setExclusiveMode(org.eclipse.persistence.sessions.server.ConnectionPolicy.ExclusiveMode)</code></a>, |
| <a href="../../../../org/eclipse/persistence/queries/ObjectBuildingQuery.html#setShouldUseExclusiveConnection-boolean-"><code>ObjectBuildingQuery.setShouldUseExclusiveConnection(boolean)</code></a>, |
| <a href="../../../../constant-values.html#org.eclipse.persistence.config.QueryHints.EXCLUSIVE_CONNECTION">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="INHERITANCE_OUTER_JOIN"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>INHERITANCE_OUTER_JOIN</h4> |
| <pre>public static final <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> INHERITANCE_OUTER_JOIN</pre> |
| <div class="block">"eclipselink.inheritance.outer-join" |
| <p>Configures the query to outer-join all subclasses. |
| This is only relevant for queries to root or branch inherited classes. |
| By default a separate query is executed for each subclass. |
| This can also be configured for the class using a DescriptorCustomizer. |
| This is required for correct ordering, firstResult, maxResult, and cursors. |
| Valid values are: HintValues.FALSE, HintValues.TRUE.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/descriptors/InheritancePolicy.html#setShouldOuterJoinSubclasses-boolean-"><code>InheritancePolicy.setShouldOuterJoinSubclasses(boolean)</code></a>, |
| <a href="../../../../org/eclipse/persistence/queries/ObjectLevelReadQuery.html#setShouldOuterJoinSubclasses-boolean-"><code>ObjectLevelReadQuery.setShouldOuterJoinSubclasses(boolean)</code></a>, |
| <a href="../../../../constant-values.html#org.eclipse.persistence.config.QueryHints.INHERITANCE_OUTER_JOIN">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="ALLOW_NATIVE_SQL_QUERY"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ALLOW_NATIVE_SQL_QUERY</h4> |
| <pre>public static final <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> ALLOW_NATIVE_SQL_QUERY</pre> |
| <div class="block">The <code>"eclipselink.jdbc.allow-native-sql-query"</code> property |
| specifies whether a single native SQL query should override a persistence |
| unit level setting (eclipselink.jdbc.allow-native-sql-queries). The PU |
| level flag is of particular importance within a multitenant to minimize |
| the potential impact of revealing multitenant. However in some cases the |
| application may need to allow certain native SQL queries through. |
| <p> |
| Allowed Values (String): |
| <ul> |
| <li>"true" - allow native SQL (and override the persistence unit flag) |
| <li>"false" - (DEFAULT) do not allow native SQL (and respect the persistence unit flag if set.) |
| </ul></div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setAllowNativeSQLQuery-java.lang.Boolean-"><code>{</code></a>, |
| <a href="../../../../constant-values.html#org.eclipse.persistence.config.QueryHints.ALLOW_NATIVE_SQL_QUERY">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="AS_OF"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>AS_OF</h4> |
| <pre>public static final <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> AS_OF</pre> |
| <div class="block">"eclipselink.history.as-of" |
| <p>Configures the query to query the state of the object as-of a point in time. |
| This can only be used if the class has been configured with historical support, |
| or if Oracle Flashback is used. |
| Valid values are timestamps in the form "YYYY/MM/DD HH:MM:SS.n".</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/history/HistoryPolicy.html" title="class in org.eclipse.persistence.history"><code>HistoryPolicy</code></a>, |
| <a href="../../../../org/eclipse/persistence/queries/ObjectLevelReadQuery.html#setAsOfClause-org.eclipse.persistence.history.AsOfClause-"><code>ObjectLevelReadQuery.setAsOfClause(org.eclipse.persistence.history.AsOfClause)</code></a>, |
| <a href="../../../../constant-values.html#org.eclipse.persistence.config.QueryHints.AS_OF">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="AS_OF_SCN"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>AS_OF_SCN</h4> |
| <pre>public static final <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> AS_OF_SCN</pre> |
| <div class="block">"eclipselink.history.as-of.scn" |
| <p>Configures the query to query the state of the object as-of a database SCN (System Change Number). |
| This can only be used with Oracle Flashback support. |
| Valid values are Integer SCN values.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/queries/ObjectLevelReadQuery.html#setAsOfClause-org.eclipse.persistence.history.AsOfClause-"><code>ObjectLevelReadQuery.setAsOfClause(org.eclipse.persistence.history.AsOfClause)</code></a>, |
| <a href="../../../../constant-values.html#org.eclipse.persistence.config.QueryHints.AS_OF_SCN">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="RESULT_TYPE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>RESULT_TYPE</h4> |
| <pre>public static final <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> RESULT_TYPE</pre> |
| <div class="block">"eclipselink.result-type" |
| <p> By default in JPA for non-single select queries an Array of values is returned. |
| If getSingleResult() is called the first array is returned, for getResultList() a List of arrays is returned. |
| <p>i.e. "Select e.firstName, e.lastName from Employee e" returns List<Object[]> |
| <p>or the native query, "SELECT * FROM EMPLOYEE" returns List<Object[]> |
| <p>The ResultType can be used to instead return a Map of values (DatabaseRecord, ReportQueryResult). |
| <p>It can also be used to return a single column, or single value. |
| Valid values are defined in ResultType.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/config/ResultType.html" title="class in org.eclipse.persistence.config"><code>ResultType</code></a>, |
| <a href="../../../../org/eclipse/persistence/sessions/Record.html" title="interface in org.eclipse.persistence.sessions"><code>Record</code></a>, |
| <a href="../../../../org/eclipse/persistence/sessions/DatabaseRecord.html" title="class in org.eclipse.persistence.sessions"><code>DatabaseRecord</code></a>, |
| <a href="../../../../org/eclipse/persistence/queries/ReportQueryResult.html" title="class in org.eclipse.persistence.queries"><code>ReportQueryResult</code></a>, |
| <a href="../../../../org/eclipse/persistence/queries/ReportQuery.html#setReturnType-int-"><code>ReportQuery.setReturnType(int)</code></a>, |
| <a href="../../../../org/eclipse/persistence/queries/DataReadQuery.html#setResultType-int-"><code>DataReadQuery.setResultType(int)</code></a>, |
| <a href="../../../../constant-values.html#org.eclipse.persistence.config.QueryHints.RESULT_TYPE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="INDIRECTION_POLICY"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>INDIRECTION_POLICY</h4> |
| <pre>public static final <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> INDIRECTION_POLICY</pre> |
| <div class="block">"eclipselink.cache-usage.indirection-policy" |
| <p>This can be used on a query with a CACHE_USAGE hint to configure the behavior of in-memory |
| querying and conforming's treatment of uninstantiated indirection/lazy relationships. |
| This is only relevant when the query traverses a join across a lazy relationship. |
| Valid values are defined in CacheUsageIndirectionPolicy.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/config/CacheUsageIndirectionPolicy.html" title="class in org.eclipse.persistence.config"><code>CacheUsageIndirectionPolicy</code></a>, |
| <a href="../../../../org/eclipse/persistence/config/QueryHints.html#CACHE_USAGE"><code>CACHE_USAGE</code></a>, |
| <a href="../../../../org/eclipse/persistence/queries/ObjectLevelReadQuery.html#setInMemoryQueryIndirectionPolicyState-int-"><code>ObjectLevelReadQuery.setInMemoryQueryIndirectionPolicyState(int)</code></a>, |
| <a href="../../../../constant-values.html#org.eclipse.persistence.config.QueryHints.INDIRECTION_POLICY">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="PESSIMISTIC_LOCK_SCOPE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>PESSIMISTIC_LOCK_SCOPE</h4> |
| <pre>public static final <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> PESSIMISTIC_LOCK_SCOPE</pre> |
| <div class="block">"jakarta.persistence.lock.scope" |
| <p> By default pessimistic lock applied to only the tables mapped to the object being locked. |
| <p> It could be extended to apply also to relation (join) tables (ManyToMany and OneToOne case), |
| and CollectionTables (ElementCollection case). |
| Valid values are defined in PessimisticLockScope.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><code>PessimisticLockScope</code>, |
| <code>LockModeType</code>, |
| <a href="../../../../constant-values.html#org.eclipse.persistence.config.QueryHints.PESSIMISTIC_LOCK_SCOPE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="COMPOSITE_UNIT_MEMBER"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>COMPOSITE_UNIT_MEMBER</h4> |
| <pre>public static final <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> COMPOSITE_UNIT_MEMBER</pre> |
| <div class="block">"eclipselink.composite-unit.member" |
| <p>This must be used on a native query executed on composite persistence unit. |
| It specifies the name of composite member persistence unit to execute the query on.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setSessionName-java.lang.String-"><code>DatabaseQuery.setSessionName(String)</code></a>, |
| <a href="../../../../constant-values.html#org.eclipse.persistence.config.QueryHints.COMPOSITE_UNIT_MEMBER">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="BATCH_WRITING"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>BATCH_WRITING</h4> |
| <pre>public static final <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> BATCH_WRITING</pre> |
| <div class="block">"eclipselink.jdbc.batch-writing" |
| <p>Configures if this modify query can be batched through batch writing. |
| Some types of queries cannot be batched, such as DDL on some databases. |
| Disabling batch writing will also allow the row count to be returned. |
| Valid values are: HintValues.PERSISTENCE_UNIT_DEFAULT, HintValues.TRUE, HintValues.FALSE, |
| "" could be used instead of default value HintValues.PERSISTENCE_UNIT_DEFAULT</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/queries/ModifyQuery.html#setIsBatchExecutionSupported-boolean-"><code>ModifyQuery.setIsBatchExecutionSupported(boolean)</code></a>, |
| <a href="../../../../constant-values.html#org.eclipse.persistence.config.QueryHints.BATCH_WRITING">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="RESULT_SET_ACCESS"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>RESULT_SET_ACCESS</h4> |
| <pre>public static final <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> RESULT_SET_ACCESS</pre> |
| <div class="block">"eclipselink.result-set-access" |
| <p>Configures if this read object(s) query should keep result set until all result object(s) are built. |
| That allows to avoid getting potentially huge objects (LOBs) from ResultSet in case they would not be used |
| because the object is found in the cache. |
| Valid values are: HintValues.PERSISTENCE_UNIT_DEFAULT, HintValues.TRUE, HintValues.FALSE, |
| "" could be used instead of default value HintValues.PERSISTENCE_UNIT_DEFAULT</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/queries/ObjectLevelReadQuery.html#setIsResultSetAccessOptimizedQuery-boolean-"><code>ObjectLevelReadQuery.setIsResultSetAccessOptimizedQuery(boolean)</code></a>, |
| <a href="../../../../org/eclipse/persistence/queries/ObjectLevelReadQuery.html#clearIsResultSetOptimizedQuery--"><code>ObjectLevelReadQuery.clearIsResultSetOptimizedQuery()</code></a>, |
| <a href="../../../../constant-values.html#org.eclipse.persistence.config.QueryHints.RESULT_SET_ACCESS">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="SERIALIZED_OBJECT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SERIALIZED_OBJECT</h4> |
| <pre>public static final <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> SERIALIZED_OBJECT</pre> |
| <div class="block">"eclipselink.serialized-object" |
| <p>Configures if this read object(s) query use SerializedObjectPolicy if it's set on the descriptor. |
| Valid values are: HintValues.TRUE, HintValues.FALSE, |
| "" could be used instead of default value HintValues.FALSE</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/queries/ObjectLevelReadQuery.html#setShouldUseSerializedObjectPolicy-boolean-"><code>ObjectLevelReadQuery.setShouldUseSerializedObjectPolicy(boolean)</code></a>, |
| <a href="../../../../constant-values.html#org.eclipse.persistence.config.QueryHints.SERIALIZED_OBJECT">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="RETURN_NAME_VALUE_PAIRS"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>RETURN_NAME_VALUE_PAIRS</h4> |
| <pre>public static final <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> RETURN_NAME_VALUE_PAIRS</pre> |
| <div class="block">"eclipselink.query-return-name-value-pairs" |
| <p>Configures a ResultSetMappingQuery to return populated DatabaseRecord(s) |
| instead of raw data. This is particularly useful when the structure of the |
| returned data is not known.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/queries/ResultSetMappingQuery.html#setShouldReturnNameValuePairs-boolean-"><code>ResultSetMappingQuery.setShouldReturnNameValuePairs(boolean)</code></a>, |
| <a href="../../../../org/eclipse/persistence/queries/ResultSetMappingQuery.html#shouldReturnNameValuePairs--"><code>ResultSetMappingQuery.shouldReturnNameValuePairs()</code></a>, |
| <a href="../../../../constant-values.html#org.eclipse.persistence.config.QueryHints.RETURN_NAME_VALUE_PAIRS">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="QueryHints--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>QueryHints</h4> |
| <pre>public QueryHints()</pre> |
| </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/config/PropertiesUtils.html" title="class in org.eclipse.persistence.config"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/eclipse/persistence/config/QueryType.html" title="class in org.eclipse.persistence.config"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/eclipse/persistence/config/QueryHints.html" target="_top">Frames</a></li> |
| <li><a href="QueryHints.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="#methods.inherited.from.class.java.lang.Object">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>Method</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> |