Skip to content

Commit a01fcc7

Browse files
papbpapb
committed
Add association examples
1 parent d51ac49 commit a01fcc7

File tree

9 files changed

+239
-1
lines changed

9 files changed

+239
-1
lines changed

‎express-main-example/express/app.js

+3-1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ const bodyParser = require('body-parser');
33

44
const routes = {
55
users: require('./routes/users'),
6+
instruments: require('./routes/instruments'),
7+
orchestras: require('./routes/orchestras'),
68
// Add more routes here...
79
// items: require('./routes/items'),
810
};
@@ -28,7 +30,7 @@ app.get('/', (req, res) => {
2830
res.send(`
2931
<h2>Hello, Sequelize + Express!</h2>
3032
<p>Make sure you have executed <b>npm run setup-example-db</b> once to have a populated example database. Otherwise, you will get <i>'no such table'</i> errors.</p>
31-
<p>Try some routes, such as <a href='/api/users'>/api/users</a>!</p>
33+
<p>Try some routes, such as <a href='/api/users'>/api/users</a> or <a href='/api/orchestras?includeInstruments'>/api/orchestras?includeInstruments</a>!</p>
3234
<p>To experiment with POST/PUT/DELETE requests, use a tool for creating HTTP requests such as <a href='https://github.com/jakubroztocil/httpie#readme'>HTTPie</a>, <a href='https://www.postman.com/downloads/'>Postman</a>, or even <a href='https://en.wikipedia.org/wiki/CURL'>the curl command</a>, or write some JS code for it with <a href='https://github.com/sindresorhus/got#readme'>got</a>, <a href='https://github.com/sindresorhus/ky#readme'>ky</a> or <a href='https://github.com/axios/axios#readme'>axios</a>.</p>
3335
`);
3436
});

‎express-main-example/express/routes/instruments.js

+60
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
const { models } = require('../../sequelize');
2+
const { getIdParam } = require('../helpers');
3+
4+
async function getAll(req, res) {
5+
const instruments = await models.instrument.findAll();
6+
res.status(200).json(instruments);
7+
};
8+
9+
async function getById(req, res) {
10+
const id = getIdParam(req);
11+
const instrument = await models.instrument.findByPk(id);
12+
if (instrument) {
13+
res.status(200).json(instrument);
14+
} else {
15+
res.status(404).send('404 - Not found');
16+
}
17+
};
18+
19+
async function create(req, res) {
20+
if (req.body.id) {
21+
res.status(400).send(`Bad request: ID should not be provided, since it is determined automatically by the database.`)
22+
} else {
23+
await models.instrument.create(req.body);
24+
res.status(201).end();
25+
}
26+
};
27+
28+
async function update(req, res) {
29+
const id = getIdParam(req);
30+
31+
// We only accept an UPDATE request if the `:id` param matches the body `id`
32+
if (req.body.id === id) {
33+
await models.instrument.update(req.body, {
34+
where: {
35+
id: id
36+
}
37+
});
38+
res.status(200).end();
39+
} else {
40+
res.status(400).send(`Bad request: param ID (${id}) does not match body ID (${req.body.id}).`);
41+
}
42+
};
43+
44+
async function remove(req, res) {
45+
const id = getIdParam(req);
46+
await models.instrument.destroy({
47+
where: {
48+
id: id
49+
}
50+
});
51+
res.status(200).end();
52+
};
53+
54+
module.exports = {
55+
getAll,
56+
getById,
57+
create,
58+
update,
59+
remove,
60+
};

‎express-main-example/express/routes/orchestras.js

+64
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
const { models } = require('../../sequelize');
2+
const { getIdParam } = require('../helpers');
3+
4+
async function getAll(req, res) {
5+
const orchestras = 'includeInstruments' in req.query ?
6+
await models.orchestra.findAll({ include: models.instrument }) :
7+
await models.orchestra.findAll();
8+
res.status(200).json(orchestras);
9+
};
10+
11+
async function getById(req, res) {
12+
const id = getIdParam(req);
13+
const orchestra = 'includeInstruments' in req.query ?
14+
await models.orchestra.findByPk(id, { include: models.instrument }) :
15+
await models.orchestra.findByPk(id);
16+
if (orchestra) {
17+
res.status(200).json(orchestra);
18+
} else {
19+
res.status(404).send('404 - Not found');
20+
}
21+
};
22+
23+
async function create(req, res) {
24+
if (req.body.id) {
25+
res.status(400).send(`Bad request: ID should not be provided, since it is determined automatically by the database.`)
26+
} else {
27+
await models.orchestra.create(req.body);
28+
res.status(201).end();
29+
}
30+
};
31+
32+
async function update(req, res) {
33+
const id = getIdParam(req);
34+
35+
// We only accept an UPDATE request if the `:id` param matches the body `id`
36+
if (req.body.id === id) {
37+
await models.orchestra.update(req.body, {
38+
where: {
39+
id: id
40+
}
41+
});
42+
res.status(200).end();
43+
} else {
44+
res.status(400).send(`Bad request: param ID (${id}) does not match body ID (${req.body.id}).`);
45+
}
46+
};
47+
48+
async function remove(req, res) {
49+
const id = getIdParam(req);
50+
await models.orchestra.destroy({
51+
where: {
52+
id: id
53+
}
54+
});
55+
res.status(200).end();
56+
};
57+
58+
module.exports = {
59+
getAll,
60+
getById,
61+
create,
62+
update,
63+
remove,
64+
};

