Para generar el archivo add-role.js hay que correr el comando
npm run migrations:generate add-role
¿Cómo alterar una tabla utilizando migraciones?
El uso de migraciones en bases de datos permite realizar modificaciones y alteraciones a tablas ya existentes de manera flexible y ordenada. Aunque herramientas como Scienc proporcionan la generación inicial de modelos, estas no permiten cambios posteriores sin realizar riesgos potenciales de eliminar información. Con migraciones, es posible agregar campos y realizar modificaciones de forma segura y controlada. En este artículo, te guiaremos paso a paso sobre cómo implementar esta técnica en una base de datos existente.
¿Cómo agregar un nuevo campo con migraciones?
Para añadir un nuevo campo a una tabla existente, antes de ejecutar cualquier migración, es importante definir cómo se integrará este campo en el modelo de datos. Supongamos que queremos agregar un campo llamado role a la tabla de usuarios. El procedimiento es el siguiente:
Definir el nuevo campo en el modelo:
role con las siguientes características:
Comunicar la modificación a la tabla:
await queryInterface.addColumn('User', 'role', { type: Sequelize.STRING, allowNull: false, defaultValue: 'customer' });
role fue añadida correctamente.¿Cómo hacer un rollback de una migración?
El rollback, o revertir una migración, es fundamental para deshacer un cambio cuando es necesario. Si en algún punto es necesario quitar la columna añadida, el procedimiento es:
await queryInterface.removeColumn('User', 'role');
¿Cómo validar el nuevo campo en el esquema?
Después de realizar cambios mediante migraciones, debemos asegurar que los esquemas de validación de la aplicación reconozcan el nuevo campo. En este caso, podrías requerir que al crear o actualizar un usuario se incluya un role, ajustando las reglas de validación de la API.
¿Qué considerar al correr migraciones?
Las migraciones ayudan a mantener control y orden en las estructuras de bases de datos. Sin embargo, es esencial tener en cuenta lo siguiente:
Con migraciones, es posible realizar multitud de modificaciones simultáneamente, siempre y cuando se realice con cuidado y planificación. Este conocimiento te ofrece una base sólida para continuar avanzando en el manejo de bases de datos relacionales, un próximo paso te espera: trabajar con las relaciones y cómo estos elementos se organizan e integran en torno a datos entrelazados, ampliando así la complejidad y capacidad de nuestra base de datos.
El uso de migraciones en bases de datos permite realizar modificaciones y alteraciones a tablas ya existentes de manera flexible y ordenada. Aunque herramientas como Scienc proporcionan la generación inicial de modelos, estas no permiten cambios posteriores sin realizar riesgos potenciales de eliminar información. Con migraciones, es posible agregar campos y realizar modificaciones de forma segura y controlada. En este artículo, te guiaremos paso a paso sobre cómo implementar esta técnica en una base de datos existente.
Para añadir un nuevo campo a una tabla existente, antes de ejecutar cualquier migración, es importante definir cómo se integrará este campo en el modelo de datos. Supongamos que queremos agregar un campo llamado role a la tabla de usuarios. El procedimiento es el siguiente:
Definir el nuevo campo en el modelo:
role con las siguientes características:
Comunicar la modificación a la tabla:
await queryInterface.addColumn('User', 'role', {
type: Sequelize.STRING,
allowNull: false,
defaultValue: 'customer'
});
role fue añadida correctamente.El rollback, o revertir una migración, es fundamental para deshacer un cambio cuando es necesario. Si en algún punto es necesario quitar la columna añadida, el procedimiento es:
await queryInterface.removeColumn('User', 'role');
Después de realizar cambios mediante migraciones, debemos asegurar que los esquemas de validación de la aplicación reconozcan el nuevo campo. En este caso, podrías requerir que al crear o actualizar un usuario se incluya un role, ajustando las reglas de validación de la API.
Las migraciones ayudan a mantener control y orden en las estructuras de bases de datos. Sin embargo, es esencial tener en cuenta lo siguiente:
Con migraciones, es posible realizar multitud de modificaciones simultáneamente, siempre y cuando se realice con cuidado y planificación. Este conocimiento te ofrece una base sólida para continuar avanzando en el manejo de bases de datos relacionales, un próximo paso te espera: trabajar con las relaciones y cómo estos elementos se organizan e integran en torno a datos entrelazados, ampliando así la complejidad y capacidad de nuestra base de datos.
Para generar el archivo add-role.js hay que correr el comando
npm run migrations:generate add-role
Con sequelize.sync() no se puede alterar una tabla que ya está creada ya que únicamente lee el modelo, y en caso de hacer alguna modificación, se queda con la primera versión (no se puede agregar un atributo más). Con las migraciones es más flexible ya que sí se pueden hacer modificaciones y tener todo de una forma organizada.
Para agregar una columna se hace con el método addColumn, se define el nombre de la tabla, seguido del nombre de la columna, finalmente el esquema (nulo, string, etc), en ese caso se define el esquema del campo en específico.
await queryInterface.addColumn(USER_TABLE, 'role', UserSchema.
Para quitar la columna se usa el método removeColumn definiendo el nombre de la tabla y de la columna.
await queryInterface.removeColumn(USER_TABLE, 'role');
Se debe correr la migración para ejecutar los cambios, esta va a correr a partir de la última migración.
Éxito rotundo

Hay un salto de edición, no se ve el proceso para crear la nueva migración add-role para crearlo tenemos que hacer uso de nuestro script :
Francisco Javier Gómez Olguín
Julian David Alzate Cuervo
José Luis Encastin Flores
Juan Jiménez
Max Andy Diaz Neyra
Edwin Arias
Luis Berenguer
Moises Hernandez
SAHIR ANTHAR VELASCO GONZALEZ
Emmanuel Rodríguez
Max Andy Diaz Neyra
Emmanuel Rodríguez
Irwing Khalisser Naranjo Brito
Pablo Antipan Quiñenao
Gustavo Gonzalez Montero
Ricardo Perez
Ricardo Perez
Ricardo Perez
Juan sebastian suarez contreras
Andrés Muñoz
Oscar Ivan Lozoya Rodríguez
David Herrera
Cayo Legal
Juan Camilo Lentino Villalba
Eduardo Razo Cobián
Andres Trujillo
Carlos Riveros
Fabio Flores
Ricardo Aguilar
Carlos S. Aldazosa
Fredy Daniel Flores Lemus
Andrés Muñoz
Alexis Toro Navarro
Javier Eduardo Morón Mendoza
Carlos Nicolas Gonzalez Cabrera
Daniel Carmona
Moises Hernandez
EDGAR MERCADO GARCIA
Jefred Bedoya
npm run migrations:generate add-role
ℹ️ Repositorio: Link .
✨
user.js. Definición de esquema
import { DataTypes, Sequelize as SequelizeClient } from 'sequelize';
/**
* @description description of each field in the table
* @typedef {Object} field definition
* @property {boolean} allowNull - false=NOT NULL
* @property {boolean} autoIncrement - each insert, increase the counter
* @property {boolean} primaryKey - define is primary key
* @property {boolean} type - expresion to match SQL type
* @property {boolean} unique - difne as unique the field
* @property {boolean} field - rename the field
*/
export default {
id: {
allowNull: false,
autoIncrement: true,
primaryKey: true,
type: DataTypes.INTEGER,
},
email: {
allowNull: false,
type: DataTypes.STRING,
unique: true,
},
password: {
allowNull: false,
type: DataTypes.STRING,
},
createdAt: {
allowNull: false,
type: DataTypes.DATE,
field: 'created_at',
defaultValue: SequelizeClient.NOW,
},
updatedAt: {
allowNull: false,
type: DataTypes.DATE,
field: 'updated_at',
defaultValue: SequelizeClient.NOW,
},
};
.
✨
config.js. Configuración de entornos
import Sequelize from './../libs/sequelize';
module.exports = Sequelize.migration;
.
♻️
.sequelizercConfiguración delsequelize
require('@babel/register');
module.exports = {
config: './src/mocks/config.js',
'migrations-path': './src/mocks/migrations',
'seeders-path': './src/mocks/seeders',
};
♻️
package.json. Adición de scrips de generación y ejecución
"seeds:generate": "sequelize-cli seed:generate --name",
"seeds:run": "sequelize-cli db:seed:all",
"migrations:generate": "sequelize-cli migration:generate --name",
"migrations:run": "sequelize-cli db:migrate",
"db:generate": "npm run migrations:run && npm run seeds:run",
.
migration y seeds✨
create-user-table.js
import userSchema from '../models/user';
module.exports = {
up: async (queryInterface) => {
await queryInterface.createTable('users', userSchema);
},
down: async (queryInterface) => {
await queryInterface.drop('users');
},
};
En el minuto 1:54 parece que hubo un salto o edición, porque apareció la nueva migración sola, no explico como la genero.
Si borras las tablas y ejecutas de nuevo las migraciones, dice,
ERROR: column "role" of relation "user" al ready exists
¿por qué ocurre esto? Si cambio a producción, esto puede ser un problema. ¿Cómo se evita?
las migraciones se pueden hacer mientras el servidor esta arriba?
Si ya tengo la base de datos en MySql y genere los model para todas las tablas, cual seria la manera correcta de conectar el codigo de node y la bd para que no se borren las tablas pero si hacer uso del ORM, alguien ha hecho lo mismo ?
Una cosa importante es que cuando corremos una migración, queda un registro de esa migración en base de datos de dicha migración. Por ejemplo, recientemente corrimos el comando de creación de la tabla users, entonces en la base de datos se creará una carpeta llamada SequelizeMeta, en donde quedará un registro de que se corrió dicha migración. Por lo que si corremos ahora esta última migración de agregar una columna, Sequelize consultará en base de datos en el registro de migraciones cual fue la última migración que hizo en dicha carpeta, por lo que no volverá a correr una migración que ya quedo registrada, sino de todas de las que no tiene registro en base de datos. Es decir, una vez que corremos una migración, debemos crear otra migración si queremos realizar alguna otra operación, exceptuando que no sea ir para atrás de la última migración que hicimos
Para generar el archivo add-role.js hay que correr el comando
npm run migrations:generate add-role
muchas gracias
¡Gracias Francisco!
Con sequelize.sync() no se puede alterar una tabla que ya está creada ya que únicamente lee el modelo, y en caso de hacer alguna modificación, se queda con la primera versión (no se puede agregar un atributo más). Con las migraciones es más flexible ya que sí se pueden hacer modificaciones y tener todo de una forma organizada.
Para agregar una columna se hace con el método addColumn, se define el nombre de la tabla, seguido del nombre de la columna, finalmente el esquema (nulo, string, etc), en ese caso se define el esquema del campo en específico.
await queryInterface.addColumn(USER_TABLE, 'role', UserSchema.
Para quitar la columna se usa el método removeColumn definiendo el nombre de la tabla y de la columna.
await queryInterface.removeColumn(USER_TABLE, 'role');
Se debe correr la migración para ejecutar los cambios, esta va a correr a partir de la última migración.
Excelentes notas, como siempre.
Sí es posible, el sync tiene unas configuraciones, en ellas le puedes decir que alter true, y te permite esos cambios, pero la ventaja de las migraciones es que tenemos el control de esto, en el alter no, y esto puede llevar a errores
Éxito rotundo
Hay un salto de edición, no se ve el proceso para crear la nueva migración add-role para crearlo tenemos que hacer uso de nuestro script :
npm run migrations:generate add-role
gracias, preciso voy ahí y se trago ese pedazo.
💾 DB Generation
ℹ️ Repositorio: Link .
✨
user.js. Definición de esquema
import { DataTypes, Sequelize as SequelizeClient } from 'sequelize'; /** * @description description of each field in the table * @typedef {Object} field definition * @property {boolean} allowNull - false=NOT NULL * @property {boolean} autoIncrement - each insert, increase the counter * @property {boolean} primaryKey - define is primary key * @property {boolean} type - expresion to match SQL type * @property {boolean} unique - difne as unique the field * @property {boolean} field - rename the field */ export default { id: { allowNull: false, autoIncrement: true, primaryKey: true, type: DataTypes.INTEGER, }, email: { allowNull: false, type: DataTypes.STRING, unique: true, }, password: { allowNull: false, type: DataTypes.STRING, }, createdAt: { allowNull: false, type: DataTypes.DATE, field: 'created_at', defaultValue: SequelizeClient.NOW, }, updatedAt: { allowNull: false, type: DataTypes.DATE, field: 'updated_at', defaultValue: SequelizeClient.NOW, }, };
.
✨
config.js. Configuración de entornos
import Sequelize from './../libs/sequelize'; module.exports = Sequelize.migration;
.
♻️
.sequelizercConfiguración delsequelize
require('@babel/register'); module.exports = { config: './src/mocks/config.js', 'migrations-path': './src/mocks/migrations', 'seeders-path': './src/mocks/seeders', };
♻️
package.json. Adición de scrips de generación y ejecución
"seeds:generate": "sequelize-cli seed:generate --name", "seeds:run": "sequelize-cli db:seed:all", "migrations:generate": "sequelize-cli migration:generate --name", "migrations:run": "sequelize-cli db:migrate", "db:generate": "npm run migrations:run && npm run seeds:run",
.
Generación de scripts para migration y seeds
✨
create-user-table.js
import userSchema from '../models/user'; module.exports = { up: async (queryInterface) => { await queryInterface.createTable('users', userSchema); }, down: async (queryInterface) => { await queryInterface.drop('users'); }, };
✨
users.js
. 💡Para la generación de Seeds, puede ocupar un generador de mocks como Mockaroo
module.exports = { up: (queryInterface) => { return queryInterface.bulkInsert('users', [ { email: 'ttrime0@zimbio.com', password: 'dIkttoW58AZl', created_at: new Date(), updated_at: new Date(), }, { email: 'hbrychan1@globo.com', password: 'LWGHo4Sf', created_at: new Date(), updated_at: new Date(), }, { email: 'kkeaveny2@unesco.org', password: '8iKZ14bBA', created_at: new Date(), updated_at: new Date(), }, { email: 'ppuve3@goo.ne.jp', password: 'GLY4O1', created_at: new Date(), updated_at: new Date(), }, { email: 'dwinspeare4@bigcartel.com', password: 'dWYttZ4', created_at: new Date(), updated_at: new Date(), }, ]); }, down: (queryInterface) => { return queryInterface.bulkDelete('users', null, {}); }, };
Consulta, como haces para utilizar import en node? Utilizaste el "type": "module" en package.json o utilizaste otra forma?
Saludos, 👋
Generalmente me apoyo de babel-node para tratar con JavaScript.
Te comparto un pequeño gist:
{ "scripts": { "dev": "nodemon ./src/index --exec babel-node", }, "dependencies": { "@babel/runtime": "7.16.7", }, "devDependencies": { "@babel/cli": "7.16.8", "@babel/core": "7.16.7", "@babel/node": "7.16.8", "@babel/plugin-transform-runtime": "7.16.8", "@babel/preset-env": "7.16.8", "nodemon": "2.0.15", }, "babel": { "presets": [ "@babel/preset-env" ], "plugins": [ "@babel/plugin-transform-runtime", ] }, }
También puedes encontrar varios templates que he ido desarrollando, en mi repositorio:
En el minuto 1:54 parece que hubo un salto o edición, porque apareció la nueva migración sola, no explico como la genero.
Hi Irwing! Efectivamente hay un salto en la edición! Lo vamos a revisar! Gracias por el feedback! Saludos!
Estoy teniendo la misma duda en este momento. Pero supongo que con solo correr el siguiente comando me pongo al día con ese salgo de edición:
$ npm rum migrations:generate add-role
Si borras las tablas y ejecutas de nuevo las migraciones, dice,
ERROR: column "role" of relation "user" al ready exists
¿por qué ocurre esto? Si cambio a producción, esto puede ser un problema. ¿Cómo se evita?
Lo solucioné, quitando de las migraciones el add Column, pero aun así se siente algo truqueada esa solución
Explicacion de problema
las migraciones se pueden hacer mientras el servidor esta arriba?
Lo normal es hacerlo como parte de tu proceso de deploy, antes de salir a producción se corren todas las pruebas, incluyendo las pruebas de tu migración, se corren las migraciones pendientes y despues se sale a producción.
Ahora de poder hacerlo lo puedes hacer pero no se me ocurre un caso en el que sea buena idea.
Si ya tengo la base de datos en MySql y genere los model para todas las tablas, cual seria la manera correcta de conectar el codigo de node y la bd para que no se borren las tablas pero si hacer uso del ORM, alguien ha hecho lo mismo ?
https://chineduorie.com/posts/how-to-use-sequelize-on-an-existing-database
Este articulo explica como usar sequelize en una bd existente
Una cosa importante es que cuando corremos una migración, queda un registro de esa migración en base de datos de dicha migración. Por ejemplo, recientemente corrimos el comando de creación de la tabla users, entonces en la base de datos se creará una carpeta llamada SequelizeMeta, en donde quedará un registro de que se corrió dicha migración. Por lo que si corremos ahora esta última migración de agregar una columna, Sequelize consultará en base de datos en el registro de migraciones cual fue la última migración que hizo en dicha carpeta, por lo que no volverá a correr una migración que ya quedo registrada, sino de todas de las que no tiene registro en base de datos. Es decir, una vez que corremos una migración, debemos crear otra migración si queremos realizar alguna otra operación, exceptuando que no sea ir para atrás de la última migración que hicimos
podemos consultar esos registros con el query
SELECT name FROM public."SequelizeMeta";
Creo que una buena practica en migraciones cuando vamos hacer alguna modificación debemos ser claros que hará y donde lo hará por ejemplo:
Hicimos esto en el curso:
npm rum migrations:generate add-role
Deberiamos especificar a que tabla por ejemplo
npm rum migrations:generate add-role-to-users
Corríjanme si me equivoco
pues esta bien, pero cuando la complejidad de relaciones o modificaciones crezca, imaginate el nombre que tendrás que colocar, por lo que puedes colocar le un nombre abstracto y luego entras al archivo para revisar los cambios que se realizaron
Hoy en preguntas tontas, ¿que se supone que es el "role"? jajaja
El rol se refiere a los permisos que tendrá el usuario dentro de la aplicación. Un ejemplo Imagina la web de la tienda, los usuarios con role 'customer' podran acceder a ver los productos, comprarlos, etc. Pero imagina que se tiene un dashboard administrativo donde se pueden ver todas la ventas de los productos, un 'customer' no quieres que tenga acceso a ella, a esta parte de la web podra acceder un usuario con role 'admin' por ejemplo. En resumen los roles se ocuparan en otro curso para dar permisos dentro la tienda
¿Por qué se tiene que correr migraciones, modificar /store/db/migrations/123-add-role.js y volver a correr migraciones? ¿En vez de solo agregar el UserSchema y correr migraciones otra vez? Me parece algo confuso para solo tener que agregar una columna.
Por que se debe tener un registro de cada modificacion y su respectivo rollback. Si se hubiese hecho como tu dices el rollback que se ejecutaria seria el de eliminar la tabla
Hola!!!!, ¿Cuando usamos una base de datos no relacional tambien entra el tema de las migraciones?
Si también se usa migraciones o por lo menos en mongo si se lo hace, los schemas se los maneja con una lib llamada mongoose, y tal cual como en esta clase siempre que se modifica el schema se corre una migración con test.
le cambio el import y la extensión pero no pasa nada unu
$ npm run migrations:run > restfull-node@1.0.0 migrations:run > sequelize-cli db:migrate Sequelize CLI [Node: 16.10.0, CLI: 6.3.0, ORM: 6.9.0] ERROR: Error reading "db\config.js". Error: Error [ERR_REQUIRE_ESM]: require() of ES Module C:\Users\aatn1\OneDrive\Documentos\Platzi\JS_school\RESTfull_Node\db\config.js from C:\Users\aatn1\OneDrive\Documentos\Platzi\JS_school\RESTfull_Node\node_modules\sequelize-cli\lib\helpers\config-helper.js not supported.Instead change the require of config.js in C:\Users\aatn1\OneDrive\Documentos\Platzi\JS_school\RESTfull_Node\node_modules\sequelize-cli\lib\helpers\config-helper.js to a dynamic import() which is available in all CommonJS modules.
Parece que tienes un typo en algún require() que hiciste, tal vez en el que se hizo en esta clase
const { UserSchema, USER_TABLE } = require('./../models/user.model')
pero el error hace referencia a db/config.js, te sugiero que mires tus importaciones a ver si encuentras algo. Si no, puedes compartir tu código para encontrar el error.
Tuve el siguiente problema:
Sequelize CLI [Node: 20.12.2, CLI: 6.6.2, ORM: 6.37.3]
Loaded configuration file "api\db\config.js".
Using environment "development".
== 20240719181909-add-role: migrating =======
ERROR: Cannot read properties of undefined (reading 'toString')
para solucionarlo tuve que modificar una parte del codigo:
'use strict'; /** @type {import('sequelize-cli').Migration} */ const { UserSchema, USER_TABLE } = require('../models/user.model'); module.exports = { async up (queryInterface) { await queryInterface.addColumn(USER_TABLE, 'role', { type: UserSchema.role.type, allowNull: UserSchema.role.allowNull, defaultValue: UserSchema.role.defaultValue, }); }, async down (queryInterface) { await queryInterface.removeColumn(USER_TABLE, 'role', UserSchema); } }; ```'use strict'; */\*\* @type {import('sequelize-cli').Migration} \*/*const { UserSchema, USER\_TABLE } = require('../models/user.model');module.exports = { async up (*queryInterface*) { await *queryInterface*.addColumn(USER\_TABLE, 'role', { type: UserSchema.role.type, allowNull: UserSchema.role.allowNull, defaultValue: UserSchema.role.defaultValue, }); }, async down (*queryInterface*) { await *queryInterface*.removeColumn(USER\_TABLE, 'role', UserSchema); }};
Muy bien ya me quedo
Excelente clase muy buena info.
ahora si todo bien funciono aunque tuve que corregir algunos temas pero funcion... :D
[ { "id": 1, "email": "emercado@mail.com", "password": "12345678", "role": "customer", "createdAt": "2021-11-25T11:03:34.941Z" }, { "id": 2, "email": "mercado@mail.com", "password": "12345678", "role": "customer", "createdAt": "2021-11-25T11:03:48.567Z" } ]
Modificación de Tablas con Migraciones
Las migraciones ofrecen flexibilidad y control para alterar esquemas existentes sin riesgo de pérdida de datos, superando las limitaciones de sincronización automática.
queryInterface.addColumn para ejecutar el ALTER TABLE de SQL.removeColumn para revertir cambios de forma segura.✨
users.js
. 💡Para la generación de Seeds, puede ocupar un generador de mocks como Mockaroo
module.exports = {
up: (queryInterface) => {
return queryInterface.bulkInsert('users', [
{
email: 'ttrime0@zimbio.com',
password: 'dIkttoW58AZl',
created_at: new Date(),
updated_at: new Date(),
},
{
email: 'hbrychan1@globo.com',
password: 'LWGHo4Sf',
created_at: new Date(),
updated_at: new Date(),
},
{
email: 'kkeaveny2@unesco.org',
password: '8iKZ14bBA',
created_at: new Date(),
updated_at: new Date(),
},
{
email: 'ppuve3@goo.ne.jp',
password: 'GLY4O1',
created_at: new Date(),
updated_at: new Date(),
},
{
email: 'dwinspeare4@bigcartel.com',
password: 'dWYttZ4',
created_at: new Date(),
updated_at: new Date(),
},
]);
},
down: (queryInterface) => {
return queryInterface.bulkDelete('users', null, {});
},
};