11.05.2016 Views

Apache Solr Reference Guide Covering Apache Solr 6.0

21SiXmO

21SiXmO

SHOW MORE
SHOW LESS

Create successful ePaper yourself

Turn your PDF publications into a flip-book with our unique Google optimized e-Paper software.

The table below summarizes <strong>Solr</strong>'s common query parameters, which are supported by the Standard, DisMax,<br />

and eDisMax Request Handlers.<br />

Parameter<br />

defType<br />

sort<br />

start<br />

Description<br />

Selects the query parser to be used to process the query.<br />

Sorts the response to a query in either ascending or descending order based on the<br />

response's score or another specified characteristic.<br />

Specifies an offset (by default, 0) into the responses at which <strong>Solr</strong> should begin<br />

displaying content.<br />

rows Controls how many rows of responses are displayed at a time (default value: 10)<br />

fq<br />

fl<br />

debug<br />

explainOther<br />

timeAllowed<br />

segmentTerminateEarly<br />

omitHeader<br />

wt<br />

logParamsList<br />

echoParams<br />

Applies a filter query to the search results.<br />

Limits the information included in a query response to a specified list of fields. The<br />

fields need to either be stored="true" or docValues="true"<br />

Request additional debugging information in the response. Specifying the debug=t<br />

iming parameter returns just the timing information; specifying the debug=result<br />

s parameter returns "explain" information for each of the documents returned;<br />

specifying the debug=query parameter returns all of the debug information.<br />

Allows clients to specify a Lucene query to identify a set of documents. If non-blank,<br />

the explain info of each document which matches this query, relative to the main<br />

query (specified by the q parameter) will be returned along with the rest of the<br />

debugging information.<br />

Defines the time allowed for the query to be processed. If the time elapses before<br />

the query response is complete, partial information may be returned.<br />

Indicates that, if possible, <strong>Solr</strong> should stop collecting documents from each<br />

individual (sorted) segment once it can determine that any subsequent documents<br />

in that segment will not be candidates for the rows being returned. The default is<br />

false.<br />

Excludes the header from the returned results, if set to true. The header contains<br />

information about the request, such as the time the request took to complete. The<br />

default is false.<br />

Specifies the Response Writer to be used to format the query response.<br />

By default, <strong>Solr</strong> logs all parameters. Set this parameter to restrict which parameters<br />

are logged. Valid entries are the parameters to be logged, separated by commas<br />

(i.e., logParamsList=param1,param2). An empty list will log no parameters, so<br />

if logging all parameters is desired, do not define this additional parameter at all.<br />

The response header can include parameters sent with the query request. This<br />

parameter controls what is contained in that section of the response header. Valid<br />

values are none, all, and explicit. The default value is explicit.<br />

The following sections describe these parameters in detail.<br />

The defType Parameter<br />

<strong>Apache</strong> <strong>Solr</strong> <strong>Reference</strong> <strong>Guide</strong> <strong>6.0</strong><br />

245

Hooray! Your file is uploaded and ready to be published.

Saved successfully!

Ooh no, something went wrong!