Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pavlokobyliatskyi/typeorm-migrations
TypeORM Migrations in NX.js
https://github.com/pavlokobyliatskyi/typeorm-migrations
microservices migrations nestjs nxjs typeorm
Last synced: 6 days ago
JSON representation
TypeORM Migrations in NX.js
- Host: GitHub
- URL: https://github.com/pavlokobyliatskyi/typeorm-migrations
- Owner: pavlokobyliatskyi
- Created: 2024-11-24T20:34:53.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2025-01-06T16:19:48.000Z (25 days ago)
- Last Synced: 2025-01-06T17:28:03.797Z (25 days ago)
- Topics: microservices, migrations, nestjs, nxjs, typeorm
- Language: TypeScript
- Homepage:
- Size: 167 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# [TypeORM](https://typeorm.io/) Migrations 😅
(Important): Just use [Drizzle ORM](https://orm.drizzle.team/)
*In this example I am using full paths for better understanding*
Here is the [nx](https://nx.dev/) project which has one app [cars-service](apps/cars-service).
The directory is called [database](apps/cars-service/src/database) and is located in the [cars-service](apps/cars-service) app, which is used only for working with migrations in dev and prod.
The parameters for connecting to the database are located in the [.env](.env) file in the root of the project.
In dev we work with **.ts** files in prod only with **.js**.
### Goals
- [x] Does not affect the code and can be removed at any time
- [x] Unified database connection settings
- [x] Typing support during development
---
### Dev
*Change NODE_ENV to **dev** in .env file*
Creating Migrations
*Here **init** is the migration name*
```bash
npx typeorm migration:create ./apps/cars-service/src/database/migrations/init
```
Generating Migrations
*Here **cars-create-table** is the migration name*
```bash
npx ts-node-dev -P ./apps/cars-service/tsconfig.app.json ./node_modules/typeorm/cli.js migration:generate ./apps/cars-service/src/database/migrations/cars-create-table -d ./apps/cars-service/src/database/typeorm.config.ts
```
Show migration
```bash
npx ts-node-dev -P ./apps/cars-service/tsconfig.app.json ./node_modules/typeorm/cli.js migration:show -d ./apps/cars-service/src/database/typeorm.config.ts
```
Applying Migrations
```bash
npx ts-node-dev -P ./apps/cars-service/tsconfig.app.json ./node_modules/typeorm/cli.js migration:run -d ./apps/cars-service/src/database/typeorm.config.ts
```
Rolling Back Migrations
```bash
npx ts-node-dev -P ./apps/cars-service/tsconfig.app.json ./node_modules/typeorm/cli.js migration:revert -d ./apps/cars-service/src/database/typeorm.config.ts
```
### Build
*If you want to create a docker image, just create a Dockerfile and do the same*
Build the [cars-service](apps/cars-service) app
```bash
nx run cars-service:build
```
Build **typescript.config.ts** and **migrations**
```bash
npx tsc ./apps/cars-service/src/database/*.ts ./apps/cars-service/src/database/**/*.ts --outDir ./dist/apps/cars-service/database
```
### Prod
*Change NODE_ENV to **prod** in .env file*
Applying Migrations
```bash
typeorm -d ./dist/apps/cars-service/database/typeorm.config.js migration:run
```
Rolling Back Migrations
```bash
typeorm -d ./dist/apps/cars-service/database/typeorm.config.js migration:revert
```
---
If the **.env** file is in a special location, use [env-cmd](https://www.npmjs.com/package/env-cmd).
```bash
./node_modules/.bin/env-cmd -f ./.env typeorm -d ./dist/apps/cars-service/database/typeorm.config.js migration:run
```
### Nx Executors (Commands)
You can set up [commands](https://nx.dev/nx-api/nx/executors/run-commands) to work with migrations, for example
```json
"migration:create": {
"executor": "nx:run-commands",
"options": {
"command": "npx typeorm migration:create src/database/migrations/{args.name}",
"cwd": "apps/cars-service"
}
}
```
Or
```json
"migration:generate": {
"executor": "nx:run-commands",
"options": {
"command": "npx ts-node-dev -P ./tsconfig.app.json ./../../node_modules/typeorm/cli.js migration:generate ./src/database/migrations/{args.name} -d ./src/database/typeorm.config.ts",
"cwd": "apps/cars-service"
}
}
```
And then call the command through the terminal
```bash
nx run cars-service:migration:create --name=init
```
Or
```bash
nx run cars-service:migration:generate --name=cars-add-color-column
```