ormSearch

Searches for given text in specific properties or entities.

ormSearch('query_text', 'entityName') ormSearch('query_text', 'entityName', fields) ormSearch('query_text', 'entityName', fields, optionMap); → returns struct

This function requires Adobe ColdFusion 10 and up.  Not supported on Lucee, etc.
  1. CFDocs
  2. Functions
  3. ColdFusion 10 New Functions and Tags
  4. ormSearch
  5. CF10+
  6. 0 Issue
  7. Edit

Argument Reference

query_text string
Required

The text to be searched for or a complete Lucene query.In the case of ORMSearch('query_text', 'entityName'), only Lucene query is supported. For details of Lucene query, see http://lucene.apache.org/core/old_versioned_docs/versions/3_0_0/queryparsersyntax.html

entityName string
Required

Name of the entity to be searched.

fields array
Required

Fields in which search has to be performed. This can be an array of strings. If you are performing a Lucene query, you need not specify this field. In other words, if you do not specify this value, a Lucene query is performed. Field name is case-sensitive.

optionMap struct
Required

Extra options that can be passed while executing Lucene query. The options are: Sort, Offset, maxResults

Examples
Sample code invoking the ormSearch function

ORM search based on Lucene query.

ormSearch('FirstName:ch*','Employee'); 
 ormSearch('ch*','Employee',['FirstName']); 
 objs = ormSearch('FirstName:ch*','Employee',[],{sort='salary',maxresults=5,offset=2});

ORM search on multiple entities.

ormSearch('john*','DeveloperEntity,UserEntity',['firstname']);

ORM search on all subentities based on Lucene query

ormSearch('john*','EmployeeEntity',['FirstName']);

ORM search in relationships

ormSearch('CategoryID.CategoryName:In*','cproducts',[]);

Signup for cfbreak to stay updated on the latest news from the ColdFusion / CFML community. One email, every friday.

Fork me on GitHub