clones/immich
1
0
Fork 0
mirror of https://github.com/immich-app/immich.git synced 2024-09-22 11:07:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

Added database migration info to docs

Browse Source
This commit is contained in:
Alex 2022-11-10 09:30:32 -06:00
parent a1a7e6ac06
commit 739bed737e
No known key found for this signature in database
GPG Key ID: 53CD082B3A5E1082
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/docs/contribution-guidelines.md
View File

@ -80,3 +80,15 @@ OpenAPI is used to generate the client (Typescript, Dart) SDK. `openapi-generato
npm run api:generate # Run from the `server` directory
```
You can find the generated client SDK in the `web/src/api` for Typescript SDK and `mobile/openapi` for Dart SDK.
## Database migrations
After making any changes in the `server/libs/database/src/entities`, a database migration need to run in order to register the changes in the database. Follow the steps below to create a new migration.
1. Attached to the server container shell.
2. Run
```bash
npm run typeorm -- migration:generate ./libs/database/src/<migration-name> -d libs/database/src/config/database.config.ts
```
3. Check if the migration file makes sense.
4. Move the migration file to folder `server/libs/database/src/migrations` in your code editor.