Bookshelf.js is a JavaScript library designed to simplify querying and managing relationships in relational databases like MySQL and PostgreSQL. It offers features for modeling database records, handling entity relationships, and supports both eager and lazy loading of related data. The document also outlines the use of Knex for query building and provides code examples for defining models and controllers.

1. BOOKSHELF.JS
http://bookshelfjs.org

2. sh-3.2# whoami
greg mcdowell
2

3. 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. Models
Views
Controllers
5

6. Dependencies
6
lodash

7. 1. What it is?
2. What it provides?
3. How to use it?
4. How we use it?
7

8. DB Abstraction
● MySQL
● Postgres
● SQLite3
● MSSQL
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 Lodash
● 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

14. Polymorphic
Relationships
// containment
morphOne()
morphMany()
// membership
morphTo()
14

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
once()
// promised triggers
triggerThen()
// event method
trigger()

17. Promises
or
Callbacks
or
Streams
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
less of an issue with es6
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. // orm.js – establish connection
import Knex from 'knex’;
import Bookshelf from ‘bookshelf’;
const DB = new Knex(); // knexfile.js
const Orm = new Bookshelf(DB);
export default Orm;
Access
21
// user.js – define a model for table
import Orm from ‘./orm’;
let User = Orm.Model.extend({
tableName:'users’}
);
export default User;
// users.js – user controller
import User from ‘./user’;
export default {
list(req, res) {
User.fetchAll()
.then(records => {
res.status(200).json(records);
})
.catch(err => {
res.status(400).json({error:err});
})
},
find(req, res){
User.forge(req.params.id)
.fetch()
.then(record => {
res.status(200).json(record);
})
.catch(err => {
res.status(400).json({error:err});
});
}
};

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

25. 25
Sample App:
Demo repo:
https://github.com/gmcdowell/bookshelf-demo
Questions ?