Usage with environment variables

[rmainwork]

Issue type:

• question
• bug report
• feature request
• documentation issue

Database system/driver:

• cordova
• mongodb
• mssql
• mysql / mariadb
• oracle
• postgres
• cockroachdb
• sqlite
• sqljs
• react-native
• expo

TypeORM version:

• latest
• @next
• 0.x.x (or put your version here)

Steps to reproduce or a small repository showing the problem:

I'm currently trying to configure TypeORM by passing a config object into the constructor from my config service.

@Module({
  imports: [
    ConfigModule,
    TypeOrmModule.forRootAsync({
      imports: [ConfigModule],
      useFactory: async (
        config: ConfigService
      ): Promise<TypeOrmModuleOptions> => (config.dbOptions),
      inject: [ConfigService],
    }),
  ],
  providers: [
    ConfigService,
  ],
})

This works fine, but the problem is that I can't find a way to have TypeORM use this configuration to run migrations...it seems to expect an ormconfig.json file on disk...which isn't there because my config is coming in via ConfigService. This means that I can't currently run my migrations because typeorm can't find my ormconfig.json file.

How do I tell TypeORM to use the configuration values provided to the constructor?

[vlapo]

Do you run migration using typeorm cli?

[rmainwork]

Yep

[vlapo]

There is no way how to use it this way. Your ConfigService is nestjs code and typeorm know nothing about nest. You have to write your own scrip, initialize nestjs and run migrations programatically. Or you have to use ormconfig.json.

[vlapo]

Ok we have property in connection options. You have to set migrationsRun and migrations. Typeorm should run pending migrations right after connect.

[rmainwork]

So, I'd have to create some kind of CLI interface for my app to run the migrations?

[vlapo]

If you want to use typeorm cli with some external service like ConfigService yes. Otherwise use migrationsRun and run migrations every time nestjs application is started.

[rmainwork]

Yeah, not liking the sound of that for my prod environment. Might go with the CLI option, thanks.

[jspizziri]

I came across this issue when trying to consistently use environment variables without a file. It's not exactly the issue described here, however at the root level it sounds like the same problem.

If you're using Docker and setting the env variables in your container, you might run into an issue where it appears that the CLI requires env to be loaded from a file, you just need to set either the TYPEORM_CONNECTION or TYPEORM_URL variables, and then the CLI will load config from the environment.

IMHO, it'd be better design to do this by default instead of checking for specific env variables and require a specific argument with the path if you wanted to load from a file, but I'll leave that for the maintainers to sort out.

Hope this helps!

[tobyhinloopen]

One could use ormconfig.js (or ormconfig.ts when using ts-node) and load your config there. Let the cli know to import that config file with the --config option.

import * as config from "config";
import { SnakeNamingStrategy } from "typeorm-naming-strategies";

export = {
  ...config.get("typeorm") as object,
  namingStrategy: new SnakeNamingStrategy(),
  entities: ["src/entity/*.ts"],
  migrations: ["db/migration/*.ts"],
  subscribers: [],
  cli: {
    migrationsDir: "db/migration",
  },
};

I invoke this with ts-node ./node_modules/typeorm/cli.js --config ormconfig.ts.

Ofcourse, I bet you could just use node ./node_modules/typeorm/cli.js --config ormconfig.js and export your config object there based on environment variables. Remember to use module.exports = {} for plain JS.

I've also added ts-node ./node_modules/typeorm/cli.js --config ormconfig.ts to my "scripts" in my package.json:

  "scripts": {
    "typeorm": "ts-node ./node_modules/typeorm/cli.js --config ormconfig.ts"
  }

...and I've this to make invoking it even easier:

$ cat bin/typeorm 
#!/bin/sh
npm run typeorm -- $@

$ cat .envrc 
export NODE_ENV=development
PATH_add bin
PATH_add node_modules/.bin

So I can just do typeorm migration:run, and have it magically load the correct config AND allow importing TS modules in my config.

To deploy, the following commands are used on the server:

export NODE_ENV=production
NODE_ENV=development npm install
npm run build
bin/typeorm migration:run
sh ./restart.sh