Migraciones en bases de datos: agregar campos automáticamente

Clase 17 de 36 • Curso de NestJS: Persistencia de Datos con TypeORM

Resumen

¿Cómo agregar nuevos atributos o relaciones en base de datos mediante migraciones?

Cuando trabajamos con bases de datos, tarde o temprano surge la necesidad de realizar modificaciones. Ya sea que estemos añadiendo nuevos atributos o creando nuevas relaciones, implementar estos cambios de manera efectiva y segura es crucial. Evitar manipulaciones directamente sobre la estructura es una práctica segura y adecuada. Para lograrlo, utilizamos un sistema de migraciones que nos permite manejar, generar y aplicar los cambios sin afectar la integridad de los datos.

¿Por qué utilizar migraciones en el manejo de bases de datos?

Las migraciones ayudan a mantener un control de versión de las modificaciones en la base de datos. Esto asegura que cualquier cambio sea registrado y pueda ser replicado en otros entornos de manera eficaz.

Ventajas de las migraciones:

Control de cambios: Cada modificación en la base de datos queda documentada.
Deshacer cambios: Permite revertir cambios si fuese necesario.
Consistencia entre entornos: Facilita la replicación de cambios en diferentes entornos de desarrollo y producción.
Minimización de errores: Reduce el riesgo de errores humanos al no realizar cambios manuales en la estructura de la base de datos.

¿Cómo agregar atributos de fecha automáticamente?

Añadir atributos que registren las fechas de creación y actualización de un registro es una buena práctica en gestión de base de datos. Estos campos son especialmente útiles para realizar auditorías y seguimiento del ciclo de vida de los datos.

Pasos para adicionar los atributos:

Crear atributos en la entidad:
- CreateData para registrar cuándo se creó el registro.
- UpdateData para registrar cuándo se actualizó el registro.
Utilizar decoradores específicos:
- Usar decoradores como CreateDataColumn y UpdateDataColumn para manejar automáticamente los valores de estos campos aprovechando las capacidades de gestión de fechas y zonas horarias.
Configurar el tipo de datos:
- Definir los campos como timestamp with time zone (TZ) para asegurar consistencia sin importar la zona horaria del entorno.

@CreateDataColumn({ type: 'timestamp with time zone', default: () => 'CURRENT_TIMESTAMP' })
createdAt: Date;

@UpdateDataColumn({ type: 'timestamp with time zone', default: () => 'CURRENT_TIMESTAMP', onUpdate: 'CURRENT_TIMESTAMP' })
updatedAt: Date;

¿Cómo generar y aplicar una migración?

Para llevar los cambios a la base de datos, debemos seguir estos pasos:

Generar la migración:
- Desde la terminal, ejecutamos un comando para generar una nueva migración que añada los campos.
- Ejemplo de comando en TypeORM:
```
typeorm migration:generate -n AddFields
```
Aplicar la migración:
- Corremos la migración generada para que los cambios reflejen en la base de datos:
```
typeorm migration:run
```
Verificar los cambios:
- Comprobamos que los campos están correctamente añadidos.
- Herramientas como PgAdmin nos ayudan a visualizar la estructura de la base de datos y confirmar los nuevos campos.

¿Cómo verificar el impacto de los nuevos atributos?

Una vez ejecutada la migración, es importante validar el comportamiento de los nuevos atributos en el sistema:

Crear y consultar registros: Usa herramientas como Insomnia para insertar o consultar datos y observar cómo los atributos de fecha se llenan automáticamente.
Validar con ejemplos prácticos: Realizar operaciones CRUD y verificar el correcto funcionamiento de los campos CreateData y UpdateData.

Este enfoque no solo incrementa la fiabilidad de la base de datos, sino que también abre las puertas hacia una administración más eficiente y segura de los datos. ¡Continúa explorando y practicando para dominar estas técnicas y llevar tus habilidades al siguiente nivel!

