<cfsearch>

Executes searches against data indexed

This tag cannot have a body.

This tag is also supported within <cfscript>


		<cfsearch
    name=string
    collection=string
    type=string
    criteria=string
    maxRows=number
    startRow=number
    external=boolean
    language=string
    category=string
    categoryTree=string
    status=string
    suggestions=string
    contextPassages=number
    contextPassageLength=number
    contextBytes=number
    contextHighlightBegin=string
    contextHighlightEnd=string
    previousCriteria=string
>

Attribute	Description
name _{string, required}	edit A name for the search query.
collection _{string, required}	edit The logical collection name that is the target of the search operation or an external collection with fully qualified path.
type _{string, optional}	edit Specifies the criteria type for the search.
criteria _{string, optional}	edit Specifies the criteria for the search following the syntactic rules specified by type.
maxRows _{number, optional}	edit Specifies the maximum number of entries for index queries. If omitted, all rows are returned.
startRow _{number, optional}	edit Specifies the first row number to be retrieved. Default is 1.
category _{string, optional}	edit A list of categories, separated by commas, to which the search is limited. If specified, and the collection does not have categories enabled, Lucee throws an exception.
categoryTree _{string, optional}	edit The location in a hierarchical category tree at which to start the search. Lucee searches at and below this level. If specified, and the collection does not have categories enabled, Lucee throws an exception. Can be used in addition to category attribute.
status _{string, optional}	edit Specifies the name of the structure variable into which Lucee places search information, including alternative criteria suggestions (spelling corrections).
suggestions _{string, optional}	edit Specifies whether Lucene returns spelling suggestions for possibly misspelled words.
contextPassages _{number, optional}	edit The number of passages/sentences Lucene returns in the context summary (that is, the context column of the results). Default: 3
contextPassageLength _{number, optional}	edit Used as a guide for splitting the text into paragraphs. The splitter tries to keep paragraphs close to this length while maintaining natural text boundaries. Note that paragraphs may exceed this length if no suitable break point is found. Default: 150
contextBytes _{number, optional}	edit The maximum number of bytes Lucene returns in the context summary. Default: 300
contextHighlightBegin _{string, optional}	edit 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, optional}	edit 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:

Unimplemented Attribute(s)

Attribute	Description
external _{boolean, optional}	edit This attribute has been deprecated and is non-functional. * deprecated *
language _{string, optional}	edit Deprecated. This attribute is now ignored and the language of the collection is used to perform the search. * deprecated *
previousCriteria _{string, optional}	edit 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. * unimplemented *

Examples

edit

There are currently no examples for this tag.

<cfsearch>

Unimplemented Attribute(s)

Examples

See also