Commercial ORM - part 1

// --- Install Sequelize by running: ---
`npm install sequelize`

// --- Create a file named `sequelize_index.js` with the following content: ---
const {Sequelize, DataTypes, Model} = require('sequelize');

const sequelize = new Sequelize('database', 'username', 'password', {
    dialect: 'sqlite',
    storage: './restaurants-seq.sqlite'
});

module.exports={sequelize, DataTypes, Model};

/* This file contains code that would otherwise be duplicated in the 
individual model classes. It sets up a connection to a SQLite database 
and imports Sequelize types. You can see that it would be very easy to 
specify a different type of database in the future just by changing this config */

TODO

const {sequelize} = require('./sequelize_index');
const {Restaurant} = require('./Restaurant')

describe('Restaurant', () => {
    /**
     * This code will be run prior to any tests
     */
    beforeAll(async () => {
        /* the 'sync' method will create tables based on the model class
         - by setting 'force:true' the tables are recreated each time the 
         test suite is run */
        await sequelize.sync({ force: true });
    })

    test('can create a restaurant', async () => {
        /* this is the Sequelize code to create a Restaurant
           note that Sequelize is build using promises, so we use async await */
        const restaurant = await Restaurant.create({ name: 'Ronalds', image: 'http://some.image.url' })
        expect(restaurant.id).toBe(1)
    })
})

TODO

const {sequelize, DataTypes, Model} = require('./sequelize_index');

/**
 * In Sequelize, each class needs to extend the Sequelize 'Model' class
 */
class Restaurant extends Model {

    // add methods here

}

// define the names and data types for the table columns
Restaurant.init({
    name: DataTypes.STRING,
    image: DataTypes.STRING,
}, {
    sequelize,
    timestamps: false, // avoids a 'created_at' column appearing
});

module.exports = {
    Restaurant
};

TODO