Typeorm when trying to run migrations: Missing required argument: dataSource

Question

I'm trying to run TypeORM migrations with ormconfig.json like this

{
  "name": "default",
  "type": "postgres",
  "host": "ip-is-here",
  "port": 5432,
  "username": "name",
  "password": "12345",
  "database": "db1",
  "synchronize": false,
  "logging": false,
  "entities": ["dist/storage/**/*.js"],
  "migrations": ["dist/storage/migrations/**/*.js"],
  "cli": {
    "entitiesDir": "src/storage",
    "migrationsDir": "src/storage/migrations"
  }
}

via yarn typeorm migration:run
But get an error:

Missing required argument: dataSource

What I have to do? Thank you for your advices!

Aiq0 · Accepted Answer · 2022-10-16 17:24:04Z

50

TypeOrm removed ormconfig.json support in version 0.3.0. You should use new syntax - create ormconfig.ts and specify options for you database, for example:

export const connectionSource = new DataSource({
    migrationsTableName: 'migrations',
    type: 'postgres',
    host: 'localhost',
    port: 5432,
    username: 'user',
    password: 'pass',
    database: 'somehealthchecker',
    logging: false,
    synchronize: false,
    name: 'default',
    entities: ['src/**/**.entity{.ts,.js}'],
    migrations: ['src/migrations/**/*{.ts,.js}'],
    subscribers: ['src/subscriber/**/*{.ts,.js}'],
});

Then, after running the connection:

await connectionSource.initialize();

You can get entities by:

const myRepo = connectionSource.getRepository(SomeEntity)

Also your scripts in package.json should look like this:

"migration:generate": "./node_modules/.bin/ts-node ./node_modules/.bin/typeorm migration:generate -d src/modules/config/ormconfig.ts",
"migration:up": "./node_modules/.bin/ts-node ./node_modules/.bin/typeorm migration:run -d src/modules/config/ormconfig.ts",
"migration:down": "./node_modules/.bin/ts-node ./node_modules/.bin/typeorm migration:revert -d src/modules/config/ormconfig.ts",

After the command, just give the name for migration in the console without -n option

edited Oct 16, 2022 at 17:24

Aiq0

3811 silver badge14 bronze badges

answered Apr 12, 2022 at 10:35

capraljohn

5945 silver badges8 bronze badges

Sign up to request clarification or add additional context in comments.

6 Comments

Matt Kocaj Over a year ago

This wanago.io/2022/07/25/api-nestjs-database-migrations-typeorm is a far more useful tutorial than the official docs

Mendel Groner Over a year ago

I am using NestJS, and I had to create an extra file that exports the DataSource object just for this purpose.

capraljohn Over a year ago

For my Nestjs projects, I also create a separate database configuration file to generate the migrations. I haven't found a way to make TypeOrm read configurations from a module yet, but it looks like TypeOrm can't do that. Since we use our own module system in Nestjs, if we were using Express, for example, we would need to create such a file one way or another, and there would be no problem. But at least it works

OSA413 Over a year ago

I wish this was written in the documentation

Ritesh Khatri Over a year ago

Then how can we import typeormmodule options in the AppModule? Or we have to write again all the configuration there?

|

arun-r · Accepted Answer · 2022-08-17 16:33:38Z

16

with latest typescript if you are using cli setup as per typeorm setup

then following package.json script will work

"scripts": {
   "typeorm": "typeorm-ts-node-commonjs -d ./src/datasources/PostgresDatasource.ts",
}

Run npm run typeorm migration:generate src/migration/initaltables npm run typeorm migration:run

answered Aug 17, 2022 at 16:33

arun-r

3,4112 gold badges25 silver badges21 bronze badges

1 Comment

AmirHossein Rezaei Aug 8 at 10:41

Very nice answer .Thank you very much

Aiq0 · Accepted Answer · 2022-10-16 19:01:31Z

7

Please don't forget --

If you need to pass parameter with dash to npm script, you will need to add them after --. For example, if you need to generate, the command is like this:
npm run typeorm migration:generate -- -n migrationNameHere

Docs here.

edited Oct 16, 2022 at 19:01

Aiq0

3811 silver badge14 bronze badges

answered Jul 4, 2022 at 1:05

Nicolás

711 silver badge3 bronze badges

1 Comment

Tyler2P Over a year ago

While this link may answer the question, it is better to include the essential parts of the answer here and provide the link for reference. Link-only answers can become invalid if the linked page changes.

Sanka Sanjeeva · Accepted Answer · 2023-07-09 13:38:12Z

6

I got the same error while following their doc

npx typeorm-ts-node-commonjs migration:run -- -d ./src/data-source.ts

But it worked removing --

npx typeorm-ts-node-commonjs migration:run -d ./src/data-source.ts

So, I updated my package.json a little bit

"scripts": {
  "migration:run": "typeorm-ts-node-commonjs migration:run -d ./src/data-source.ts",
  "migration:revert": "typeorm-ts-node-commonjs migration:revert -d ./src/data-source.ts"
}

edited Jul 9, 2023 at 13:38

answered Jul 9, 2023 at 13:26

Sanka Sanjeeva

3,84830 silver badges34 bronze badges

1 Comment

Robert S Over a year ago

How to add scripts for generate command for migration in package.json. By the below way --- "generate": "typeorm migration:generate -n PostRefactoring". It is not working.

Ng Dang Khoa · Accepted Answer · 2022-04-11 14:38:47Z

2

Just figure out that you have to define the path to the file where your Datasource is defined. In my case: yarn typeorm migration:run -d dist/datasources/datasource.js

answered Apr 11, 2022 at 14:38

Ng Dang Khoa

214 bronze badges

1 Comment

Loc Tran Over a year ago

hi,in my case this is have the path:dist/data-source.js but it still not work,can you have another way?

Ghimmy · Accepted Answer · 2022-08-14 04:38:14Z

Use the App - Datasource method to initialize your connection and it's quit easier from there

export const AppDataSource = new DataSource({
    type: "postgres",
    host: "localhost",
    port: 5432,
    username: "postgres",
    password: "ROOT",
    database: "userLog",
    synchronize: true,
    logging: true, 
    entities: [User, Student],
    migrations: ["src/migration/**/*.ts"],
    migrationsTableName: "custom_migration_table",
    subscribers: ["src/migration/**/*.ts"],
})

Initialize your connection.

AppDataSource.initialize()
  .then(async () => {
    // do anything here like connecting to your express server or adding document to your db
  }

If it's a Javascript project, use this CLI command - typeorm migration:run

But if your project uses typescript, you can use ts-node in conjunction with typeorm to run .ts migration files. use the following commands

"create": "typeorm migration:create ./src/migration/learningMigration"
"generate": "typeorm migration:generate -n PostRefactoring"
"migrate": "npx typeorm-ts-node-commonjs migration:run -d src/data-source", 
"revert": "npx typeorm-ts-node-commonjs migration:revert -d src/data-source",

Collectives™ on Stack Overflow

Typeorm when trying to run migrations: Missing required argument: dataSource

6 Answers 6

6 Comments

1 Comment

1 Comment

1 Comment

1 Comment

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

6 Answers 6

6 Comments

1 Comment

1 Comment

1 Comment

1 Comment

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related