api/3.0/org/eclipse/persistence/annotations/RangePartitioning.html - gerrit/www.eclipse.org/eclipselink - Git at Google

 <!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:36 UTC 2021 -->
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 <title>RangePartitioning (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="RangePartitioning (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/annotations/RangePartition.html" title="annotation in org.eclipse.persistence.annotations"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
 <li><a href="../../../../org/eclipse/persistence/annotations/ReadOnly.html" title="annotation in org.eclipse.persistence.annotations"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
 </ul>
 <ul class="navList">
 <li><a href="../../../../index.html?org/eclipse/persistence/annotations/RangePartitioning.html" target="_top">Frames</a></li>
 <li><a href="RangePartitioning.html" target="_top">No&nbsp;Frames</a></li>
 </ul>
 <ul class="navList" id="allclasses_navbar_top">
 <li><a href="../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li><a href="#annotation.type.required.element.summary">Required</a>&nbsp;|&nbsp;</li>
 <li><a href="#annotation.type.optional.element.summary">Optional</a></li>
 </ul>
 <ul class="subNavList">
 <li>Detail:&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li><a href="#annotation.type.element.detail">Element</a></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.annotations</div>
 <h2 title="Annotation Type RangePartitioning" class="title">Annotation Type RangePartitioning</h2>
 </div>
 <div class="contentContainer">
 <div class="description">
 <ul class="blockList">
 <li class="blockList">
 <hr>
 <br>
 <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Target.html?is-external=true" title="class or interface in java.lang.annotation">@Target</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Target.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>={<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/ElementType.html?is-external=true#TYPE" title="class or interface in java.lang.annotation">TYPE</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/ElementType.html?is-external=true#METHOD" title="class or interface in java.lang.annotation">METHOD</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/ElementType.html?is-external=true#FIELD" title="class or interface in java.lang.annotation">FIELD</a>})
  <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Retention.html?is-external=true" title="class or interface in java.lang.annotation">@Retention</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Retention.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>=<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/RetentionPolicy.html?is-external=true#RUNTIME" title="class or interface in java.lang.annotation">RUNTIME</a>)
 public @interface <span class="memberNameLabel">RangePartitioning</span></pre>
 <div class="block">RangePartitioningPolicy partitions access to a database cluster by a field value from the object,
  such as the object's id, location, or tenant.
  Each server is assigned a range of values.
  All write or read request for object's with that value are sent to the server.
  If a query does not include the field as a parameter, then it can either be sent
  to all server's and unioned, or left to the sesion's default behavior.
  <p>
  If multiple partitions are used to process a single transaction, JTA should be used for proper XA transaction support.
  <p>
  Partitioning can be enabled on an Entity, relationship, query, or session/persistence unit.
  Partition policies are globally named to allow reuse,
  the partitioning policy must also be set using the @Partitioned annotation to be used.</div>
 <dl>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="../../../../org/eclipse/persistence/annotations/Partitioned.html" title="annotation in org.eclipse.persistence.annotations"><code>Partitioned</code></a>,
 <a href="../../../../org/eclipse/persistence/descriptors/partitioning/RangePartitioningPolicy.html" title="class in org.eclipse.persistence.descriptors.partitioning"><code>RangePartitioningPolicy</code></a></dd>
 <dt><span class="simpleTagLabel">Author:</span></dt>
 <dd>James Sutherland</dd>
 <dt><span class="simpleTagLabel">Since:</span></dt>
 <dd>EclipseLink 2.2</dd>
 </dl>
 </li>
 </ul>
 </div>
 <div class="summary">
 <ul class="blockList">
 <li class="blockList">
 <!-- =========== ANNOTATION TYPE REQUIRED MEMBER SUMMARY =========== -->
 <ul class="blockList">
 <li class="blockList"><a name="annotation.type.required.element.summary">
 <!--   -->
 </a>
 <h3>Required Element Summary</h3>
 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Required Element Summary table, listing required elements, and an explanation">
 <caption><span>Required Elements</span><span class="tabEnd">&nbsp;</span></caption>
 <tr>
 <th class="colFirst" scope="col">Modifier and Type</th>
 <th class="colLast" scope="col">Required Element and Description</th>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code><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/annotations/RangePartitioning.html#name--">name</a></span></code>
 <div class="block">The name of the partition policy, names must be unique for the persistence unit.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>jakarta.persistence.Column</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/annotations/RangePartitioning.html#partitionColumn--">partitionColumn</a></span></code>
 <div class="block">The database column or query parameter to partition queries by.</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code><a href="../../../../org/eclipse/persistence/annotations/RangePartition.html" title="annotation in org.eclipse.persistence.annotations">RangePartition</a>[]</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/annotations/RangePartitioning.html#partitions--">partitions</a></span></code>
 <div class="block">(Required) List of connection pool names to load balance across.</div>
 </td>
 </tr>
 </table>
 </li>
 </ul>
 <!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== -->
 <ul class="blockList">
 <li class="blockList"><a name="annotation.type.optional.element.summary">
 <!--   -->
 </a>
 <h3>Optional Element Summary</h3>
 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation">
 <caption><span>Optional Elements</span><span class="tabEnd">&nbsp;</span></caption>
 <tr>
 <th class="colFirst" scope="col">Modifier and Type</th>
 <th class="colLast" scope="col">Optional Element and Description</th>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/annotations/RangePartitioning.html#partitionValueType--">partitionValueType</a></span></code>
 <div class="block">The type of the start and end values.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>boolean</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/annotations/RangePartitioning.html#unionUnpartitionableQueries--">unionUnpartitionableQueries</a></span></code>
 <div class="block">Defines if queries that do not contain the partition field should be sent
  to every database and have the result unioned.</div>
 </td>
 </tr>
 </table>
 </li>
 </ul>
 </li>
 </ul>
 </div>
 <div class="details">
 <ul class="blockList">
 <li class="blockList">
 <!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->
 <ul class="blockList">
 <li class="blockList"><a name="annotation.type.element.detail">
 <!--   -->
 </a>
 <h3>Element Detail</h3>
 <a name="name--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>name</h4>
 <pre>public abstract&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name</pre>
 <div class="block">The name of the partition policy, names must be unique for the persistence unit.</div>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="partitionColumn--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>partitionColumn</h4>
 <pre>public abstract&nbsp;jakarta.persistence.Column&nbsp;partitionColumn</pre>
 <div class="block">The database column or query parameter to partition queries by.
  This is the table column name, not the class attribute name.
  The column value must be included in the query and should normally be part of the object's Id.
  This can also be the name of a query parameter.
  If a query does not contain the field the query will not be partitioned.</div>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="partitions--">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>partitions</h4>
 <pre>public abstract&nbsp;<a href="../../../../org/eclipse/persistence/annotations/RangePartition.html" title="annotation in org.eclipse.persistence.annotations">RangePartition</a>[]&nbsp;partitions</pre>
 <div class="block">(Required) List of connection pool names to load balance across.</div>
 </li>
 </ul>
 </li>
 </ul>
 <!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->
 <ul class="blockList">
 <li class="blockList"><a name="partitionValueType--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>partitionValueType</h4>
 <pre>public abstract&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&nbsp;partitionValueType</pre>
 <div class="block">The type of the start and end values.</div>
 <dl>
 <dt>Default:</dt>
 <dd>java.lang.String.class</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="unionUnpartitionableQueries--">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>unionUnpartitionableQueries</h4>
 <pre>public abstract&nbsp;boolean&nbsp;unionUnpartitionableQueries</pre>
 <div class="block">Defines if queries that do not contain the partition field should be sent
  to every database and have the result unioned.</div>
 <dl>
 <dt>Default:</dt>
 <dd>false</dd>
 </dl>
 </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/annotations/RangePartition.html" title="annotation in org.eclipse.persistence.annotations"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
 <li><a href="../../../../org/eclipse/persistence/annotations/ReadOnly.html" title="annotation in org.eclipse.persistence.annotations"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
 </ul>
 <ul class="navList">
 <li><a href="../../../../index.html?org/eclipse/persistence/annotations/RangePartitioning.html" target="_top">Frames</a></li>
 <li><a href="RangePartitioning.html" target="_top">No&nbsp;Frames</a></li>
 </ul>
 <ul class="navList" id="allclasses_navbar_bottom">
 <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
 </ul>
 <div>
 <script type="text/javascript"><!--
   allClassesLink = document.getElementById("allclasses_navbar_bottom");
   if(window==top) {
     allClassesLink.style.display = "block";
   }
   else {
     allClassesLink.style.display = "none";
   }
   //-->
 </script>
 </div>
 <div>
 <ul class="subNavList">
 <li>Summary:&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li><a href="#annotation.type.required.element.summary">Required</a>&nbsp;|&nbsp;</li>
 <li><a href="#annotation.type.optional.element.summary">Optional</a></li>
 </ul>
 <ul class="subNavList">
 <li>Detail:&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li><a href="#annotation.type.element.detail">Element</a></li>
 </ul>
 </div>
 <a name="skip.navbar.bottom">
 <!--   -->
 </a></div>
 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 <p class="legalCopy"><small>Copyright &#169; 2007&#x2013;2021 <a href="http://www.eclipse.org/eclipselink">Eclipse.org - EclipseLink Project</a>. All rights reserved.</small></p>
 </body>
 </html>
	<!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:36 UTC 2021 -->
	<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
	<title>RangePartitioning (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="RangePartitioning (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/annotations/RangePartition.html" title="annotation in org.eclipse.persistence.annotations"><span class="typeNameLink">Prev Class</span></a></li>
	<li><a href="../../../../org/eclipse/persistence/annotations/ReadOnly.html" title="annotation in org.eclipse.persistence.annotations"><span class="typeNameLink">Next Class</span></a></li>
	</ul>
	<ul class="navList">
	<li><a href="../../../../index.html?org/eclipse/persistence/annotations/RangePartitioning.html" target="_top">Frames</a></li>
	<li><a href="RangePartitioning.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>Field \| </li>
	<li><a href="#annotation.type.required.element.summary">Required</a> \| </li>
	<li><a href="#annotation.type.optional.element.summary">Optional</a></li>
	</ul>
	<ul class="subNavList">
	<li>Detail: </li>
	<li>Field \| </li>
	<li><a href="#annotation.type.element.detail">Element</a></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.annotations</div>
	<h2 title="Annotation Type RangePartitioning" class="title">Annotation Type RangePartitioning</h2>
	</div>
	<div class="contentContainer">
	<div class="description">
	<ul class="blockList">
	<li class="blockList">
	<hr>
	<br>
	<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Target.html?is-external=true" title="class or interface in java.lang.annotation">@Target</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Target.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>={<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/ElementType.html?is-external=true#TYPE" title="class or interface in java.lang.annotation">TYPE</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/ElementType.html?is-external=true#METHOD" title="class or interface in java.lang.annotation">METHOD</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/ElementType.html?is-external=true#FIELD" title="class or interface in java.lang.annotation">FIELD</a>})
	<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Retention.html?is-external=true" title="class or interface in java.lang.annotation">@Retention</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Retention.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>=<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/RetentionPolicy.html?is-external=true#RUNTIME" title="class or interface in java.lang.annotation">RUNTIME</a>)
	public @interface <span class="memberNameLabel">RangePartitioning</span></pre>
	<div class="block">RangePartitioningPolicy partitions access to a database cluster by a field value from the object,
	such as the object's id, location, or tenant.
	Each server is assigned a range of values.
	All write or read request for object's with that value are sent to the server.
	If a query does not include the field as a parameter, then it can either be sent
	to all server's and unioned, or left to the sesion's default behavior.
	<p>
	If multiple partitions are used to process a single transaction, JTA should be used for proper XA transaction support.
	<p>
	Partitioning can be enabled on an Entity, relationship, query, or session/persistence unit.
	Partition policies are globally named to allow reuse,
	the partitioning policy must also be set using the @Partitioned annotation to be used.</div>
	<dl>
	<dt><span class="seeLabel">See Also:</span></dt>
	<dd><a href="../../../../org/eclipse/persistence/annotations/Partitioned.html" title="annotation in org.eclipse.persistence.annotations"><code>Partitioned</code></a>,
	<a href="../../../../org/eclipse/persistence/descriptors/partitioning/RangePartitioningPolicy.html" title="class in org.eclipse.persistence.descriptors.partitioning"><code>RangePartitioningPolicy</code></a></dd>
	<dt><span class="simpleTagLabel">Author:</span></dt>
	<dd>James Sutherland</dd>
	<dt><span class="simpleTagLabel">Since:</span></dt>
	<dd>EclipseLink 2.2</dd>
	</dl>
	</li>
	</ul>
	</div>
	<div class="summary">
	<ul class="blockList">
	<li class="blockList">
	<!-- =========== ANNOTATION TYPE REQUIRED MEMBER SUMMARY =========== -->
	<ul class="blockList">
	<li class="blockList"><a name="annotation.type.required.element.summary">
	<!-- -->
	</a>
	<h3>Required Element Summary</h3>
	<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Required Element Summary table, listing required elements, and an explanation">
	<caption><span>Required Elements</span><span class="tabEnd"> </span></caption>
	<tr>
	<th class="colFirst" scope="col">Modifier and Type</th>
	<th class="colLast" scope="col">Required Element and Description</th>
	</tr>
	<tr class="altColor">
	<td class="colFirst"><code><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/annotations/RangePartitioning.html#name--">name</a></span></code>
	<div class="block">The name of the partition policy, names must be unique for the persistence unit.</div>
	</td>
	</tr>
	<tr class="rowColor">
	<td class="colFirst"><code>jakarta.persistence.Column</code></td>
	<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/annotations/RangePartitioning.html#partitionColumn--">partitionColumn</a></span></code>
	<div class="block">The database column or query parameter to partition queries by.</div>
	</td>
	</tr>
	<tr class="altColor">
	<td class="colFirst"><code><a href="../../../../org/eclipse/persistence/annotations/RangePartition.html" title="annotation in org.eclipse.persistence.annotations">RangePartition</a>[]</code></td>
	<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/annotations/RangePartitioning.html#partitions--">partitions</a></span></code>
	<div class="block">(Required) List of connection pool names to load balance across.</div>
	</td>
	</tr>
	</table>
	</li>
	</ul>
	<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== -->
	<ul class="blockList">
	<li class="blockList"><a name="annotation.type.optional.element.summary">
	<!-- -->
	</a>
	<h3>Optional Element Summary</h3>
	<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation">
	<caption><span>Optional Elements</span><span class="tabEnd"> </span></caption>
	<tr>
	<th class="colFirst" scope="col">Modifier and Type</th>
	<th class="colLast" scope="col">Optional Element and Description</th>
	</tr>
	<tr class="altColor">
	<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a></code></td>
	<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/annotations/RangePartitioning.html#partitionValueType--">partitionValueType</a></span></code>
	<div class="block">The type of the start and end values.</div>
	</td>
	</tr>
	<tr class="rowColor">
	<td class="colFirst"><code>boolean</code></td>
	<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/annotations/RangePartitioning.html#unionUnpartitionableQueries--">unionUnpartitionableQueries</a></span></code>
	<div class="block">Defines if queries that do not contain the partition field should be sent
	to every database and have the result unioned.</div>
	</td>
	</tr>
	</table>
	</li>
	</ul>
	</li>
	</ul>
	</div>
	<div class="details">
	<ul class="blockList">
	<li class="blockList">
	<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->
	<ul class="blockList">
	<li class="blockList"><a name="annotation.type.element.detail">
	<!-- -->
	</a>
	<h3>Element Detail</h3>
	<a name="name--">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>name</h4>
	<pre>public abstract <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> name</pre>
	<div class="block">The name of the partition policy, names must be unique for the persistence unit.</div>
	</li>
	</ul>
	</li>
	</ul>
	<ul class="blockList">
	<li class="blockList"><a name="partitionColumn--">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>partitionColumn</h4>
	<pre>public abstract jakarta.persistence.Column partitionColumn</pre>
	<div class="block">The database column or query parameter to partition queries by.
	This is the table column name, not the class attribute name.
	The column value must be included in the query and should normally be part of the object's Id.
	This can also be the name of a query parameter.
	If a query does not contain the field the query will not be partitioned.</div>
	</li>
	</ul>
	</li>
	</ul>
	<ul class="blockList">
	<li class="blockList"><a name="partitions--">
	<!-- -->
	</a>
	<ul class="blockListLast">
	<li class="blockList">
	<h4>partitions</h4>
	<pre>public abstract <a href="../../../../org/eclipse/persistence/annotations/RangePartition.html" title="annotation in org.eclipse.persistence.annotations">RangePartition</a>[] partitions</pre>
	<div class="block">(Required) List of connection pool names to load balance across.</div>
	</li>
	</ul>
	</li>
	</ul>
	<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->
	<ul class="blockList">
	<li class="blockList"><a name="partitionValueType--">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>partitionValueType</h4>
	<pre>public abstract <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a> partitionValueType</pre>
	<div class="block">The type of the start and end values.</div>
	<dl>
	<dt>Default:</dt>
	<dd>java.lang.String.class</dd>
	</dl>
	</li>
	</ul>
	</li>
	</ul>
	<ul class="blockList">
	<li class="blockList"><a name="unionUnpartitionableQueries--">
	<!-- -->
	</a>
	<ul class="blockListLast">
	<li class="blockList">
	<h4>unionUnpartitionableQueries</h4>
	<pre>public abstract boolean unionUnpartitionableQueries</pre>
	<div class="block">Defines if queries that do not contain the partition field should be sent
	to every database and have the result unioned.</div>
	<dl>
	<dt>Default:</dt>
	<dd>false</dd>
	</dl>
	</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/annotations/RangePartition.html" title="annotation in org.eclipse.persistence.annotations"><span class="typeNameLink">Prev Class</span></a></li>
	<li><a href="../../../../org/eclipse/persistence/annotations/ReadOnly.html" title="annotation in org.eclipse.persistence.annotations"><span class="typeNameLink">Next Class</span></a></li>
	</ul>
	<ul class="navList">
	<li><a href="../../../../index.html?org/eclipse/persistence/annotations/RangePartitioning.html" target="_top">Frames</a></li>
	<li><a href="RangePartitioning.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>Field \| </li>
	<li><a href="#annotation.type.required.element.summary">Required</a> \| </li>
	<li><a href="#annotation.type.optional.element.summary">Optional</a></li>
	</ul>
	<ul class="subNavList">
	<li>Detail: </li>
	<li>Field \| </li>
	<li><a href="#annotation.type.element.detail">Element</a></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>