Skip to content

Latest commit

 

History

History
23 lines (19 loc) · 920 Bytes

04_databaseMigrations.md

File metadata and controls

23 lines (19 loc) · 920 Bytes

Database Migrations

Create Migration File

  1. Run the following command in your iR Engine repo:
cd packages/server-core
  1. Run the following command to generate a TIMESTAMP_NAME.ts migration file (eg: 20230418102549_eks-column.ts) in your in server-core folder:
npm run migrate:make -- {NAME}

eg: npm run migrate:make -- eks-column

  1. Move the migration file to your service's migrations folder.
    ie. packages/server-core/src/setting/aws-setting/migrations
  2. Update that file with code to match your needs.

OpenAPI

Our server is set up with Swagger documentation to automatically generate from most endpoints.
A few custom routes are not documented, but most of the basic stuff is.

You can see the OpenAPI docs in on our dev cluster, or locally for a running iR Engine instance at:
https://localhost:3030/openapi