ormSearchOffline

Performs search on the indexed properties but returns only the stored fields. For this function to work, specify indexStore=true on the properties on which you want to perform the search.

ormSearchOffline(query_text, entityName, fields_to_be_selected) ormSearchOffline(query_text, entityName, fields_to_be_selected, fields) ormSearchOffline(query_text, entityName, fields_to_be_selected, fields, optionMap); → returns struct

This function requires Adobe ColdFusion 10 and up.  Not supported on Lucee, etc.

Argument Reference

query_text string
Required

The text to be searched for or a complete Lucene query. For details of Lucene query, see http://lucene.apache.org/core/old_versioned_docs/versions/.

entityName string
Required

Name of the entity to be searched.

fields_to_be_selected array
Required

Fields to be returned as keys in the resultant struct.

fields array
Required

Fields in which search has to be performed.

optionMap struct

extra options struct

can be passed while executing Lucene query. The options can be: sort, offset, maxResults

Examples
Sample code invoking the ormSearchOffline function

ormSearchOffline('FirstName:'ch*','Employee',['id','firstname']); 

In the following example, offline search is performed on the property FirstName and first name and last name are returned as keys in the resultant struct.

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

In this example, the resultObj in the query is an array of structs. The individual structs contain all the selected fields (passed as third parameter).

<cfset resultObj = ormSearchOffline('Java Rocks', 'Book', [bookId, summary, Author.name, title],[title, short_summary])> 

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

Fork me on GitHub