English | 한국어

1. Installation
2. Quick Start
3. Note

Installation

npm install nestjs-liquibase

Quick Start

1. Create Liquibase Changelog

The usage is described in the following structure. if you use a different structure, it should be applied as information in a different structure.

src/db/root.yaml
src/db/changelog/*.sql

See /examples for more information.

2. Import LiquibaseModule

@Module({
    imports: [
        // ...
        LiquibaseModule.regsiter({
            allow: true,
            config: {
                ...
            }
        })
    ],
})
export class AppModule {}

• The LiquibaseModule.register() function requires a parameter of Type LiquibaseDynamicConfig.
• config is type of LiquibaseConfig based on liquibase library.

LiquibaseDynamicConfig Example

LiquibaseModule.register({
    allow: true,
    config: {
      searchPath: "dist/db",
      changeLogFile: "root.yaml",
      url: "jdbc:postgresql://localhost:5432/postgres",
      username: "postgres",
      password: "mypassword", 
    }
  })

• You can also add it using LiquibaseModule.registerAsync()

3. Edit nest-cli.json When server build, edit nest-cli.json so that the Liquibase related files are can be copied to the build result.

"compilerOptions": {
    "assets" : [
      {
        "include" : "db/root.yaml",
        "outDir" : "dist"
      },
      {
        "include": "db/changelog/*",
        "outDir": "dist"
      }
    ],
}

When you build server, It will be copied to the build result as follows.

dist
  ㄴ db
    ㄴ root.yaml
    ㄴ changelog
      ㄴ create_member.sql 

4. Run server

npm run start

Console Output

Note

• Currently, LiquibaseModule run update command of Liquibase