CLI

Manejo de ciclo de vida del schema y tareas relacionadas

La CLI de jsorm maneja inicialización, introspección de schema, migraciones, health checks y queries ad-hoc.

Instalación

# Ejecutar init (no requiere instalación global previa)
pnpm dlx jsorm@latest init

# O con npm
npx jsorm@latest init

Modo config-first

Cuando jsorm.config.ts está configurado, la mayoría de comandos no requieren argumentos adicionales:

jsorm migrate:status     # muestra pendientes vs aplicadas
jsorm migrate            # aplica todas las pendientes
jsorm db:check           # verifica conectividad

Referencia de comandos

init

Inicializa jsorm en un proyecto nuevo o existente. Guiado de forma interactiva:

pnpm dlx jsorm@latest init

Genera jsorm.config.ts, descarga el engine binario de Rust, instala adaptador y peer dependency, e imprime próximos pasos.

---

table:create

Imprime el DDL SQL para crear una tabla desde un modelo compilado:

jsorm table:create ./dist/models.js User

---

migrate:statement

Genera la declaración SQL de migración de un migration source:

jsorm migrate:statement ./dist/schema.js ormSource

---

migrate:generate

Genera un archivo de migración haciendo diff de los modelos actuales contra un snapshot almacenado:

jsorm migrate:generate

Requiere generateSource definido en jsorm.config.ts. Emite un archivo de migración con timestamp.

---

migrate

Aplica todas las migraciones pendientes:

jsorm migrate
jsorm migrate ./dist/schema.js ormSource  # modo módulo

---

migrate:up

Aplica la siguiente migración:

jsorm migrate:up

---

migrate:down

Revierte el último batch de migraciones:

jsorm migrate:down

Precaución

migrate:down está restringido en producción. Establece JSORM_ALLOW_UNSAFE_OPERATIONS=true para sobreescribir.

---

migrate:status

Lista el estado actual de todas las migraciones:

jsorm migrate:status

---

db:fresh

Elimina el schema y re-ejecuta todas las migraciones desde cero:

JSORM_ALLOW_UNSAFE_OPERATIONS=true jsorm db:fresh

Precaución

Destructivo — todos los datos se eliminan. Requiere JSORM_ALLOW_UNSAFE_OPERATIONS=true.

---

db:rollback

Revierte todas las migraciones aplicadas:

JSORM_ALLOW_UNSAFE_OPERATIONS=true jsorm db:rollback

---

db:check

Verifica conectividad de base de datos contra todos los connection sources configurados:

jsorm db:check

Equivale a jsorm.healthCheck() por programación.

---

db:seed

Ejecuta una función seed contra la base de datos configurada:

jsorm db:seed ./dist/seed.js runSeed

---

Matriz de seguridad de comandos

Comando	Seguro en prod	Requiere override
migrate	✅	—
migrate:up	✅	—
migrate:status	✅	—
migrate:generate	✅	—
db:check	✅	—
migrate:down	⚠️	JSORM_ALLOW_UNSAFE_OPERATIONS=true
db:rollback	❌	JSORM_ALLOW_UNSAFE_OPERATIONS=true
db:fresh	❌	JSORM_ALLOW_UNSAFE_OPERATIONS=true

Variables de entorno

Variable	Descripción
DATABASE_URL	Sobreescribe la connection string del connection source por defecto
JSORM_DEBUG	Activa logging de resolución de config y ejecución del engine
JSORM_ALLOW_UNSAFE_OPERATIONS	Permite comandos destructivos (e.g. db:fresh, db:rollback)
JSORM_LIMIT_DEFAULT	Sobreescribe el límite por defecto de 150 filas cuando no se especifica paginación

Modo módulo-exportación (legacy)

Pasa el archivo JS compilado y el nombre exportado cuando no uses config-first:

jsorm migrate ./dist/schema.js ormSource
jsorm migrate:up ./dist/schema.js ormSource
jsorm migrate:down ./dist/schema.js ormSource
jsorm migrate:status ./dist/schema.js ormSource