Eduardo Pech

student•

Lo que vimos:

product.entity.ts

import {
  PrimaryGeneratedColumn,
  Column,
  Entity,
  CreateDateColumn,
  UpdateDateColumn,
} from 'typeorm';

@Entity()
export class Product {
  @PrimaryGeneratedColumn()
  id: number;

  @Column({ type: 'varchar', length: 255, unique: true })
  name: string;

  @Column({ type: 'text' })
  description: string;

  @Column({ type: 'int' })
  price: number;

  @Column({ type: 'int' })
  stock: number;

  @Column({ type: 'varchar' })
  image: string;

  @CreateDateColumn({
    type: 'timestamptz',
    default: () => 'CURRENT_TIMESTAMP',
  })
  createAt: Date;

  @UpdateDateColumn({
    type: 'timestamptz',
    default: () => 'CURRENT_TIMESTAMP',
  })
  updateAt: Date;
}

Carlos Rosado

student•

En mi caso que estoy usando mysql solo me funciono de esta forma

@Column({ type: "timestamp", default: () => "CURRENT_TIMESTAMP"})
  createAt: Date;

@Column({ type: "timestamp", default: () => "CURRENT_TIMESTAMP"})
  updateAt: Date;

Gustavo Restrepo

student•

Me funcionó así, muchas gracias, sólo es cambiar los decoradores y el timestamp

Walter Lensinas

student•

Al agregar cambios a una entidad, se tiene que generar la migracion y ejecutarla.

Se le agrega a la entidad product las fechas de creacion y actualizacion automaticas:

import {
  PrimaryGeneratedColumn,
  Column,
  Entity,
  CreateDateColumn,
  UpdateDateColumn,
} from 'typeorm';

@Entity()
export class Product {
  @PrimaryGeneratedColumn()
  id: number;

  @Column({ type: 'varchar', length: 255, unique: true })
  name: string;

  @Column({ type: 'text' })
  description: string;

  @Column({ type: 'int' })
  price: number;

  @Column({ type: 'int' })
  stock: number;

  @Column({ type: 'varchar' })
  image: string;

  @CreateDateColumn({
    type: 'timestamptz',
    default: () => 'CURRENT_TIMESTAMP',
  })
  createAt: Date;

  @UpdateDateColumn({
    type: 'timestamptz',
    default: () => 'CURRENT_TIMESTAMP',
  })
  updateAt: Date;

Se genera la migracion npm run migrations:generate -- add-fields

Migration /home/wlensinas/code/nestjs-typeorm/src/database/migrations/1621891104050-add-fields.ts has been generated successfully.

Se ejecutan los cambios en la base de datos npm run migrations:run

query: SELECT * FROM "information_schema"."tables" WHERE "table_schema" = current_schema() AND "table_name" = 'migrations'
query: SELECT * FROM "migrations" "migrations" ORDER BY "id" DESC
1 migrations are already loaded in the database.
2 migrations were found in the source code.
init1621883836551 is the last executed migration. It was executed on Mon May 24 2021 16:17:16 GMT-0300 (Argentina Standard Time).
1 migrations are new migrations that needs to be executed.
query: START TRANSACTION
query: ALTER TABLE "product" ADD "createAt" TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT CURRENT_TIMESTAMP
query: ALTER TABLE "product" ADD "updateAt" TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT CURRENT_TIMESTAMP
query: INSERT INTO "migrations"("timestamp", "name") VALUES ($1, $2) -- PARAMETERS: [1621891104050,"addFields1621891104050"]
Migration addFields1621891104050 has been executed successfully.
query: COMMIT

Se listan los cambios npm run migrations:show

query: SELECT * FROM "information_schema"."tables" WHERE "table_schema" = current_schema() AND "table_name" = 'migrations'
query: SELECT * FROM "migrations" "migrations" ORDER BY "id" DESC
 [X] init1621883836551
 [X] addFields1621891104050

Ruben Dario Toro Gutierrez

student•

Este curso esta genial, he aprendido una gran cantidad de conceptos y buenas practicas que no sabía ni que existían

Carlyle Komalram

student•

[ExceptionHandler] No repository for "Brand" was found. Looks like this entity is not registered in current 
"default" connection? +184ms

Por si les sale este error, recuerden agregar en el archivo database.module.ts la propiedad de autoLoadEntities.

Andrés Esteban Rodríguez Jiménez

student•

Modificando una entidad

Supongamos que ahora queremos modificar una entidad como por ejemplo Product, veamos como hacerlo:

**src/products/entities/product.entity.ts**:

@Entity()
export class Product {
  // ...

