BookshelfJS Akd Meetup Apr 2015
Download as PPTX, PDF0 likes237 views
Bookshelf.js is a JavaScript ORM for Node.js that provides a framework for managing relations and querying a relational database. It supports MySQL, Postgres, and SQLite databases and follows Backbone conventions for models, collections, and entity relationships like hasOne, hasMany, belongsTo, and belongsToMany. Bookshelf.js also provides features like polymorphism, eager/lazy loading, events, promises/callbacks, utilities like Knex for querying and migrations, and plugins. To use it, an application first connects to a database via Knex and defines models as Bookshelf classes that extend the knex connection before performing queries and other operations.
BookshelfJS Akd Meetup Apr 2015
- 1. a JS ORM for Node.js http://bookshelfjs.org
- 2. sh-3.2# whoami greg mcdowell founder & (reluctant) lead developer @ oxigeno.co.nz & logmate.co.nz 2
- 3. Agenda 1. What it is? 2. What it provides? 3. How to use it? 4. How we use it? 3
- 4. “... library for common tasks relating to querying, and managing relations in, a Relational Database.” source: http://bookshelfjs.org 4
- 5. M+VC 5
- 7. Agenda 1. What it is? 2. What it provides? 3. How to use it? 4. How we use it? 7
- 8. DB Abstraction ● MySQL ● Postgres ● SQLite 8
- 9. Models & Collections ● Individual database record. ● Domain-specific methods & relations. ● Instance & Class properties. 9 ** (mostly) follows Backbone conventions
- 10. Models & Collections ● Ordered sets of Models. ● Proxies Backbone & Underscore. ● Instance & Class properties. 10 ** (mostly) follows Backbone conventions
- 11. Entity Relationships // containment hasOne() hasMany() // membership belongsTo() belongsToMany() 11
- 12. Entity Relationships // joins (bridge relations) through(joinModel) // joinModel methods attach() detach() withPivot() updatePivot() 12
- 13. Polymorphism 13 “.. polymorphism refers to a languages ability to process objects differently depending on their data type or class.” source: http://webopedia.com/TERM/P/polymorphism.html
- 15. Eager & Lazy // eager load on instantiation of object new M.fetch({withRelated: ‘related’}) // lazy load related data on existing object obj.load(‘related’) 15
- 16. Events // event handlers on() off() 16 // register listeners listenTo() stopListening() listenToOnce() // promised triggers triggerThen() ** mixes in Backbone.Events // event method trigger() once()
- 17. Promises or Callbacks Just use Promises cause they’re AWESOME! 17
- 18. Utilities Knex - Query Builder - Schema Builder - Migrations & Seeds Transactions - alias Knex.Transaction 18
- 19. Plugins ** included Registry - reduce circular references Virtuals - calculated attributes Visibility - whitelist/blacklist attributes 19
- 20. Agenda 1. What it is? 2. What it provides? 3. How to use it? 4. How we use it? 20
- 21. var knex = require('knex')({ client: 'mysql', connection: { host : '127.0.0.1', user : 'your_database_user', password : 'your_database_password', database : 'myapp_test', charset : 'utf8' } }); var bookshelf = require('bookshelf')(knex); var User = bookshelf.Model.extend({ tableName: 'users' }); Connect Access 21
- 22. 22 Demo
- 23. Agenda 1. What it is? 2. What it provides? 3. How to use it? 4. How we use it? 23
- 24. 24
Editor's Notes
- #5: It’s lean Simple to read and understand and extend Flexible - validation First class transaction support
- #6: Not just Models represents additional tools available
- #7: Backbone - gives structure to Web Apps -> provides key-value binding, events and RESTful Api connection Underscore - JS Lib of useful functions/helpers = tool kit analogy Promises - represents state of async operation - intuitive chaining. Knex - batteries included SQL query builder
- #9: Common Rel DB platforms
- #10: If familiar with Backbone - easy
- #17: Used internally on Fetch/Load, etc similar to Backbone
- #20: Registry helpful if using AMD style of Dependancy loading
- #22: Typical Con object, passed to Bookshelf and Bingo
- #23: Red lines = Polymorphic relationships Show Demo
- #25: Replaced RoR API for Mobile App Rails Web for Admins Required 2 skill sets in Biz: App build on MarionetteJS Implemented API for Mobile App & Admins (decoupled) Est. API for Integration partners Opens possibility for Electron Apps in future & others.