Express - ORM (Intermedio)

Sequelize es un ORM para Nodejs que te permite agilizar bastante tus desarrollos que incluyan bases de datos relacionales como Postgres, MySQL, MariaDB, SQLite y SQL Server.

Software a utilizar

De MySQL Community Downloads, descargue e instale:

Motor de base de datos: MySQL Community Server
Interfaz gráfica: MySQL Workbench

Proyecto en Express

Crea un nuevo proyecto, según Express - Bases y Express - ORM (Básico).

O, Clone el proyecto con las aplicaciones del curso para la aplicación album/api
- Para el hito: hito2-api

Relación N:M (Foto-Etiqueta)

Tome como referencia las instrucciones el tutorial Express - ORM (Básico) o Apuntes, para:

Modelo: Cree el modelo que manejará la relación física y lógica
```
sequelize model:create --name fotoetiqueta  --attributes foto_id:integer,etiqueta_id:integer
```
- Modifique el modelo models/fotoetiqueta, agregue la clave tableName y el nombre de la tabla fotoetiquetas a la cual estará relacionado
```
...
modelName: 'fotoetiqueta',
tableName: 'fotoetiquetas'
...
```
Migración: Creación de la tabla
- Modifique la migración migrations/YYYYMMDDHHMMSS-create-fotoetiqueta para que el nombre de la tabla sea etiquetas
```
...
await queryInterface.createTable('fotoetiquetas' 
...
await queryInterface.dropTable('fotoetiquetas' 
...
```

Migración: Modificación de la tabla:

Cree una nueva migración para registrar la asociación

sequelize migration:generate --name associate-foto-etiqueta

Modifique la migración migrations/YYYYMMDDHHMMSS-associate-foto-etiqueta, agregue en la función de ejecución de cambios up

...
await queryInterface.addConstraint('fotoetiquetas', {
    fields: ['foto_id'],
    name: 'foto_id_fk',
    type: 'foreign key',
    references: {
      table: 'fotos',
      field: 'id'
    },
    onDelete: 'cascade',
    onUpdate: 'set null'
  });

  await queryInterface.addConstraint('fotoetiquetas', {
    fields: ['etiqueta_id'],
    name: 'etiqueta_id_fk',
    type: 'foreign key',
    references: {
      table: 'etiquetas',
      field: 'id'
    },
    onDelete: 'cascade',
    onUpdate: 'set null'
  });
...

Modifique la migración migrations/YYYYMMDDHHMMSS-associate-foto-etiqueta, agregue en la función de reversión de cambios down

await queryInterface.removeConstraint('fotoetiquetas', 'foto_id_fk')
await queryInterface.removeConstraint('fotoetiquetas', 'etiqueta_id_fk')

Ejecute la migración y revise los cambios en la base de datos.

Generador:

Cree el generador de datos para el modelo fotoetiqueta

sequelize seed:create --name fotoetiqueta

En la función de ejecución de cambios up, agregue:


  ...
  let [fotos, fotos_metadata] = await queryInterface.sequelize.query('SELECT id FROM fotos')
  let [etiquetas, etiquetas_metadata] = await queryInterface.sequelize.query('SELECT id FROM etiquetas')

  await queryInterface.bulkInsert('fotoetiquetas', [
    {  foto_id: fotos[0].id, etiqueta_id: etiquetas[0].id, createdAt: new Date(), updatedAt: new Date()  },
    {  foto_id: fotos[0].id, etiqueta_id: etiquetas[1].id, createdAt: new Date(), updatedAt: new Date()  },
    {  foto_id: fotos[1].id, etiqueta_id: etiquetas[1].id, createdAt: new Date(), updatedAt: new Date()  }
  ], {});
  ...

En la función de reversión de cambios down, agregue:


  ...
  await queryInterface.bulkDelete('fotoetiquetas', null, {});
  ...

Ejecute el generador de datos y revise los cambios en la base de datos.

Asociación: Entre los modelos foto -< fotoetiqueta >- etiqueta

Del modelo models/foto.js, modifique el método associate con la asociacion lógica al modelo etiqueta


  ...
  static associate(models) {
    // define association here
    
    models.foto.belongsToMany(models.etiqueta, { through: 'fotoetiqueta', foreignKey: "foto_id" } );
    
  }
  ...

Del modelo models/etiqueta.js, modifique el método associate con la asociacion lógica al modelo foto


  ...
  static associate(models) {
    // define association here
    
    models.etiqueta.belongsToMany(models.foto, { through: 'fotoetiqueta', foreignKey: "etiqueta_id" });
    
  }
  ...

Manejador de rutas y controladores:

Agregue la referencia la modelo etiqueta


...
const Foto = require('../models').foto;

const Etiqueta = require('../models').etiqueta; 

...

Modifique el controlador para la ruta /findAll/json al:

Incluir (clave include) el modelo etiqueta
Mostrar solo el atributo texto
Evitando cargar todos los modelos relacionados (Nested eager loading).


  ...
  const Foto = require('../models').foto;
  const Etiqueta = require('../models').etiqueta;  

  ...
  Foto.findAll({  
      attributes: { exclude: ["updatedAt"] },
      
      include: [{
        model: Etiqueta,
        attributes: ['texto'],
        through: {attributes: []}
      }],
      
  })

Comprobación

Compruebe el funcionamiento del servidor, con: npm run devstart
Acceda al URL http://localhost:3000/fotos/findAll/json

Referencias

¿Qué es un ORM?. (2021). Retrieved 3 August 2021, from https://www2.deloitte.com/es/es/pages/technology/articles/que-es-orm.html
Manual Sequelize. (2021). Retrieved 4 August 2021, from https://sequelize.org/master/index.html
Node JS, Express y MySQL con Sequelize. (2021). Retrieved 3 August 2021, from https://tomasmalio.medium.com/node-js-express-y-mysql-con-sequelize-ec0a7c0ae292
Creating Sequelize Associations with the Sequelize CLI tool. (2020). Retrieved 3 August 2021, from https://levelup.gitconnected.com/creating-sequelize-associations-with-the-sequelize-cli-tool-d83caa902233
Creating Sequelize Associations with the Sequelize CLI tool. (2020). Retrieved 3 August 2021, from https://levelup.gitconnected.com/creating-sequelize-associations-with-the-sequelize-cli-tool-d83caa902233
GitHub - japsolo/curso-sequelize-migrations-seeders: Creando modelos, migraciones y seeders con Sequelize en Node + Express. (2021). Retrieved 3 August 2021, from https://github.com/japsolo/curso-sequelize-migrations-seeders
Sequelize + Express + Migrations + Seed Starter. (2022). Retrieved 3 August 2022, from https://gist.github.com/vapurrmaid/a111bf3fc0224751cb2f76532aac2465
through.attribute, S., & Kammer, F. (2016). Sequelize: Include model of through.attribute. Retrieved 18 December 2022, from https://stackoverflow.com/questions/38726793/sequelize-include-model-of-through-attribute
Usage - Sequelize The Node.js / io.js ORM for PostgreSQL, MySQL, SQLite and MSSQL. (2022). Retrieved 18 December 2022, from https://sequelize.org/v3/docs/models-usage/index.html#nested-eager-loading