Hibernate changed how many applications are written. With its inclusion in ColdFusion 9, ORM has changed how many ColdFusion applications are written. This session will cover first why searching via ORM may benefit applications. Secondly the session will cover the many options for how to configure the search options and perform searches. Presented at cf.Objective() 2012.

1. Searching ORM
Sam Farmer

2. Me

3. Me
Senior Applications Architect at FirstComp

4. Me
Senior Applications Architect at FirstComp
ColdFusion, JavaScript, yada, yada...

5. Me
Senior Applications Architect at FirstComp
ColdFusion, JavaScript, yada, yada...
Hobbies:

6. Me
Senior Applications Architect at FirstComp
ColdFusion, JavaScript, yada, yada...
Hobbies:
Soccer. Play and Arsenal fan.

7. Me
Senior Applications Architect at FirstComp
ColdFusion, JavaScript, yada, yada...
Hobbies:
Soccer. Play and Arsenal fan.
Code. oldjam.com

8. Me
Senior Applications Architect at FirstComp
ColdFusion, JavaScript, yada, yada...
Hobbies:
Soccer. Play and Arsenal fan.
Code. oldjam.com
Live in Washington, DC with my wife and two
daughters

9. Agenda

10. Agenda
Why search

11. Agenda
Why search
Pre-CF10 Enterprise

12. Agenda
Why search
Pre-CF10 Enterprise
With CF10 Enterprise

14. Other Sessions
A/B Testing with Squabble (Mark Mandel)
Creating ColdFusion Builder Extensions (Simon Free)
Authentication made Easy using Twitter, Facebook,
Google, and more (Billy Cravens)
Node.js and You - Server Side Javascript (Simon
Bateman)

15. Who likes Objects?

17. Who likes Objects?

18. Who likes cf.Objective()?

19. Who likes ORM?

20. Using or planning to use
CF10?

21. Retrieving Objects
Based on criteria

22. entityLoad( "user", 1 );
ormExecuteQuery( "FROM user
WHERE state = 'DC' or state='NE' ");

23. Why Searching
Get what you are looking for

24. 1998

25. flickr.com/photos/crystaleagle/

26. flickr.com/photos/crystaleagle/

27. That star looking
shape
flickr.com/photos/crystaleagle/

28. That star looking
shape
flickr.com/photos/crystaleagle/

29. That star looking
shape
flickr.com/photos/crystaleagle/

30. That star looking
shape
flickr.com/photos/crystaleagle/

31. What we used to have

33. Now we have

36. Search
Lets look at the options

37. Artist and Art
one-to-many
artist art

38. Looking for
Michael Mychael Face of
by Night Mikael

39. Like
Everything has its place

40. LIKE

41. LIKE
Don't snicker

42. LIKE
Don't snicker
Premature optimization

43. With HQL

44. With HQL
Similar to SQL

45. <cfquery dbtype="hql" name="getArt">
FROM ART
WHERE name like
<cfqueryparam value="Mi%">
</cfquery>

46. With Hibernate Criteria API

47. With Hibernate Criteria API
More "object-ey"

48. order = createObject( 'java',
"org.hibernate.criterion.Order" );
Restrictions = createObject( 'java',
"org.hibernate.criterion.Restrictions" );

49. order = createObject( 'java',
"org.hibernate.criterion.Order" );
Restrictions = createObject( 'java',
"org.hibernate.criterion.Restrictions" );
artSearch = ormGetSession().createCriteria( "art" );
artSearch.add( Restrictions.like( "name", "Mi%" ) );
artSearch.addOrder( order.asc( "name" ) );
getArt = artSearch.list();
writeDump( getArt );

50. order = createObject( 'java',
"org.hibernate.criterion.Order" );
Restrictions = createObject( 'java',
"org.hibernate.criterion.Restrictions" );
artSearch = ormGetSession().createCriteria( "art" );
artSearch.add( Restrictions.like( "name", "Mi%" ) );
artSearch.addOrder( order.asc( "name" ) );
getArt = artSearch.list();
writeDump( getArt );

51. (If you like
look at
ColdBox)
coldbox.org

52. Search Engines
Lets look at the options

53. Database (Full Text Search)
Options

54. Database (Full Text Search)
Options
I couldn't make work

55. Database (Full Text Search)
Options
I couldn't make work
Smarter people may have

56. Database (Full Text Search)
Options
I couldn't make work
Smarter people may have
Or, double query to

57. Database (Full Text Search)
Options
I couldn't make work
Smarter people may have
Or, double query to
get Ids

58. Database (Full Text Search)
Options
I couldn't make work
Smarter people may have
Or, double query to
get Ids
get entities

59. Apache Lucene
A "flagship sub-project"

60. "Our core algorithms along
with the Solr search server
power applications the world
over, ranging from mobile
devices to sites like Twitter,
Apple and Wikipedia."

61. "Our core algorithms along
with the Solr search server
power applications the world
over, ranging from mobile
devices to sites like Twitter,
Apple and Wikipedia."
And soon your apps! :)

