cfsearch

Overview ColdFusion Open BlueDragon Lucee

Searches Solr collections (CFML can also search collections that have not been registered, with the cfcollection tag.) A collection must be created and indexed before this tag can return search results.

Attributes

Name Required Type Default Description
category No String A list of categories, separated by commas, to which the search is limited. If specified, and the collection does not have categories enabled, ColdFusion throws an exception.
categorytree No String The location in a hierarchical category tree at which to start the search. ColdFusion searches at and below this level. If specified, and the collection does not have categories enabled, ColdFusion throws an exception. Can be used in addition to category attribute.
collection Yes String One or more collection names. You can specify more than one collection unless you are performing a category search (that is, specifying category or categoryTree). One or more collection names. You can specify more than one collection unless you are performing a category search (that is, specifying category or categoryTree).
contents No flag to determine if the CONTENT column is return; If you are storing the full body, this lets you return that full body or not in the query. defaults to true
contextbytes No Numeric 300 The maximum number of bytes Solr returns in the context summary. Default: 300
contexthighlightbegin No String 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 No String 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:
contexthighlightstart No the start marker for the contextual piece
contextpassages No Numeric 3 The number of passages/sentences Solr returns in the context summary (that is, the context column of the results). Default: 3
criteria No String Search criteria. Follows the syntax rules of the type attribute. If you pass a mixed-case entry in this attribute, the search is case-sensitive. If you pass all uppercase or all lowercase, the search is case-insensitive.
external No Yes or No. Yes indicates that the collection you are searching was created outside of ColdFusion using native Verity indexing tools. The default is No.
8
language No String Deprecated. This attribute is now ignored and the language of the collection is used to perform the search.
maxrows No Numeric all Maximum number of rows to return in query results. Default: all
minscore No minimum score of the document to be included in the result query. A value between 0.0 and 10.0 is required. Defaults to 0 (all results that match)
name Yes String Name of the search query.
10
orderBy No String Name of column(s), search result ahould be sorted by
previouscriteria No String The name of a result set from an existing set of search results. Solr searches the result set for criteria without regard to the previous search score or rank. Use this attribute to implement searching within result sets.
10
searchcolumns No String Specify column names in the search result
10
searchtime No String Timeout value for the search operation
startrow No Numeric 1 First row number to get. Default: 1
status No String Specifies the name of the structure variable into which ColdFusion places search information, including alternative criteria suggestions (spelling corrections).
suggestions No String never Specifies whether SOLR returns spelling suggestions for possibly misspelled words.
type No String standard Used to specify the parser that SOLR uses to process the criteria.
uniquecolumn No name of the column that will be checked to see if it is unique before adding to the result query