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 A struct that contains the following: an array of structs or maxTotalRecord.

This function requires Adobe ColdFusion. Not supported on Lucee, OpenBD, etc.

ORMSearch Argument Reference

query_text
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
Required

Name of the entity to be searched.

fields
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
Required

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

Examples sample code invoking the ORMSearch function


Tag Syntax

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});

Tag Syntax

ORM search on multiple entities.

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

Tag Syntax

ORM search on all subentities based on Lucene query

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

Tag Syntax

ORM search in relationships

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

Fork me on GitHub