62. Lucene & Solr

63. Lucene & Solr
Both from Apache

64. Lucene & Solr
Both from Apache
Solr is a servlet

65. Lucene & Solr
Both from Apache
Solr is a servlet
Lucene is an index

66. Lucene & Solr
Both from Apache
Solr is a servlet
Lucene is an index

67. Lucene & Solr
Both from Apache
Solr is a servlet
Lucene is an index
Solr needs Lucene but Lucene does not need Solr

68. What can Lucene do?

69. What can Lucene do?
Fuzzy

70. What can Lucene do?
Fuzzy
Words near each other

71. What can Lucene do?
Fuzzy
Words near each other
Boost

72. What can Lucene do?
Fuzzy
Words near each other
Boost
Range

73. SolrEntity

74. SolrEntity
Nathan Mische proof of concept

75. SolrEntity
Nathan Mische proof of concept
‣ http://cfml.us/z3

76. How it works

77. How it works
Base cfc

78. How it works
Base cfc
Metadata defines configuration

79. How it works
Base cfc
Metadata defines configuration
Event Handlers

80. How it works
Base cfc
Metadata defines configuration
Event Handlers
postUpdate(), postInsert(), postDelete()

81. How it works
Base cfc
Metadata defines configuration
Event Handlers
postUpdate(), postInsert(), postDelete()
update Solr

82. Entry.cfc
component persistent="true" table="entry"
extends="SolrEntity" solrcollection="blog" {
property name="entryid" fieldtype="id"
generator="native" solrfield="key";
property name="author" fieldtype="many-to-one"
fkcolumn="authorid" cfc="Author";
property name="title" solrfield="title";
property name="content" solrfield="body";
}

83. ColdFusion 10 ORM Search
Putting the pieces together

84. searchArt = ormSearch("name:Mi*", "art" );

85. searchArt = ormSearch("name:Mi*", "art" );
writeDump( var=searchArt, top=3, showudfs=false );

86. searchArt = ormSearch("name:Mi*", "art" );
writeDump( var=searchArt, top=3, showudfs=false );

87. searchArt = ormSearch("name:Michael~", "art" );

88. searchArt = ormSearch("name:Michael~", "art" );

89. Lucene Query Syntax

90. Lucene Query Syntax
This is the "magic"

91. Lucene Query Syntax
This is the "magic"
http://cfml.us/Ax

92. Wildcard Searches

93. Wildcard Searches
? = one character

94. Wildcard Searches
? = one character
Arsen?l (finds Arsenal)

95. Wildcard Searches
? = one character
Arsen?l (finds Arsenal)
* = many characters

96. Wildcard Searches
? = one character
Arsen?l (finds Arsenal)
* = many characters
Can't be first

97. Wildcard Searches
? = one character
Arsen?l (finds Arsenal)
* = many characters
Can't be first
Arse*

98. Wildcard Searches
? = one character
Arsen?l (finds Arsenal)
* = many characters
Can't be first
Arse*
Ar*al

99. Fuzzy Searches ~

100. Fuzzy Searches ~
~ will find similar spellings

101. Fuzzy Searches ~
~ will find similar spellings
Arsenal~ (finds Arsenal)

102. Fuzzy Searches ~
~ will find similar spellings
Arsenal~ (finds Arsenal)
~0-1 indicates how similar

103. Fuzzy Searches ~
~ will find similar spellings
Arsenal~ (finds Arsenal)
~0-1 indicates how similar
0=least similar, 0.5=default, 1=most similar

104. Fuzzy Searches ~
~ will find similar spellings
Arsenal~ (finds Arsenal)
~0-1 indicates how similar
0=least similar, 0.5=default, 1=most similar
Arsenal~0.1

105. Fuzzy Searches ~
~ will find similar spellings
Arsenal~ (finds Arsenal)
~0-1 indicates how similar
0=least similar, 0.5=default, 1=most similar
Arsenal~0.1
Arsenal~1

106. Boost ^

107. Boost ^
^ boost makes one term more important/relevant

108. Boost ^
^ boost makes one term more important/relevant
Arsenal^6 Chelsea (makes Arsenal more
relevant)

109. Boost ^
^ boost makes one term more important/relevant
Arsenal^6 Chelsea (makes Arsenal more
relevant)
^0.1-99 indicates how much more relevant

110. Boost ^
^ boost makes one term more important/relevant
Arsenal^6 Chelsea (makes Arsenal more
relevant)
^0.1-99 indicates how much more relevant
1 = default

111. Boost ^
^ boost makes one term more important/relevant
Arsenal^6 Chelsea (makes Arsenal more
relevant)
^0.1-99 indicates how much more relevant
1 = default
Normally whole numbers

112. Proximity Searches ~9

113. Proximity Searches ~9
Find two words close to each other

