name
string, required
|
A name for the search query.
|
collection
string, required
|
The logical collection name that is the target of the search operation or an external collection with fully qualified path.
|
type
string, optional
|
Specifies the criteria type for the search.
|
criteria
string, optional
|
Specifies the criteria for the search following the syntactic rules specified by type.
|
maxrows
number, optional
|
Specifies the maximum number of entries for index queries. If omitted, all rows are returned.
|
startrow
number, optional
|
Specifies the first row number to be retrieved. Default is 1.
|
category
string, optional
|
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
|
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
|
Specifies the name of the structure variable into which Lucee places search information, including alternative criteria suggestions (spelling corrections).
|
suggestions
string, optional
|
Specifies whether Lucene returns spelling suggestions for possibly misspelled words.
|
contextpassages
number, optional
|
The number of passages/sentences Lucene returns in the context summary (that is, the context column of the results). Default: 3
|
contextbytes
number, optional
|
The maximum number of bytes Lucene returns in the context summary. Default: 300
|
contexthighlightbegin
string, optional
|
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
|
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:
|