Whatever message this page gives is out now! Go check it out!
ORMSearchOffline
Last update:
May 18, 2026
Description
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.
History
ColdFusion 10: Added this function
Returns
A struct that contains the following:
- An array of structs (with the entity and score being the keys) in the following format:
data -[{entity: entity1, score: entity1_score}, {entity: entity2, score: entity2_score}, ..... ]- maxTotalRecord (number of possible results)
- fields_to_be_selected as keys.
Syntax
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);Parameters
Parameter | Description |
query_text | 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 | Name of the entity to be searched. |
fieldss_to_be_selected | Fields to be returned as keys in the resultant struct. |
fields | Fields in which search has to be performed. |
optionMap | Extra options that can be passed while executing Lucene query. The options can be:
|
Example 1
ORMSearchOffline('FirstName:"ch*"',"Employee",["id","firstname"]);Example 2
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});Example 3
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])>
We're glad. Tell us how this page helped.
We're sorry. Can you tell us what didn't work for you?
Share additional feedback to help us improve.
0/255
|