114. Proximity Searches ~9
Find two words close to each other
"one two"~NUM where NUM is how close

115. Proximity Searches ~9
Find two words close to each other
"one two"~NUM where NUM is how close
"Arsenal Champions"~6 (finds Arsenal)

116. Proximity Searches ~9
Find two words close to each other
"one two"~NUM where NUM is how close
"Arsenal Champions"~6 (finds Arsenal)

117. How it works

118. ColdFusion / JVM
Database

119. ColdFusion / JVM
Hey Lucene can you look this up?
Database

120. ColdFusion / JVM
Hey Lucene can you look this up?
Sure, here are matching Ids
Database

121. ColdFusion / JVM
Hey Lucene can you look this up?
Sure, here are matching Ids
Thanks! Hibernate entities please Database

122. ColdFusion / JVM
Hey Lucene can you look this up?
Sure, here are matching Ids
Thanks! Hibernate entities please Database
Sure, hey database can I get data?

123. ColdFusion / JVM
Hey Lucene can you look this up?
Sure, here are matching Ids
Thanks! Hibernate entities please Database
Sure, hey database can I get data?
Most def.
SELECT blah
FROM table
WHERE Id
= 999

124. ColdFusion / JVM
Hey Lucene can you look this up?
Sure, here are matching Ids
Thanks! Hibernate entities please Database
Sure, hey database can I get data?
Most def.
Here you go SELECT blah
FROM table
WHERE Id
= 999

125. Let's see that...

126. Is it slow?

127. Is it slow?
Two fast operations

128. Is it slow?
Two fast operations
Lucene search

129. Is it slow?
Two fast operations
Lucene search
Look up by Ids

130. Is it slow?
Two fast operations
Lucene search
Look up by Ids
Load Testing

131. Skip the database

132. Skip the database
ormSearchOffline()

133. Skip the database
ormSearchOffline()
Returns only fields specified by indexStore

134. searchArt = ormSearchOffline("name:Michael~", "ART",
["id","name"] );

135. searchArt = ormSearchOffline("name:Michael~", "ART",
["id","name"] );
writeDump( var=searchArt, top=3, showudfs=false );

136. searchArt = ormSearchOffline("name:Michael~", "ART",
["id","name"] );
writeDump( var=searchArt, top=3, showudfs=false );

137. Setup

138. Application.cfc
component {
this.name = "ormSearchCriteria";
this.datasource = "cfartgallery";
this.ormEnabled = true;
this.ormSettings = {
searchEnabled = true | false,
search = { [autoIndex = true],
[indexDir = filepath],
[language = "english"] }
};
}

139. MP LES
Application.cfc IN SA
USED
component {
this.name = "ormSearchCriteria";
this.datasource = "cfartgallery";
this.ormEnabled = true;
this.ormSettings = {
searchEnabled = true,
search = { autoIndex = true },
logsql = true
};
this.invokeImplicitAccessor = true;
}

140. Entity - Attributes
component persistent = true
indexable = true | false
indexLanguage = "english"
autoIndex = true | false {

141. Entity - Properties
component persistent = true
indexable = true {
property name="name"
indexable = true | false
indexTokenized = true | false
indexFieldName = ""
indexBoost = 0-1
indexStore = true | false | compressed
indexLanguage = "english"

142. MP LES
Art.cfc IN SA
USED
component persistent="true" indexable="true" {
property name="id" column="ARTID" fieldtype="id";
property name="name" column="ARTNAME"
ormtype="string"
indexable="true" indexStore="true";
property name="description" ormtype="text"
indexable="true";
property name="price" ormtype="double"
indexable="true";
property name="largeimage" ormtype="string";
property name="mediaid" ormtype="int";
property name="issold" ormtype="boolean";
property name="artist" fieldtype="many-to-one" cfc="artist";

143. Indexes

144. Creation and Update

145. Creation and Update
Automatic on all entity operations

146. Creation and Update
Automatic on all entity operations
Build

147. Creation and Update
Automatic on all entity operations
Build
Lucene is fast

148. Maintenance

149. Maintenance
Changes to properties indexed

150. Maintenance
Changes to properties indexed
Functions provided act on:

151. Maintenance
Changes to properties indexed
Functions provided act on:
whole index

152. Maintenance
Changes to properties indexed
Functions provided act on:
whole index
entities

153. Maintenance
Changes to properties indexed
Functions provided act on:
whole index
entities
entity

154. Maintenance
Changes to properties indexed
Functions provided act on:
whole index
entities
entity
ormIndex() and ormIndexPurge()

155. Pitfalls?
What are the downsides?

156. Pitfalls
Enterprise only
Single server (at the moment)

157. What can we do now?
Add intelligent search to our apps

158. Guess vs Guide
Make your own search algorithm
Use Boost, Fuzzy and others
Refine

160. Thank you!
Q&A
@sam_farmer
sam@samfarmer.com
www.samfarmer.com