Railo 4.2 Reference
Choose a tag:

Tag <CFSEARCH>

Executes searches against data indexed

Body

This tag can't have a body.

Example

	<cfsearch
[category="string"]
[categorytree="string"]
collection="string"
[contextbytes="number"]
[contexthighlightbegin="string"]
[contexthighlightend="string"]
[contextpassages="number"]
[criteria="string"]
[external="boolean"]
[language="string"]
[maxrows="number"]
name="string"
[previouscriteria="string"]
[startrow="number"]
[status="string"]
[suggestions="string"]
[type="string"]>
This tag is also supported within cfscript
	<cfscript>
search
[category="string"]
[categorytree="string"]
collection="string"
[contextbytes="number"]
[contexthighlightbegin="string"]
[contexthighlightend="string"]
[contextpassages="number"]
[criteria="string"]
[external="boolean"]
[language="string"]
[maxrows="number"]
name="string"
[previouscriteria="string"]
[startrow="number"]
[status="string"]
[suggestions="string"]
[type="string"];
</cfscript>

Attributes

The attributes for this tag are fixed. Except for the following attributes no other attributes are allowed.
Name Type Required Description
category string No A list of categories, separated by commas, to which
the search is limited. If specified, and the collection
does not have categories enabled, Railo

throws an exception. 
categorytree string No The location in a hierarchical category tree at which
to start the search. Railo searches at and
below this level. If specified, and the collection does
not have categories enabled, Railo throws an
exception. Can be used in addition to category
attribute. 
collection string Yes The logical collection name that is the target of the search operation or an external collection
with fully qualified path. 
contextbytes number No The maximum number of bytes Lucene returns in the
context summary.
Default: 300 
contexthighlightbegin string No The HTML to prepend to search terms in the context
summary. Use this attribute in conjunction with
contextHighlightEnd to highlight search terms in the
context summary.
Default:  
contexthighlightend string No The HTML to prepend to search terms in the context
summary. Use this attribute in conjunction with
contextHighlightEnd to highlight search terms in the
context summary.
Default:  
contextpassages number No The number of passages/sentences Lucene returns in
the context summary (that is, the context column of
the results).
Default: 3 
criteria string No Specifies the criteria for the search following the syntactic rules specified by type. 
external boolean No This Attribute is deprecated 
language string No This Attribute is deprecated 
maxrows number No Specifies the maximum number of entries for index queries. If omitted, all rows are returned. 
name string Yes A name for the search query. 
previouscriteria string No The name of a result set from an existing set of search
results. Lucene searches the result set for criteria
without regard to the previous search score or rank.
Use this attribute to implement searching within result
sets. 
startrow number No Specifies the first row number to be retrieved. Default is 1. 
status string No Specifies the name of the structure variable into
which Railo places search information, including
alternative criteria suggestions (spelling corrections). 
suggestions string No Specifies whether Lucene returns spelling suggestions
for possibly misspelled words. 
type string No Specifies the criteria type for the search.