solr-4.5.1/docs/solr-solrj/org/apache/solr/common/params/ShardParams.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
   2 <!-- NewPage -->
   3 <html lang="en">
   4 <head>
   5 <!-- Generated by javadoc (version 1.6.0_27) on Thu Oct 17 21:45:04 EDT 2013 -->
   6 <meta http-equiv="Content-Type" content="text/html" charset="utf-8">
   7 <title>ShardParams (Solr 4.5.1 API)</title>
   8 <meta name="date" content="2013-10-17">
   9 <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
  10 </head>
  11 <body>
  12 <script type="text/javascript"><!--
  13     if (location.href.indexOf('is-external=true') == -1) {
  14         parent.document.title="ShardParams (Solr 4.5.1 API)";
  15     }
  16 //-->
  17 </script>
  18 <noscript>
  19 <div>JavaScript is disabled on your browser.</div>
  20 </noscript>
  21 <!-- ========= START OF TOP NAVBAR ======= -->
  22 <div class="topNav"><a name="navbar_top">
  23 <!--   -->
  24 </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
  25 <!--   -->
  26 </a>
  27 <ul class="navList" title="Navigation">
  28 <li><a href="../../../../../overview-summary.html">Overview</a></li>
  29 <li><a href="package-summary.html">Package</a></li>
  30 <li class="navBarCell1Rev">Class</li>
  31 <li><a href="class-use/ShardParams.html">Use</a></li>
  32 <li><a href="package-tree.html">Tree</a></li>
  33 <li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
  34 <li><a href="../../../../../help-doc.html">Help</a></li>
  35 </ul>
  36 </div>
  37 <div class="subNav">
  38 <ul class="navList">
  39 <li><a href="../../../../../org/apache/solr/common/params/RequiredSolrParams.html" title="class in org.apache.solr.common.params"><span class="strong">PREV CLASS</span></a></li>
  40 <li><a href="../../../../../org/apache/solr/common/params/SolrParams.html" title="class in org.apache.solr.common.params"><span class="strong">NEXT CLASS</span></a></li>
  41 </ul>
  42 <ul class="navList">
  43 <li><a href="../../../../../index.html?org/apache/solr/common/params/ShardParams.html" target="_top">FRAMES</a></li>
  44 <li><a href="ShardParams.html" target="_top">NO FRAMES</a></li>
  45 </ul>
  46 <ul class="navList" id="allclasses_navbar_top">
  47 <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
  48 </ul>
  49 <div>
  50 <script type="text/javascript"><!--
  51   allClassesLink = document.getElementById("allclasses_navbar_top");
  52   if(window==top) {
  53     allClassesLink.style.display = "block";
  54   }
  55   else {
  56     allClassesLink.style.display = "none";
  57   }
  58   //-->
  59 </script>
  60 </div>
  61 <div>
  62 <ul class="subNavList">
  63 <li>SUMMARY:&nbsp;</li>
  64 <li>NESTED&nbsp;|&nbsp;</li>
  65 <li><a href="#field_summary">FIELD</a>&nbsp;|&nbsp;</li>
  66 <li>CONSTR&nbsp;|&nbsp;</li>
  67 <li>METHOD</li>
  68 </ul>
  69 <ul class="subNavList">
  70 <li>DETAIL:&nbsp;</li>
  71 <li><a href="#field_detail">FIELD</a>&nbsp;|&nbsp;</li>
  72 <li>CONSTR&nbsp;|&nbsp;</li>
  73 <li>METHOD</li>
  74 </ul>
  75 </div>
  76 <a name="skip-navbar_top">
  77 <!--   -->
  78 </a></div>
  79 <!-- ========= END OF TOP NAVBAR ========= -->
  80 <!-- ======== START OF CLASS DATA ======== -->
  81 <div class="header">
  82 <p class="subTitle">org.apache.solr.common.params</p>
  83 <h2 title="Interface ShardParams" class="title">Interface ShardParams</h2>
  84 </div>
  85 <div class="contentContainer">
  86 <div class="description">
  87 <ul class="blockList">
  88 <li class="blockList">
  89 <hr>
  90 <br>
  91 <pre>public interface <strong>ShardParams</strong></pre>
  92 <div class="block">Parameters used for distributed search.</div>
  93 </li>
  94 </ul>
  95 </div>
  96 <div class="summary">
  97 <ul class="blockList">
  98 <li class="blockList">
  99 <!-- =========== FIELD SUMMARY =========== -->
 100 <ul class="blockList">
 101 <li class="blockList"><a name="field_summary">
 102 <!--   -->
 103 </a>
 104 <h3>Field Summary</h3>
 105 <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
 106 <caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
 107 <tr>
 108 <th class="colFirst" scope="col">Modifier and Type</th>
 109 <th class="colLast" scope="col">Field and Description</th>
 110 </tr>
 111 <tr class="altColor">
 112 <td class="colFirst"><code>static <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
 113 <td class="colLast"><code><strong><a href="../../../../../org/apache/solr/common/params/ShardParams.html#_ROUTE_">_ROUTE_</a></strong></code>&nbsp;</td>
 114 </tr>
 115 <tr class="rowColor">
 116 <td class="colFirst"><code>static <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
 117 <td class="colLast"><code><strong><a href="../../../../../org/apache/solr/common/params/ShardParams.html#IDS">IDS</a></strong></code>
 118 <div class="block">IDs of the shard documents</div>
 119 </td>
 120 </tr>
 121 <tr class="altColor">
 122 <td class="colFirst"><code>static <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
 123 <td class="colLast"><code><strong><a href="../../../../../org/apache/solr/common/params/ShardParams.html#IS_SHARD">IS_SHARD</a></strong></code>
 124 <div class="block">whether the request goes to a shard</div>
 125 </td>
 126 </tr>
 127 <tr class="rowColor">
 128 <td class="colFirst"><code>static <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
 129 <td class="colLast"><code><strong><a href="../../../../../org/apache/solr/common/params/ShardParams.html#SHARD_KEYS">SHARD_KEYS</a></strong></code>
 130 <div class="block"><strong>Deprecated.</strong>&nbsp;</div>
 131 </td>
 132 </tr>
 133 <tr class="altColor">
 134 <td class="colFirst"><code>static <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
 135 <td class="colLast"><code><strong><a href="../../../../../org/apache/solr/common/params/ShardParams.html#SHARD_URL">SHARD_URL</a></strong></code>
 136 <div class="block">The requested URL for this shard</div>
 137 </td>
 138 </tr>
 139 <tr class="rowColor">
 140 <td class="colFirst"><code>static <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
 141 <td class="colLast"><code><strong><a href="../../../../../org/apache/solr/common/params/ShardParams.html#SHARDS">SHARDS</a></strong></code>
 142 <div class="block">the shards to use (distributed configuration)</div>
 143 </td>
 144 </tr>
 145 <tr class="altColor">
 146 <td class="colFirst"><code>static <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
 147 <td class="colLast"><code><strong><a href="../../../../../org/apache/solr/common/params/ShardParams.html#SHARDS_INFO">SHARDS_INFO</a></strong></code>
 148 <div class="block">Request detailed match info for each shard (true/false)</div>
 149 </td>
 150 </tr>
 151 <tr class="rowColor">
 152 <td class="colFirst"><code>static <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
 153 <td class="colLast"><code><strong><a href="../../../../../org/apache/solr/common/params/ShardParams.html#SHARDS_QT">SHARDS_QT</a></strong></code>
 154 <div class="block">The Request Handler for shard requests</div>
 155 </td>
 156 </tr>
 157 <tr class="altColor">
 158 <td class="colFirst"><code>static <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
 159 <td class="colLast"><code><strong><a href="../../../../../org/apache/solr/common/params/ShardParams.html#SHARDS_ROWS">SHARDS_ROWS</a></strong></code>
 160 <div class="block">per-shard start and rows</div>
 161 </td>
 162 </tr>
 163 <tr class="rowColor">
 164 <td class="colFirst"><code>static <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
 165 <td class="colLast"><code><strong><a href="../../../../../org/apache/solr/common/params/ShardParams.html#SHARDS_START">SHARDS_START</a></strong></code>&nbsp;</td>
 166 </tr>
 167 <tr class="altColor">
 168 <td class="colFirst"><code>static <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
 169 <td class="colLast"><code><strong><a href="../../../../../org/apache/solr/common/params/ShardParams.html#SHARDS_TOLERANT">SHARDS_TOLERANT</a></strong></code>
 170 <div class="block">Should things fail if there is an error? (true/false)</div>
 171 </td>
 172 </tr>
 173 </table>
 174 </li>
 175 </ul>
 176 </li>
 177 </ul>
 178 </div>
 179 <div class="details">
 180 <ul class="blockList">
 181 <li class="blockList">
 182 <!-- ============ FIELD DETAIL =========== -->
 183 <ul class="blockList">
 184 <li class="blockList"><a name="field_detail">
 185 <!--   -->
 186 </a>
 187 <h3>Field Detail</h3>
 188 <a name="SHARDS">
 189 <!--   -->
 190 </a>
 191 <ul class="blockList">
 192 <li class="blockList">
 193 <h4>SHARDS</h4>
 194 <pre>static final&nbsp;<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> SHARDS</pre>
 195 <div class="block">the shards to use (distributed configuration)</div>
 196 <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.solr.common.params.ShardParams.SHARDS">Constant Field Values</a></dd></dl>
 197 </li>
 198 </ul>
 199 <a name="SHARDS_ROWS">
 200 <!--   -->
 201 </a>
 202 <ul class="blockList">
 203 <li class="blockList">
 204 <h4>SHARDS_ROWS</h4>
 205 <pre>static final&nbsp;<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> SHARDS_ROWS</pre>
 206 <div class="block">per-shard start and rows</div>
 207 <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.solr.common.params.ShardParams.SHARDS_ROWS">Constant Field Values</a></dd></dl>
 208 </li>
 209 </ul>
 210 <a name="SHARDS_START">
 211 <!--   -->
 212 </a>
 213 <ul class="blockList">
 214 <li class="blockList">
 215 <h4>SHARDS_START</h4>
 216 <pre>static final&nbsp;<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> SHARDS_START</pre>
 217 <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.solr.common.params.ShardParams.SHARDS_START">Constant Field Values</a></dd></dl>
 218 </li>
 219 </ul>
 220 <a name="IDS">
 221 <!--   -->
 222 </a>
 223 <ul class="blockList">
 224 <li class="blockList">
 225 <h4>IDS</h4>
 226 <pre>static final&nbsp;<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> IDS</pre>
 227 <div class="block">IDs of the shard documents</div>
 228 <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.solr.common.params.ShardParams.IDS">Constant Field Values</a></dd></dl>
 229 </li>
 230 </ul>
 231 <a name="IS_SHARD">
 232 <!--   -->
 233 </a>
 234 <ul class="blockList">
 235 <li class="blockList">
 236 <h4>IS_SHARD</h4>
 237 <pre>static final&nbsp;<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> IS_SHARD</pre>
 238 <div class="block">whether the request goes to a shard</div>
 239 <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.solr.common.params.ShardParams.IS_SHARD">Constant Field Values</a></dd></dl>
 240 </li>
 241 </ul>
 242 <a name="SHARD_URL">
 243 <!--   -->
 244 </a>
 245 <ul class="blockList">
 246 <li class="blockList">
 247 <h4>SHARD_URL</h4>
 248 <pre>static final&nbsp;<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> SHARD_URL</pre>
 249 <div class="block">The requested URL for this shard</div>
 250 <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.solr.common.params.ShardParams.SHARD_URL">Constant Field Values</a></dd></dl>
 251 </li>
 252 </ul>
 253 <a name="SHARDS_QT">
 254 <!--   -->
 255 </a>
 256 <ul class="blockList">
 257 <li class="blockList">
 258 <h4>SHARDS_QT</h4>
 259 <pre>static final&nbsp;<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> SHARDS_QT</pre>
 260 <div class="block">The Request Handler for shard requests</div>
 261 <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.solr.common.params.ShardParams.SHARDS_QT">Constant Field Values</a></dd></dl>
 262 </li>
 263 </ul>
 264 <a name="SHARDS_INFO">
 265 <!--   -->
 266 </a>
 267 <ul class="blockList">
 268 <li class="blockList">
 269 <h4>SHARDS_INFO</h4>
 270 <pre>static final&nbsp;<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> SHARDS_INFO</pre>
 271 <div class="block">Request detailed match info for each shard (true/false)</div>
 272 <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.solr.common.params.ShardParams.SHARDS_INFO">Constant Field Values</a></dd></dl>
 273 </li>
 274 </ul>
 275 <a name="SHARDS_TOLERANT">
 276 <!--   -->
 277 </a>
 278 <ul class="blockList">
 279 <li class="blockList">
 280 <h4>SHARDS_TOLERANT</h4>
 281 <pre>static final&nbsp;<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> SHARDS_TOLERANT</pre>
 282 <div class="block">Should things fail if there is an error? (true/false)</div>
 283 <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.solr.common.params.ShardParams.SHARDS_TOLERANT">Constant Field Values</a></dd></dl>
 284 </li>
 285 </ul>
 286 <a name="SHARD_KEYS">
 287 <!--   -->
 288 </a>
 289 <ul class="blockList">
 290 <li class="blockList">
 291 <h4>SHARD_KEYS</h4>
 292 <pre><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
 293 static final&nbsp;<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> SHARD_KEYS</pre>
 294 <div class="block"><span class="strong">Deprecated.</span>&nbsp;</div>
 295 <div class="block">Should things fail if there is an error? (true/false)</div>
 296 <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.solr.common.params.ShardParams.SHARD_KEYS">Constant Field Values</a></dd></dl>
 297 </li>
 298 </ul>
 299 <a name="_ROUTE_">
 300 <!--   -->
 301 </a>
 302 <ul class="blockListLast">
 303 <li class="blockList">
 304 <h4>_ROUTE_</h4>
 305 <pre>static final&nbsp;<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> _ROUTE_</pre>
 306 <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.solr.common.params.ShardParams._ROUTE_">Constant Field Values</a></dd></dl>
 307 </li>
 308 </ul>
 309 </li>
 310 </ul>
 311 </li>
 312 </ul>
 313 </div>
 314 </div>
 315 <!-- ========= END OF CLASS DATA ========= -->
 316 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 317 <div class="bottomNav"><a name="navbar_bottom">
 318 <!--   -->
 319 </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
 320 <!--   -->
 321 </a>
 322 <ul class="navList" title="Navigation">
 323 <li><a href="../../../../../overview-summary.html">Overview</a></li>
 324 <li><a href="package-summary.html">Package</a></li>
 325 <li class="navBarCell1Rev">Class</li>
 326 <li><a href="class-use/ShardParams.html">Use</a></li>
 327 <li><a href="package-tree.html">Tree</a></li>
 328 <li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
 329 <li><a href="../../../../../help-doc.html">Help</a></li>
 330 </ul>
 331 </div>
 332 <div class="subNav">
 333 <ul class="navList">
 334 <li><a href="../../../../../org/apache/solr/common/params/RequiredSolrParams.html" title="class in org.apache.solr.common.params"><span class="strong">PREV CLASS</span></a></li>
 335 <li><a href="../../../../../org/apache/solr/common/params/SolrParams.html" title="class in org.apache.solr.common.params"><span class="strong">NEXT CLASS</span></a></li>
 336 </ul>
 337 <ul class="navList">
 338 <li><a href="../../../../../index.html?org/apache/solr/common/params/ShardParams.html" target="_top">FRAMES</a></li>
 339 <li><a href="ShardParams.html" target="_top">NO FRAMES</a></li>
 340 </ul>
 341 <ul class="navList" id="allclasses_navbar_bottom">
 342 <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
 343 </ul>
 344 <div>
 345 <script type="text/javascript"><!--
 346   allClassesLink = document.getElementById("allclasses_navbar_bottom");
 347   if(window==top) {
 348     allClassesLink.style.display = "block";
 349   }
 350   else {
 351     allClassesLink.style.display = "none";
 352   }
 353   //-->
 354 </script>
 355 </div>
 356 <div>
 357 <ul class="subNavList">
 358 <li>SUMMARY:&nbsp;</li>
 359 <li>NESTED&nbsp;|&nbsp;</li>
 360 <li><a href="#field_summary">FIELD</a>&nbsp;|&nbsp;</li>
 361 <li>CONSTR&nbsp;|&nbsp;</li>
 362 <li>METHOD</li>
 363 </ul>
 364 <ul class="subNavList">
 365 <li>DETAIL:&nbsp;</li>
 366 <li><a href="#field_detail">FIELD</a>&nbsp;|&nbsp;</li>
 367 <li>CONSTR&nbsp;|&nbsp;</li>
 368 <li>METHOD</li>
 369 </ul>
 370 </div>
 371 <a name="skip-navbar_bottom">
 372 <!--   -->
 373 </a></div>
 374 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 375 <p class="legalCopy"><small>
 376           <i>Copyright &copy; 2000-2013 Apache Software Foundation.  All Rights Reserved.</i>
 377           <script src='../../../../../prettify.js' type='text/javascript'></script>
 378           <script type='text/javascript'>
 379             (function(){
 380               var oldonload = window.onload;
 381               if (typeof oldonload != 'function') {
 382                 window.onload = prettyPrint;
 383               } else {
 384                 window.onload = function() {
 385                   oldonload();
 386                   prettyPrint();
 387                 }
 388               }
 389             })();
 390           </script>
 391         </small></p>
 392 </body>
 393 </html>