  // fecha de producto creado con formato de zona horaría automática y creado de forma automática
  @CreateDateColumn({ type: 'timestamptz', default: () => 'CURRENT_TIMESTAMP' })
  createdAt: Date;

  // fecha de producto actualizado con formato de zona horaría automática y creado de forma automática
  // se actualiza cada que hagamos un "".save()"
  @UpdateDateColumn({ type: 'timestamptz', default: () => 'CURRENT_TIMESTAMP' })
  updatedAt: Date;
}

¿Pero ahora como le decimos a nuestra API que actualizamos esta entidad? Para esto vamos a nuestra terminal y ejecutamos los siguientes comandos.

# creamos migración
npm run migration:generate

# ejecutamos migración
npm run migration:run

Y listo, ya debería actualizar nuestros datos en nuestra tabla de manera adecuada, así de fácil es correr migraciones de actualización de entidades con TypeORM:

Marcos Plata

student•

otra forma en que podría entenderse las migraciones, es que cada una representa un estado de la BD en alguna instancia de tiempo, tenerlas organizadas de esta manera nos permite incluso regresarnos a algún estado anterior si es necesario.

Sergio Leon

student•

y si quiero volver atras alguna de las migraciones?

Carlos Aguirre Rivera

student•

que pasa si yo tengo que agregar un campo no null y ya tengo data en esa tabla?, cuando tengo el sincronize me salta un error hasta que la haga nullable y la cree una vez creada debo modificar a todos los campos y ponerle un valor, luego nuevamente cambiar a no null y recien carga. en migraciones como es que me ayuda en este ejemplo?

Pablo Jesús Rosales Juárez

student•

Agregué los timestamps, se inserta correctamente en la DB, pero no los retorna al crearlos en postman, tampoco cuando listo todos las entidades.

Alguien sabrá el por qué ? Gracias !

Gabriel Hernández Valdez

student•

Hola Pablo, estuve con lo mismo, ejecuta un "npm run prebuild" para borrar la carpeta dist, en caso de que no funcione (como a mi:

Deten el servidor de desarrollo
Borra la carpeta dist
inicia de nuevo el servidor

Con eso ya me aparecieron esos dos campos en las consultas :D

Alexis Martínez Arteaga

student•

Si ya tengo una base de datos predefinida con las tablas y columnas que se van a usar, las migraciones no son necesarias?

Diego Jose Chavez

student•

Las migraciones serían necesarias en el caso de que tengas que modificar las estructura de tu base de datos o de alguna tabla en particular, como por ejemplo: agregar una columna nueva a una tabla, modificar un tipo de dato, agregar una tabla nueva ...

Juan Camilo Noreña López

student•

Tengo este error: query: SELECT * FROM current_schema() query: SELECT version(); query: SELECT * FROM "information_schema"."tables" WHERE "table_schema" = 'public' AND "table_name" = 'migrations' query: SELECT * FROM "migrations" "migrations" ORDER BY "id" DESC No migrations are pending

Juan Camilo Noreña López

student•

¿Cómo puedo insertar todas las tablas con una sola migración?

Miguel Angel Reyes Moreno

student•

Maravilloso el curso hasta aquí, ¡vamos con todo!