Saltar al contenido principal

Uso de la CLI

Traducción Beta No Oficial

Esta página fue traducida por PageTurner AI (beta). No está respaldada oficialmente por el proyecto. ¿Encontraste un error? Reportar problema →

Instalación de la CLI​

Si los archivos de entidades están en JavaScript​

Si tienes una versión local de TypeORM, asegúrate de que coincida con la versión global que instalaremos.

Puedes instalar TypeORM globalmente con npm i -g typeorm. También puedes optar por usar npx typeorm <params> para cada comando si prefieres no instalarlo.

Si los archivos de entidades están en TypeScript​

Esta herramienta CLI está escrita en JavaScript y se ejecuta en Node. Si tus archivos de entidades están en TypeScript, deberás transpilarlos a JavaScript antes de usar la CLI. Puedes omitir esta sección si solo usas JavaScript.

Puedes configurar ts-node en tu proyecto para facilitar la operación de la siguiente manera:

Instala ts-node:

npm install ts-node --save-dev

Añade el comando typeorm en la sección scripts de package.json

"scripts": {
    ...
    "typeorm": "typeorm-ts-node-commonjs"
}

Para proyectos ESM añade esto en su lugar:

"scripts": {
    ...
    "typeorm": "typeorm-ts-node-esm"
}

Si deseas cargar más módulos como module-alias puedes añadir más --require my-module-supporting-register

Luego puedes ejecutar el comando así:

npm run typeorm migration:run -- -d path-to-datasource-config

¿Cómo leer esta documentación?​

Para reducir la verbosidad de la documentación, las siguientes secciones usan una CLI de TypeORM instalada globalmente. Dependiendo de cómo hayas instalado la CLI, puedes reemplazar typeorm al inicio del comando por npx typeorm o npm run typeorm.

Inicializar un nuevo proyecto de TypeORM​

Puedes crear un nuevo proyecto con todo configurado:

typeorm init

Crea todos los archivos necesarios para un proyecto básico con TypeORM:

  • .gitignore

  • package.json

  • README.md

  • tsconfig.json

  • src/entity/User.ts

  • src/index.ts

Luego puedes ejecutar npm install para instalar todas las dependencias. Después, puedes ejecutar tu aplicación con npm start.

Todos los archivos se generan en el directorio actual. Si quieres generarlos en un directorio específico puedes usar --name:

typeorm init --name my-project

Para especificar una base de datos concreta puedes usar --database:

typeorm init --database mssql

Para generar un proyecto base ESM usa --module esm:

typeorm init --name my-project --module esm

También puedes generar un proyecto base con Express:

typeorm init --name my-project --express

Si usas Docker puedes generar un archivo docker-compose.yml con:

typeorm init --docker

typeorm init es la forma más fácil y rápida de configurar un proyecto TypeORM.

Crear una nueva entidad​

Puedes crear una nueva entidad usando la CLI:

typeorm entity:create path-to-entity-dir/entity

Aprende más sobre entidades.

Crear un nuevo suscriptor​

Puedes crear un nuevo suscriptor usando la CLI:

typeorm subscriber:create path-to-subscriber-dir/subscriber

Aprende más sobre Suscriptores.

Gestionar migraciones​

  • typeorm migration:create - crear una migración vacía

  • typeorm migration:generate - generar migración comparando entidades con esquema actual de la base de datos

  • typeorm migration:run - ejecutar todas las migraciones

  • typeorm migration:revert - revertir la última migración

  • typeorm migration:show - listar todas las migraciones con su estado de ejecución

Aprende más sobre Migraciones.

Sincronizar esquema de base de datos​

Para sincronizar el esquema de la base de datos usa:

typeorm schema:sync

Ten cuidado al usar este comando en producción - la sincronización de esquemas puede causar pérdida de datos si no se usa con precaución. Verifica qué consultas SQL ejecutará antes de usarlo en producción.

Registrar consultas de sincronización sin ejecutarlas​

Para verificar qué consultas SQL ejecutaría schema:sync sin aplicarlas:

typeorm schema:log

Eliminar esquema de base de datos​

Para eliminar completamente un esquema de base de datos usa:

typeorm schema:drop -- -d path-to-datasource-config

Extrema precaución con este comando en producción ya que elimina todos los datos de tu base de datos.

Ejecutar consultas SQL personalizadas​

Puedes ejecutar cualquier consulta SQL directamente en la base de datos usando:

typeorm query "SELECT * FROM USERS"

Limpiar caché​

Si usas caché en QueryBuilder, a veces querrás vaciar todo su contenido. Puedes hacerlo con:

typeorm cache:clear

Verificar versión​

Puedes verificar tu versión instalada de TypeORM (tanto local como global) con:

typeorm version