‎express-main-example/sequelize/extra-setup.js

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
function applyExtraSetup(sequelize) {
2+
const { instrument, orchestra } = sequelize.models;
3+
4+
orchestra.hasMany(instrument);
5+
instrument.belongsTo(orchestra);
6+
}
7+
8+
module.exports = { applyExtraSetup };

‎express-main-example/sequelize/index.js

+7
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
const { Sequelize } = require('sequelize');
2+
const { applyExtraSetup } = require('./extra-setup');
23

34
// In a real app, you should keep the database connection URL as an environment variable.
45
// But for this example, we will just use a local SQLite database.
@@ -12,13 +13,19 @@ const sequelize = new Sequelize({
1213

1314
const modelDefiners = [
1415
require('./models/user.model'),
16+
require('./models/instrument.model'),
17+
require('./models/orchestra.model'),
1518
// Add more models here...
1619
// require('./models/item'),
1720
];
1821

22+
// We define all models according to their files.
1923
for (const modelDefiner of modelDefiners) {
2024
modelDefiner(sequelize);
2125
}
2226

27+
// We execute any extra setup after the models are defined, such as adding associations.
28+
applyExtraSetup(sequelize);
29+
2330
// We export the sequelize connection instance to be used around our app.
2431
module.exports = sequelize;

‎express-main-example/sequelize/models/instrument.model.js

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
const { DataTypes } = require('sequelize');
2+
3+
// We export a function that defines the model.
4+
// This function will automatically receive as parameter the Sequelize connection object.
5+
module.exports = (sequelize) => {
6+
sequelize.define('instrument', {
7+
// The following specification of the 'id' attribute could be omitted
8+
// since it is the default.
9+
id: {
10+
allowNull: false,
11+
autoIncrement: true,
12+
primaryKey: true,
13+
type: DataTypes.INTEGER
14+
},
15+
type: {
16+
allowNull: false,
17+
type: DataTypes.STRING,
18+
},
19+
// type: {
20+
// allowNull: false,
21+
// type: DataTypes.STRING,
22+
// validate: {
23+
// isIn: [['string', 'wind', 'percussion']]
24+
// }
25+
// },
26+
purchaseDate: {
27+
allowNull: false,
28+
type: DataTypes.DATE
29+
},
30+
// We also want it to have a 'orchestraId' field, but we don't have to define it here.
31+
// It will be defined automatically when Sequelize applies the associations.
32+
});
33+
};

‎express-main-example/sequelize/models/orchestra.model.js

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
const { DataTypes } = require('sequelize');
2+
3+
// We export a function that defines the model.
4+
// This function will automatically receive as parameter the Sequelize connection object.
5+
module.exports = (sequelize) => {
6+
sequelize.define('orchestra', {
7+
// The following specification of the 'id' attribute could be omitted
8+
// since it is the default.
9+
id: {
10+
allowNull: false,
11+
autoIncrement: true,
12+
primaryKey: true,
13+
type: DataTypes.INTEGER
14+
},
15+
name: {
16+
allowNull: false,
17+
type: DataTypes.STRING
18+
},
19+
});
20+
};

‎express-main-example/sqlite-example-database/helpers/random.js

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
function pickRandom(args) {
2+
return args[Math.floor(Math.random() * args.length)];
3+
}
4+
5+
function randomDate() {
6+
return new Date(new Date() - 200000000000 * Math.random());
7+
}
8+
9+
module.exports = { pickRandom, randomDate };

‎express-main-example/sqlite-example-database/setup.js

+35
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
const sequelize = require('../sequelize');
2+
const { pickRandom, randomDate } = require('./helpers/random');
23

34
async function reset() {
45
console.log('Will rewrite the SQLite example database, adding some dummy data.');
@@ -12,6 +13,40 @@ async function reset() {
1213
{ username: 'brown-beard' },
1314
]);
1415

16+
await sequelize.models.orchestra.bulkCreate([
17+
{ name: 'Jalisco Philharmonic' },
18+
{ name: 'Symphony No. 4' },
19+
{ name: 'Symphony No. 8' },
20+
]);
21+
22+
// Let's create random instruments for each orchestra
23+
for (const orchestra of await sequelize.models.orchestra.findAll()) {
24+
for (let i = 0; i < 10; i++) {
25+
const type = pickRandom([
26+
'violin',
27+
'trombone',
28+
'flute',
29+
'harp',
30+
'trumpet',
31+
'piano',
32+
'guitar',
33+
'pipe organ',
34+
]);
35+
36+
await orchestra.createInstrument({
37+
type: type,
38+
purchaseDate: randomDate()
39+
});
40+
41+
// The following would be equivalent in this case:
42+
// await sequelize.models.instrument.create({
43+
// type: type,
44+
// purchaseDate: randomDate(),
45+
// orchestraId: orchestra.id
46+
// });
47+
}
48+
}
49+
1550
console.log('Done!');
1651
}
1752

0 commit comments

Comments
 (0)