1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
5 <!-- Generated by javadoc (build 1.6.0_30) on Tue Nov 19 11:17:03 CET 2013 -->
6 <META http-equiv="Content-Type" content="text/html; charset=utf-8">
8 ShardParams (Solr 4.6.0 API)
11 <META NAME="date" CONTENT="2013-11-19">
13 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
15 <SCRIPT type="text/javascript">
16 function windowTitle()
18 if (location.href.indexOf('is-external=true') == -1) {
19 parent.document.title="ShardParams (Solr 4.6.0 API)";
28 <BODY BGCOLOR="white" onload="windowTitle();">
32 <!-- ========= START OF TOP NAVBAR ======= -->
33 <A NAME="navbar_top"><!-- --></A>
34 <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
35 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
37 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
38 <A NAME="navbar_top_firstrow"><!-- --></A>
39 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
40 <TR ALIGN="center" VALIGN="top">
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
42 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
43 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
44 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ShardParams.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
45 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
46 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
47 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
51 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
57 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
58 <A HREF="../../../../../org/apache/solr/common/params/RequiredSolrParams.html" title="class in org.apache.solr.common.params"><B>PREV CLASS</B></A>
59 <A HREF="../../../../../org/apache/solr/common/params/SolrParams.html" title="class in org.apache.solr.common.params"><B>NEXT CLASS</B></A></FONT></TD>
60 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
61 <A HREF="../../../../../index.html?org/apache/solr/common/params/ShardParams.html" target="_top"><B>FRAMES</B></A>
62 <A HREF="ShardParams.html" target="_top"><B>NO FRAMES</B></A>
63 <SCRIPT type="text/javascript">
66 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
71 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
78 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
79 SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | CONSTR | METHOD</FONT></TD>
80 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
81 DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | METHOD</FONT></TD>
84 <A NAME="skip-navbar_top"></A>
85 <!-- ========= END OF TOP NAVBAR ========= -->
88 <!-- ======== START OF CLASS DATA ======== -->
91 org.apache.solr.common.params</FONT>
93 Interface ShardParams</H2>
96 <DT><PRE>public interface <B>ShardParams</B></DL>
100 Parameters used for distributed search.
107 <!-- =========== FIELD SUMMARY =========== -->
109 <A NAME="field_summary"><!-- --></A>
110 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
111 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
112 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
113 <B>Field Summary</B></FONT></TH>
115 <TR BGCOLOR="white" CLASS="TableRowColor">
116 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
117 <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></FONT></TD>
118 <TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/ShardParams.html#_ROUTE_">_ROUTE_</A></B></CODE>
121 </TD>
123 <TR BGCOLOR="white" CLASS="TableRowColor">
124 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
125 <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></FONT></TD>
126 <TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/ShardParams.html#IDS">IDS</A></B></CODE>
129 IDs of the shard documents</TD>
131 <TR BGCOLOR="white" CLASS="TableRowColor">
132 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
133 <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></FONT></TD>
134 <TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/ShardParams.html#IS_SHARD">IS_SHARD</A></B></CODE>
137 whether the request goes to a shard</TD>
139 <TR BGCOLOR="white" CLASS="TableRowColor">
140 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
141 <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></FONT></TD>
142 <TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/ShardParams.html#SHARD_KEYS">SHARD_KEYS</A></B></CODE>
145 <B>Deprecated.</B> </TD>
147 <TR BGCOLOR="white" CLASS="TableRowColor">
148 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
149 <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></FONT></TD>
150 <TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/ShardParams.html#SHARD_URL">SHARD_URL</A></B></CODE>
153 The requested URL for this shard</TD>
155 <TR BGCOLOR="white" CLASS="TableRowColor">
156 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
157 <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></FONT></TD>
158 <TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/ShardParams.html#SHARDS">SHARDS</A></B></CODE>
161 the shards to use (distributed configuration)</TD>
163 <TR BGCOLOR="white" CLASS="TableRowColor">
164 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
165 <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></FONT></TD>
166 <TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/ShardParams.html#SHARDS_INFO">SHARDS_INFO</A></B></CODE>
169 Request detailed match info for each shard (true/false)</TD>
171 <TR BGCOLOR="white" CLASS="TableRowColor">
172 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
173 <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></FONT></TD>
174 <TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/ShardParams.html#SHARDS_QT">SHARDS_QT</A></B></CODE>
177 The Request Handler for shard requests</TD>
179 <TR BGCOLOR="white" CLASS="TableRowColor">
180 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
181 <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></FONT></TD>
182 <TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/ShardParams.html#SHARDS_ROWS">SHARDS_ROWS</A></B></CODE>
185 per-shard start and rows</TD>
187 <TR BGCOLOR="white" CLASS="TableRowColor">
188 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
189 <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></FONT></TD>
190 <TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/ShardParams.html#SHARDS_START">SHARDS_START</A></B></CODE>
193 </TD>
195 <TR BGCOLOR="white" CLASS="TableRowColor">
196 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
197 <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></FONT></TD>
198 <TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/ShardParams.html#SHARDS_TOLERANT">SHARDS_TOLERANT</A></B></CODE>
201 Should things fail if there is an error? (true/false)</TD>
207 <!-- ============ FIELD DETAIL =========== -->
209 <A NAME="field_detail"><!-- --></A>
210 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
211 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
212 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
213 <B>Field Detail</B></FONT></TH>
217 <A NAME="SHARDS"><!-- --></A><H3>
220 static final <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> <B>SHARDS</B></PRE>
222 <DD>the shards to use (distributed configuration)
225 <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.ShardParams.SHARDS">Constant Field Values</A></DL>
229 <A NAME="SHARDS_ROWS"><!-- --></A><H3>
232 static final <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> <B>SHARDS_ROWS</B></PRE>
234 <DD>per-shard start and rows
237 <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.ShardParams.SHARDS_ROWS">Constant Field Values</A></DL>
241 <A NAME="SHARDS_START"><!-- --></A><H3>
244 static final <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> <B>SHARDS_START</B></PRE>
247 <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.ShardParams.SHARDS_START">Constant Field Values</A></DL>
251 <A NAME="IDS"><!-- --></A><H3>
254 static final <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> <B>IDS</B></PRE>
256 <DD>IDs of the shard documents
259 <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.ShardParams.IDS">Constant Field Values</A></DL>
263 <A NAME="IS_SHARD"><!-- --></A><H3>
266 static final <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> <B>IS_SHARD</B></PRE>
268 <DD>whether the request goes to a shard
271 <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.ShardParams.IS_SHARD">Constant Field Values</A></DL>
275 <A NAME="SHARD_URL"><!-- --></A><H3>
278 static final <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> <B>SHARD_URL</B></PRE>
280 <DD>The requested URL for this shard
283 <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.ShardParams.SHARD_URL">Constant Field Values</A></DL>
287 <A NAME="SHARDS_QT"><!-- --></A><H3>
290 static final <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> <B>SHARDS_QT</B></PRE>
292 <DD>The Request Handler for shard requests
295 <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.ShardParams.SHARDS_QT">Constant Field Values</A></DL>
299 <A NAME="SHARDS_INFO"><!-- --></A><H3>
302 static final <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> <B>SHARDS_INFO</B></PRE>
304 <DD>Request detailed match info for each shard (true/false)
307 <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.ShardParams.SHARDS_INFO">Constant Field Values</A></DL>
311 <A NAME="SHARDS_TOLERANT"><!-- --></A><H3>
314 static final <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> <B>SHARDS_TOLERANT</B></PRE>
316 <DD>Should things fail if there is an error? (true/false)
319 <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.ShardParams.SHARDS_TOLERANT">Constant Field Values</A></DL>
323 <A NAME="SHARD_KEYS"><!-- --></A><H3>
326 <FONT SIZE="-1"><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>
327 </FONT>static final <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> <B>SHARD_KEYS</B></PRE>
329 <DD><B>Deprecated.</B> <DD>Should things fail if there is an error? (true/false)
332 <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.ShardParams.SHARD_KEYS">Constant Field Values</A></DL>
336 <A NAME="_ROUTE_"><!-- --></A><H3>
339 static final <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> <B>_ROUTE_</B></PRE>
342 <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.ShardParams._ROUTE_">Constant Field Values</A></DL>
344 <!-- ========= END OF CLASS DATA ========= -->
348 <!-- ======= START OF BOTTOM NAVBAR ====== -->
349 <A NAME="navbar_bottom"><!-- --></A>
350 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
351 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
353 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
354 <A NAME="navbar_bottom_firstrow"><!-- --></A>
355 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
356 <TR ALIGN="center" VALIGN="top">
357 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
358 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
359 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
360 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ShardParams.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
361 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
362 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
363 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
367 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
373 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
374 <A HREF="../../../../../org/apache/solr/common/params/RequiredSolrParams.html" title="class in org.apache.solr.common.params"><B>PREV CLASS</B></A>
375 <A HREF="../../../../../org/apache/solr/common/params/SolrParams.html" title="class in org.apache.solr.common.params"><B>NEXT CLASS</B></A></FONT></TD>
376 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
377 <A HREF="../../../../../index.html?org/apache/solr/common/params/ShardParams.html" target="_top"><B>FRAMES</B></A>
378 <A HREF="ShardParams.html" target="_top"><B>NO FRAMES</B></A>
379 <SCRIPT type="text/javascript">
382 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
387 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
394 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
395 SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | CONSTR | METHOD</FONT></TD>
396 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
397 DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | METHOD</FONT></TD>
400 <A NAME="skip-navbar_bottom"></A>
401 <!-- ======== END OF BOTTOM NAVBAR ======= -->
405 <i>Copyright © 2000-2013 Apache Software Foundation. All Rights Reserved.</i>
406 <script src='../../../../../prettify.js' type='text/javascript'></script>
407 <script type='text/javascript'>
409 var oldonload = window.onload;
410 if (typeof oldonload != 'function') {
411 window.onload = prettyPrint;
413 window.onload = function() {