You are viewing a plain text version of this content. The canonical link for it is here.
Posted to solr-commits@lucene.apache.org by Apache Wiki <wi...@apache.org> on 2006/09/08 02:24:57 UTC

[Solr Wiki] Update of "CommonQueryParameters" by HossMan

Dear Wiki user,

You have subscribed to a wiki page or wiki category on "Solr Wiki" for change notification.

The following page has been changed by HossMan:
http://wiki.apache.org/solr/CommonQueryParameters

The comment on the change is:
pulling common stuff over from StandardRequestHandler

New page:
The following list of parameters are supported by both the DisMaxRequestHandler and the StandardRequestHandler.  Allthough they are not mandatory, it is strongly encouraged that all Future !SolrRequestHandlers support them as well.  [http://incubator.apache.org/solr/docs/api/org/apache/solr/util/SolrPluginUtils.html Some Utilities] exist to make implementing them easy.

[[TableOfContents]]


== start ==

This parameter is used to paginate results from a query.  When specified, it indicates the offset in the complete result set for the queries where the set of returned documents should begin. 

The default value is "`0`".

== rows ==

This parameter is used to paginate results from a query.  When specified, it indicates the maximum number of documents from the complete result set to return to the client.

The default value is "`10`"

== fl ==

This parameter can be used to specify a set of fields to use to limit the amount of information in the response.  When returning the results to the client, only fields in this list will be included.

This list can be specified as a space (or comma) separated list of field names.  The string "`score`" can be used to indicate that the score of each document for the particular query should be returned as a field, and the string "`*`" can be used to indicate all stored fields the document has.


||||'''Examples'''||
||'''Field List'''||'''Meaning'''||
||`id name price`||Only return the "id" field and the "name" field||
||`id,name,price`||Same as above||
||`id name, price`||Same as above||
||`id score`||Return the "id" field and the score||
||`*`||Return any fields the documents have||
||`* score`||Return any fields the document has, along with the score||


The default value is "`*`"

== debugQuery ==

If this parameter is present (regardless of it's value) then additional debugging information will be included in the response, including "explain" info for each of the documents returned.  This debugging info is meant for human consumption... it's XML format could change in the future.

The default behavior is not to include debugging info.

== explainOther ==

This parameter allows clients to specify a Lucene query to identify a set of documents.  If non-blank, the explain info of each document which matches this query, relative the ''main query'' (specified by the q parameter) will be returned along with the rest of the debugging information.

The default value is blank (i.e. no extra explain info will be returned)