Let ColdFusion ORM do the work for you!
2 likes1,452 views
This document is a presentation on ColdFusion ORM (Object-Relational Mapping) that outlines its benefits, implementation, and advanced features in web development. It covers topics such as configuration, CRUD operations, relationships between entities, performance improvements, and additional resources. The importance of ORM in reducing development complexity and managing data persistence in applications is emphasized throughout the document.
![Additional ORM SettingsAdditional ORM Settings
Application.cfc
// ORM settings
this.ormsettings = {
cfclocation = ["model/beans"],
dbcreate = "update",
dialect = "MySQL",
datasource = "ORMds",
useDBForMapping = false
}](https://image.slidesharecdn.com/coldfusion-orm-presentation-cfsummit2018-181003180331/85/Let-ColdFusion-ORM-do-the-work-for-you-12-320.jpg)
![SQL Injection PreventionSQL Injection Prevention
Same as:
Better:
Or:
// get user by ID
userid = 123;
EntityLoadByPK("User", id);
// get user by ID with HQL
ORMExecuteQuery("from User where id = #userid#", true);
// get user by ID with HQL using positional parameters
ORMExecuteQuery("from User where id = ?", [userid], true);
// get user by ID with HQL using named parameters
ORMExecuteQuery("from User where id = :id", {id=userid}, true);](https://image.slidesharecdn.com/coldfusion-orm-presentation-cfsummit2018-181003180331/85/Let-ColdFusion-ORM-do-the-work-for-you-37-320.jpg)
![HQL ExamplesHQL Examples
ORMExecuteQuery(hql, params [,unique] [,queryOptions])
// get users with usernames that start with letter J
q = ORMExecuteQuery(
"from user where username like :prefix", {prefix = "J%"}
);
// get art pieces priced over $400
q = ORMExecuteQuery(
"from art where price > :lowprice", {lowprice = 400}
);
// adding queryOptions
q = ORMExecuteQuery(
"from artist", false, {offset=5, maxresults=10, timeout=5}
);](https://image.slidesharecdn.com/coldfusion-orm-presentation-cfsummit2018-181003180331/85/Let-ColdFusion-ORM-do-the-work-for-you-38-320.jpg)
Let ColdFusion ORM do the work for you!
- 1. Let ColdFusion ORM doLet ColdFusion ORM do the work for you!the work for you! CFSummit 2018CFSummit 2018 Presenter: Masha EdelenPresenter: Masha Edelen
- 2. Who am I?Who am I? Full Stack Web Developer of 16+ years HD Web Studio Owner and Visionary Mother to a Teenage Daughter Travel Enthusiast Live Music Fan Amateur Latin Dancer
- 4. AgendaAgenda Introduction to ORM Getting Started Relationships HQL Gotchas Advanced Features Resources
- 5. What is ORM?What is ORM? http://help.adobe.com/en_US/ColdFusion/9.0/Developing/WSD628ADC4-A5F7-4079-99E0-FD725BE9B4BD.html Object relational mapping (ORM) is a programming framework that allows you to define a mapping between application object model and the relational database.
- 6. ORM Implementaion in ColdFusionORM Implementaion in ColdFusion Hibernate 5.3 - current stable ColdFusion 2018 - Hibernate 5.2 ColdFusion 2016 - Hibernate 4.3 ColdFusion 11 - Hibernate 4.1 ColdFusion 10 - Hibernate 3.5 ColdFusion 9 - Hibernate 3.5 Lucee - Hibernate 3.5
- 7. Why should I use an ORM?Why should I use an ORM? Reduces development time Overcomes vendor specific SQL differences Promotes effective design patterns Reduces maintenance
- 8. Potential DownsidePotential Downside Without proper tuning performance can suffer. Make sure you optimize queries and use effective caching strategy!
- 9. Getting StartedGetting Started Step 1: Configuring ORM in your Application Application.cfc component { // set the unique name of the application this.name = "myCMS"; // set the datasource this.datasource = "mydsn"; // turn ORM on this.ormenabled = true; }
- 10. Step 2: Mapping Tables to Objects Article.cfc /*** I model a blog article ***/ component persistent="true" table="articles" { // identifier property name="id" fieldtype="id" generator="native" column="articleI // properties property name="title" ormType="string" length="250"; property name="summary" ormType="string" length="500"; property name="description" ormType="text"; }
- 12. Additional ORM SettingsAdditional ORM Settings Application.cfc // ORM settings this.ormsettings = { cfclocation = ["model/beans"], dbcreate = "update", dialect = "MySQL", datasource = "ORMds", useDBForMapping = false }
- 13. ORMReload()ORMReload() // ORM reload on URL if (structKeyExists(url,"reloadORM")) { ORMReload(); }
- 14. CRUDCRUD Source: http://docs.jboss.org/hibernate/orm/4.1/quickstart/en-US/html/pr01.html Hibernate’s design goal is to relieve the developer from 95% of common data persistence-related programming tasks by eliminating the need for manual, hand-crafted data processing using SQL and JDBC.
- 15. CreateCreate // Create music category myCategory = EntityNew("Category"); myCategory.setTitle("Music"); EntitySave(myCategory); // Create sports category myCategory = EntityNew("Category", {title:"Sports"}); EntitySave(myCategory); // Create family category myCategory = new model.Category(title="Family"); EntitySave(myCategory); // Create holiday category myCategory = EntityNew("Category"); myCategory.title = "Holiday"; EntitySave(myCategory);
- 16. ReadRead UpdateUpdate DeleteDelete // Get all categories categories = EntityLoad("Category"); WriteDump(var = categories, top = 2); // Get category and update its title myCategory = EntityLoadByPK("Category", 1); myCategory.setTitle("New Title"); // Delete category myCategory = EntityLoadByPK("Category", 1); EntityDelete(myCategory);
- 17. More ExamplesMore Examples // Get all categories set to display categories = EntityLoad("Category", {dsp = true}); // Get all categories set to display and ordered chronologically categories = EntityLoad("Category", {dsp = true}, "date desc");
- 18. More ExamplesMore Examples // Get category by ID myCategory = EntityLoadbyPK("Category",1); // Get category by ID myCategory = EntityLoad("Category",1); myCategory = EntityLoad("Category",1,true);
- 19. Convert Object to QueryConvert Object to Query // Convert object to query myCategory = EntityLoadbyPK("Category",1); myCategoryQuery = EntityToQuery(myCategory); // Convert array of objects to query categories = EntityLoad("Category"); categoriesQuery = EntityToQuery(categories);
- 22. One-to-ManyOne-to-Many Author.cfc /*** I model an Author ***/ component persistent="true" table="authors" { // identifier property name="id" fieldtype="id" generator="native"; // properties property name="firstName" ormtype="string" length="50"; property name="lastName" ormtype="string" length="50"; // one Author can have many Articles property name="articles" fieldtype="one-to-many" cfc="Article" fkcolumn="fk_authorid" type="array" singularname="article"; }
- 24. One-to-Many UsageOne-to-Many Usage // Create a new article and add to an existing author transaction { // load the author author = EntityLoadByPK("author", 1); // create an article article = EntityNew("article"); article.setTitle("ORM Makes My Life Easy!"); // attach the article to the author author.addArticle(article); // save the article EntitySave(article); }; writeDump(author.getArticles(), top="2");
- 25. Many-to-OneMany-to-One Article.cfc /*** I model an article ***/ component persistent="true" table="articles" { // identifier property name="id" fieldtype="id" generator="native"; ... //many Article entities can have one Author entity property name="Author" fieldtype="many-to-one" cfc="Author" fkcolumn="fk_authorid"; }
- 27. Many-to-ManyMany-to-Many Category.cfc /*** I model a category ***/ component persistent="true" table="categories" { //identifier property name="id" fieldtype="id" generator="native"; ... //category can be assigned to more than one article property name="articles" fieldtype="many-to-many" cfc="Articles" type="array" singularname="article" linktable="articles_categories"; }
- 29. OO Modeling is Key!OO Modeling is Key! ORM Persistence Model is a set of ORM Entities related based on business logic of the application. Objects vs Tables Persistence Model vs Database Schemas Data + Behavior vs Data
- 30. The Inverse AttributeThe Inverse Attribute Author.cfc /*** I model an author ***/ component persistent="true" table="authors" { ... // one author can have many articles property name="articles" fieldtype="one-to-many" cfc="Article" fkcolumn="fk_authorid" type="array" singularname="article" // added attributes inverse="true" cascade="delete"; }
- 31. Cascading StrategiesCascading Strategies none delete save-update all delete-orphan all-delete-orphan
- 32. Sort OrderSort Order Author.cfc /*** I model an author ***/ component persistent="true" table="authors" { ... // one author can have many articles property name="articles" fieldtype="one-to-many" cfc="Article" fkcolumn="fk_authorid" type="array" singularname="article" inverse="true" cascade="delete" // added sorting orderby="datepublished desc"; }
- 33. Where FilterWhere Filter Author.cfc /*** I model an author ***/ component persistent="true" table="authors" { ... // getting only published articles property name="publishedArticles" fieldtype="one-to-many" cfc="Article" fkcolumn="fk_authorid" orderby="datepublished desc" // filter where="ispublished = 1"; }
- 34. FormulasFormulas Author.cfc /*** I model an author ***/ component persistent="true" table="authors" { ... // get count of active articles property name="publishedArticleCount" setter="false" formula="select count(*) from Articles a where author_pk = a.fk_authorid and a.ispublished = 1"; }
- 35. HQLHQL
- 36. HQLHQL Same as: // get users EntityLoad("User"); // get users with HQL ORMExecuteQuery("from User");
- 37. SQL Injection PreventionSQL Injection Prevention Same as: Better: Or: // get user by ID userid = 123; EntityLoadByPK("User", id); // get user by ID with HQL ORMExecuteQuery("from User where id = #userid#", true); // get user by ID with HQL using positional parameters ORMExecuteQuery("from User where id = ?", [userid], true); // get user by ID with HQL using named parameters ORMExecuteQuery("from User where id = :id", {id=userid}, true);
- 38. HQL ExamplesHQL Examples ORMExecuteQuery(hql, params [,unique] [,queryOptions]) // get users with usernames that start with letter J q = ORMExecuteQuery( "from user where username like :prefix", {prefix = "J%"} ); // get art pieces priced over $400 q = ORMExecuteQuery( "from art where price > :lowprice", {lowprice = 400} ); // adding queryOptions q = ORMExecuteQuery( "from artist", false, {offset=5, maxresults=10, timeout=5} );
- 39. Relationships HQLRelationships HQL Get articles by Author ID: The HQL way: // load author author = EntityLoadByPK("Author", 2); // get this author's articles articles = author.getArticles(); from article where author.id = :authorID
- 40. Relationships HQLRelationships HQL Get published articles by Author ID: Get unique authors: from article where author.id = :authorID and ispublished = :isPublished select distinct a.author from article a where a.ispublished = :isPublished
- 41. Hash MapsHash Maps select new map(id as ID, title as TITLE) from Article order by title
- 42. From Love to Hate?From Love to Hate?
- 43. ErrorsErrors Error during DDL export Cannot simultaneously fetch multiple bags Failed to lazily initialize a collection of role, no session or session was closed Illegal attempt to dereference collection
- 45. LoggingLogging {cfinstall}cfusionlog4j.properties log4j.logger.org.hibernate.type=DEBUG // turn on logging in development this.ormsettings = { ... logSQL = true }
- 46. Hibernate Session ManagementHibernate Session Management ORM session starts when the first CRUD method is called and is closed when the request ends. // manage session manually this.ormsettings = { ... //switch to false and use transactions autoManageSession = false, flushAtRequestEnd = false }
- 47. Performance ImprovementsPerformance Improvements Paging Lazy Loading Fetching Options Batching Caching
- 48. PagingPaging // get 10 artists starting with #6 artists = ORMExecuteQuery( "from artist", false, {offset=5, maxresults=10, timeout=5} )
- 49. Lazy LoadingLazy Loading lazy = "true" (default) lazy = "extra" lazy = "false"
- 50. Fetching OptionsFetching Options fetch = "select" (default) fetch = "join"
- 51. Batch FetchingBatch Fetching At CFC level At collections // implement batching component table="artist" batchsize="10"... ... // get artist as usual getArtist(); // implement batching for related entity property name="art" fieldtype="one-to-many" cfc="art" fkcolumn="artistID" bat ... // get all the art of a specific artist artist.getArt();
- 52. CachingCaching Session Level - built into ORM Second Level - through external caching engine
- 53. Secondary Level CacheSecondary Level Cache EHCache, JBossCache, OSCache, SwarmCache, Tangosol Coherence Cache Application.cfc // activate secondary level cache this.ormSettings.secondaryCacheEnabled = true;
- 54. Secondary Level CacheSecondary Level Cache At CFC level At collections // implement secondary level caching component persistent="true" table="Artist" cacheuse="transactional" ... // implement secondary level caching for related entities property name="art" fieldtype="one-to-many" cfc="art" fkcolumn="artistID" cacheuse="transactional";
- 55. Secondary Level CacheSecondary Level Cache read-only nonstrict-read-write read-write transactional
- 56. Caching HQLCaching HQL // implement caching for HQL query e = ORMExecuteQuery( "from article where id = :id", {id=1}, {cacheable=true, cachename='articles'} );
- 57. Managing the CacheManaging the Cache // clear cache for author ORMEvictEntity( "author" ); ORMEvictEntity( "author", 1 ); // clear cache for articles ORMEvictCollection( "author", "articles" ); ORMEvictCollection( "author", "articles", 1 ); // clear cache for HQL ORMEvictQueries( "mycachename" ); ORMEvictQueries();
- 58. Advanced Use CasesAdvanced Use Cases Query: Retrieve distinct countries of all addresses in alphabetical order. SQL: HQL: Criteria API: select distinct country from address ordered by country select distinct country from address ordered by country criteria.setProjection(projections.distinct(projections.property("Country"))) criteria.addOrder(order.asc("locality"));
- 59. ColdBox ORM ModuleColdBox ORM Module https://www.forgebox.io/view/cborm "This module provides you with several enhancements when interacting with the ColdFusion ORM via Hibernate. It provides you with virtual service layers, active record patterns, criteria and detached criteria queries, entity compositions, populations and so much more to make your ORM life easier! In other words, it makes using ORM not SUCK!"
- 60. There is more!There is more! Convenience Methods Versioning Validation ORM Search Advanced Mapping Event Handlers (Interceptors)
- 61. Online ResourcesOnline Resources Developing Applications Adobe ColdFusion ORM ColdFusion ORM Developer Guide CF-ORM Google Group Hibernate Documentation ORM Slack Channel on CFML Slack Team https://helpx.adobe.com/coldfusion/developing-applications/user-guide.html?topic=/coldfusion/developing-applications/morehelp/coldfusion-orm.ug.js http://adobe.ly/LnJilm http://groups.google.ca/group/cf-orm-dev http://www.hibernate.org/docs
- 62. PublicationsPublications Java Persistence with Hibernate Adobe ColdFusion 9 Web Application Construction Kit, Volume 2: Application Development ColdFusion ORM http://www.manning.com/bauer2/ http://forta.com/books/0321679199/ http://www.coldfusionormbook.com
- 63. Please submit your surveyPlease submit your survey for a chance to win!for a chance to win! Go to the ColdFusion Summit mobile app Find this session: D103: Let ColdFusion ORM do the work for you! Make sure you have registered for this session Select the “Survey” link at the bottom of the session and complete the survey Each survey has a chance to win $25 Amazon Gift Certificate
- 64. Thank You!Thank You! Masha Edelen [email protected] @mashaedelen