Typeorm: Error: Entity metadata was not found

[zxr90]

// conversation_pairs.ts

@Entity()
export class ConversationPairs {

  @PrimaryGeneratedColumn()
  id: number;

  @ManyToOne(type => Users, user_id => user_id.conversation_pairs, {
    cascadeRemove: true,
    nullable: false
  })
  user_id: Users;

  @ManyToOne(type => Agents, agent_id => agent_id.conversation_pairs, {
    cascadeRemove: true,
    nullable: false
  })
  agent_id: Agents;
}

// user.ts

@Entity()
export class Users {
  @PrimaryGeneratedColumn()
  id: number;

  @OneToMany(type => ConversationPairs, conversation_pairs => conversation_pairs.user_id)
  conversation_pairs: ConversationPairs[];
}

// agent.ts

@Entity()
export class Agents {

  @PrimaryGeneratedColumn()
  id: number;

  @OneToMany(type => ConversationPairs, conversation_pairs => conversation_pairs.agent_id)
  conversation_pairs: ConversationPairs[];
}

I have these 3 files and getting this error when I start my app.

Error: Entity metadata for ConversationPairs#user_id was not found.
    at /Users/xuanrong/Sites/calllevels/dbs-chat/node_modules/typeorm/metadata-builder/EntityMetadataBuilder.js:272:27
    at Array.forEach (native)
    at /Users/xuanrong/Sites/calllevels/dbs-chat/node_modules/typeorm/metadata-builder/EntityMetadataBuilder.js:269:38
    at Array.forEach (native)
    at EntityMetadataBuilder.build (/Users/xuanrong/Sites/calllevels/dbs-chat/node_modules/typeorm/metadata-builder/EntityMetadataBuilder.js:268:25)
    at EntityMetadataBuilder.buildFromMetadataArgsStorage (/Users/xuanrong/Sites/calllevels/dbs-chat/node_modules/typeorm/metadata-builder/EntityMetadataBuilder.js:152:21)
    at Connection.buildMetadatas (/Users/xuanrong/Sites/calllevels/dbs-chat/node_modules/typeorm/connection/Connection.js:552:18)
    at Connection.<anonymous> (/Users/xuanrong/Sites/calllevels/dbs-chat/node_modules/typeorm/connection/Connection.js:174:30)
    at step (/Users/xuanrong/Sites/calllevels/dbs-chat/node_modules/typeorm/connection/Connection.js:32:23)
    at Object.next (/Users/xuanrong/Sites/calllevels/dbs-chat/node_modules/typeorm/connection/Connection.js:13:53)

Not sure what to do, need some help on this.

[tomkroening]

I ran into the same issue.

TypeORM is very difficult to debug with args and meta data classes/collections all over the place. After many hours I was able to figure it out.

So this relationship is failing because EntityMetadataBuilder.ts is trying to tie the type of the ManyToOne column with a known entity type using "===".

var inverseEntityMetadata = entityMetadatas.find(function (m) { return m.target === relation.type || (typeof relation.type === "string" && m.targetName === relation.type); });

Looking at relation.type I could see that it is the same "type" as m.target however they were not pointing to the same reference of the defined type. It seemed to me as if my related class was being loaded by node more than once. After reading about how node caches modules I was able to fix my problem by making sure all of my import statements were referencing the same file including uppercase/lowercase letters in the string.

In one file I had

import { Category } from "./models/category";

and the other I had

import { Category } from "./Category";

Notice the uppercase "C". After replacing with a lowercase "c" everything worked as expected.

[pleerock]

@zxr90 you should not have this error. Most probably something is wrong on your side. Please provide a minimal reproduction git repo for this issue, so I can debug.

[NoNameProvided]

I can confirm @tomkroening solution. Importing the same Entity from a different path will cause the following error:

Error: Entity metadata for Category#users was not found. Check if you specified a correct entity object, check its really entity and its connected in the connection options.

This error is somewhat misleading as it suggests that you haven't imported your entities. While that can be a valid reason for this, the other can be above mentioned import path issue pointed out by @tomkroening.

How solve this error most effectively? You can do the following steps:

First lets understand from where the error is coming from. TypeORM says that it cannot find the Category#users relation. So the problem is with the User entity in this case. Category was found successfully but TypeORM was not able to find the related User entity.

So what you have to search for is the import { User code snippet, and check if all the import paths point to the same location.

Ok so now we can ask what is exactly a same location? Two path is exactly the same if they point to the same location when resolved by the filesystem.

A few example:

Lets assume we have the following tree structure:

├─ services
│   └── folderx
│      └── foldery
│         └── xy.service.ts
└─ entities
│   ├── index.ts
│   └─ user.entity.ts
└─ xy.ts

Where index.ts re-export user.entity.ts (aka it's a barell file.)

Then importing user.entity.ts from xy.service.ts as ../../../entities is resolved as the same as importing the user.entity.ts from xy.ts as ./entities, while importing it as ./entities/user.entity would not resolve as the same because it's points to ./entities/user.entity.ts file instead of ./entities/index.ts file.

[pleerock]

Conclusion: this error happening when you have misspelled your entity name, misspelled import paths or did not include your entity in connection configuration.

[silberjan]

@tomkroening thank you so much for this! i would have never guessed this.

[michaelonubogugauge]

@NoNameProvided @tomkroening Thank you so much. Your thorough explanation helped me to resolve my issue. For me, it was basically changing an import reference from:

import {Entity} from './' \\via index.ts

to

import {Entity} from './Entity'

Basically setting an explicit reference to the entity. Thanks again.

[amitport]

for future reference:

I got this error when my typescript was configured to compile files in-folder (e.g., src/entity.ts to src/entity.js)

[ADongre1]

@amitport
Did you ever resolve your issue? I am transpiling to js so I can use in iisnode. I am getting the same issue you are experiencing.

[amitport]

@ADongre1, not a real resolution -- I just configured typescript to not generate js in the same folder.

[ADongre1]

Hmm, I have it transpiling to build folder, but still the same issue.

[pleerock]

you simply need to point a proper paths to js files

[Razzwan]

I have the same problem, but my conclusins is different:

I have such structure for my two entities:

import { Entity, ManyToMany, JoinTable } from 'typeorm';
import { Role } from '../role';

@Entity()
export class User {
  @ManyToMany(type => Role, role => role.users)
  @JoinTable({ name: 'user_roles' })
  roles: Role[];
}

import { ManyToMany } from 'typeorm';
import { User } from '../user/user.entity';

@Entity()
export class Role {
  @ManyToMany(type => User, user => user.roles)
  users: User[];
}

This two entites does not work together, but if I remove any of relation from Role (role.users) or from User (user.roles) entity - all works correctly. Perhaps, something wrong not only with filesistem paths, but also with circular dependecies

[hallsbyra]

For the record, I experienced the same problem. Went through all imports to ensure they were correct. Problem remained. Turned out it was because I used ts-node to launch the app. Worked fine after a tsc build and normal node start.

[jackswiggett]

I had the same issue. I was importing and re-exporting all my entities in src/entity/index.ts, e.g.

// src/entity/index.ts
export { Task } from './Task';
export { Unit } from './Unit';
export { User } from './User';

and then importing them from that index file to reference them in other entities, e.g.

// src/entity/User.ts
import {
  Task,
  Unit,
} from '.';

Rather than changing my import references like @michaelonubogugauge suggested, I just changed my ormconfig file from

entities: [ 'src/entity/**/*.ts' ]

to

entities: [ 'src/entity/index.ts' ]

which solved the problem for me.

[ayuthmang]

In this case, I solved by change the ormconfig.json content

.
.
  "entities": [
     "dist/entity/**/*.ts"
  ],

to

.
.
  "entities": [
     "dist/entity/**/*.js"
  ],

[anztrax]

or you had wrong entity when get repository

for examples :
right one :

class TemplateAccessor{
  static getRepo(){
    return getConnection().getRepository(Template);
  }
}

wrong one :

class TemplateAccessor{
  static getRepo(){
    return getConnection().getRepository(TemplateGroup);
  }
}

[jtushman]

@blacksourcez that worked for me too. But it feels like the wrong solution. I'd like to know why it doesn't work with the ts files. (are they looking fore the js or map files right next to the ts -- my tsc is putting compiled files to a dist folder)

[NSExceptional]

I get this error for a specific class when I add a static function to it. Can't figure out why.

[elderapo]

I came across this error when I forgot to decorate my newly created entity using "Entity" decorator.

[NSExceptional]

I figured it out. Circular references between entities break types passed directly to decorators. This is why TypeORM uses futures (type => MyClass)

[PapsOu]

I notice also that using custom paths breaks the references to entities

{
  "compilerOptions": {
    "paths": {
      "@user/*": [
        "src/user/*"
      ],
      "@common/*": [
        "src/common/*"
      ],
    }
  },
}

This one does not work :

import { User } from "@user/entity/user.entity";

@Entity()
export class Registration extends Resource {
  @OneToOne(type => User)
  @JoinColumn()
  user: User
}

This one works...

import { User } from "./user.entity";

@Entity()
export class Registration extends Resource {
  @OneToOne(type => User)
  @JoinColumn()
  user: User
}

The user.module declares the entities with the custom path :

import { Registration } from '@user/entity/registration.entity';
import { User } from '@user/entity/user.entity';

@Module({
  imports: [
    TypeOrmModule.forFeature([
      Registration,
      User
    ])
  ],
})
export class UserModule { }

Is it possible to re-open this issue in order to fix the Type check for entity metadata management ?

Because I don't know how it will behave with entities inside another module (e.g. the @common module)

[havenchyk]

@PapsOu could you please open another issue and provide a minimal example repo to reproduce the problem? It will help, might be your problem is not exactly the same as topic starter had

[AhmadDeel]

@ADongre1, not a real resolution -- I just configured typescript to not generate js in the same folder.

How ?

[AhmadDeel]

I had the same issue. I was importing and re-exporting all my entities in src/entity/index.ts, e.g.

// src/entity/index.ts
export { Task } from './Task';
export { Unit } from './Unit';
export { User } from './User';

and then importing them from that index file to reference them in other entities, e.g.

// src/entity/User.ts
import {
  Task,
  Unit,
} from '.';

Rather than changing my import references like @michaelonubogugauge suggested, I just changed my ormconfig file from

entities: [ 'src/entity/**/*.ts' ]

to

entities: [ 'src/entity/index.ts' ]

which solved the problem for me.

thanks a lot.
the problem was not file path as I was sure all of my import statements were referencing the same file.
I exported all my entities from database.entites.ts file and edited ormconfig.json as follows
"entities": [ "src/database.entities.ts" ],

[geabenitez]

Hello For me it was to forget to add the () at the end of @Entity()

[rpires]

I had this one bugging me for a while, a bit like @geabenitez I had forgot the @entity() annotation.

[geabenitez]

I had this one bugging me for a while, a bit like @geabenitez I had forgot the @entity() annotation.

Most likely you're newbie like me. Once you get used to it, it becomes easier.

[asselstine]

@tomkroening Thanks for the tip, you fixed our build.

We had some imports as:

import { UserEntity } from '../users/UserEntity'

or

// this will load from the index file
import { UserEntity } from '../users'

But once we made all of the imports consistent TypeORM started playing nice again.

[Davidkle]

ts-node doesn't compile the source files so it was looking at the compiled entity path.

I fixed the issue by adding both the compiled and raw entity paths.

const entities = [
  ".next/server/database/entity/**/*.js",
  "server/database/entity/**/*.ts"
];

[Kaperskyguru]

In this case, I solved by change the ormconfig.json content

.
.
  "entities": [
     "dist/entity/**/*.ts"
  ],

to

.
.
  "entities": [
     "dist/entity/**/*.js"
  ],

This solves my problem, Changing TS to JS

[arcoslwm]

In this case, I solved by change the ormconfig.json content

.
.
  "entities": [
     "dist/entity/**/*.ts"
  ],

to

.
.
  "entities": [
     "dist/entity/**/*.js"
  ],

Thanks! thats was works for me.

[DesiredApp]

to me I forgot to add @Entity("myEntityName") in my class

[sachinhf]

It works for me when I change ["_dirname + /..//.entity.ts"] to [ "_dirname + /..//.entity.js"] now it works with npm run start:dev

[bel7aG]

../anyFolder/AnyFileEndingWith .entity.ts
sometimes _./_ it's important.

_entities: [__dirname + '../**/*.entity.ts'],_

to

entities: [__dirname + './../*/.entity.ts']

[kvalium]

I stick to this error again and again on projects losing so much time looking for typos or paths that not exactly match from one file to another... plus the fact that the error message provides poor information, that's quite BS...

[rustamwin]

@kvalium see https://github.com/typeorm/typeorm/issues/420#issuecomment-515032082

[JZLeung]

In this case, I solved by change the ormconfig.json content

.
.
  "entities": [
     "dist/entity/**/*.ts"
  ],

to

.
.
  "entities": [
     "dist/entity/**/*.js"
  ],

thx.

[renjithspace]

Conclusion: this error happening when you have misspelled your entity name, misspelled import paths or did not include your entity in connection configuration.

@pleerock Thanks! 👍

[jboucly]

Hello For me it was to forget to add the () at the end of @entity()

Thanks !!!!!!!

[brense]

I had the same issue. I was importing and re-exporting all my entities in src/entity/index.ts, e.g.

// src/entity/index.ts
export { Task } from './Task';
export { Unit } from './Unit';
export { User } from './User';

and then importing them from that index file to reference them in other entities, e.g.

// src/entity/User.ts
import {
  Task,
  Unit,
} from '.';

Rather than changing my import references like @michaelonubogugauge suggested, I just changed my ormconfig file from

entities: [ 'src/entity/**/*.ts' ]

to

entities: [ 'src/entity/index.ts' ]

which solved the problem for me.

This guy deserves a medal

[awHamer]

I importing models from entities/index.ts file like:
import {Entity} from './index'

so In my case I fixed this issue simply to change ormconfig.ts
from:

  entities: [
        'src/entities/*.ts',
    ],

to

  entities: [
        'src/entities/index.ts',
    ],

[masakiando]

entities: [__dirname + '/../**/*.entity.{js,ts}'],

[ngocketit]

If you're using NestJS, you may have forgotten to add the entity to the TypeOrmModule.forFeature()

[ovichowdhury]

I also got that same error when i accidentally forgot to decorate the entity class with @Entity() decorator.

[kazartsevalex]

for me it was fixed by changing
entities: [__dirname + '../**/*.entity.ts'],
to
entities: [__dirname + '/../**/*.entity.js'],

UPD: oops haven't seen the @masakiando post, thumbs up for it!

[ChenxiiCheng]

entities: [__dirname + '/../**/*.entity.{js,ts}'],

@masakiando Thanks! This works for me.

[dutch3883]

I got error when using relation in Entity like @ManyToOne @OneToMany.
solved by import entity class directly from entity_name.ts file not from index or other place.
ex: import { Branch } from '.' => import { Branch } from './branch'

[jeanRandria]

Sometimes, you just need to delete dist folder and to retry.

• Check that entity is in the correct folder : @masakiando , and if it does not work ,you can also use index.ts
  But sometimes you just need to need to delete the dist folder and try again.
• Delete dist folder
• Ctrl+C
• Yes
• npm run start:dev

:)

[tmpires]

Hey, I am having a similar issue with IISNODE. The application runs fine via terminal through node comand. But on IISNODE it returns (node:6232) UnhandledPromiseRejectionWarning: RepositoryNotFoundError: No repository for "User" was found. Looks like this entity is not registered in current "default" connection? at new RepositoryNotFoundError (C:\api\node_modules\typeorm\error\RepositoryNotFoundError.js:11:28)
I use eslint and prettier, that checks file paths for me, but either way, I checked just to be sure, and they are all correct. Does anyone have any insight on what it could be?

[zachgoll]

As @ngocketit mentioned, this may be unrelated to your entity file or files altogether. In my case, I have all of my entities in a single file (to avoid circular dependency issues with nx and NestJs), but this problem still happens if I am not importing the entities to the correct feature module.

For example, if you have the following two entities:

@Entity('products')
export class ProductEntity {
  @PrimaryGeneratedColumn()
  public readonly id: number;

  @OneToMany(
     type => OrderEntity,
     order => order.product
  )
  @JoinColumn()
  orders: OrderEntity[]
}

@Entity('orders')
export class OrderEntity {
  @PrimaryGeneratedColumn()
  public readonly id: number;

  @ManyToOne(
     type => ProductEntity,
     product => product.orders
  )
  @JoinColumn()
  product: ProductEntity
}

And in your feature module, your import looks like this:

imports: [TypeOrmModule.forFeature([ProductEntity])]

Even if you do not use OrderEntity explicitly within this feature module, you need to import it for the relationships to resolve correctly:

imports: [TypeOrmModule.forFeature([ProductEntity, OrderEntity])]

[bluerid]

@zachgoll In-fact I was forgetting to create a new module to add the entity to forFeature while I was trying to use my entity as a ManyToMany relation joinTable. When I created a new module and provided the entity to TypeOrmModule.forFeature([]) it started working again. So everyone should focus on the second line of error if it's not a common problem with import statements or @entity decorator.

[bennycode]

I got the following error:

Error: Entity metadata for AccountEntity#owner was not found. Check if you specified a correct entity object and if it's connected in the connection options.

And I was very convinced that my setup was correct:

AccountEntity.ts

// ...
@ManyToOne(() => OwnerEntity, owner => owner.accounts, {onDelete: 'CASCADE'})
owner!: OwnerEntity;
// ...

OwnerEntity.ts

// ...
@OneToMany(() => AccountEntity, account => account.owner)
accounts!: AccountEntity[];
// ...

initDatabase.ts

Object.assign(connectionOptions, {
  entities: [
    AccountEntity,
    OwnerEntity
  ],
  logging: false,
  migrations: [],
  subscribers: [],
  synchronize: true,
});

After half an hour of debugging (luckily not hours!) I noticed that I was missing the @Entity() annotation in my OwnerEntity class. 🙈 So be smarter than me and don't make the same mistake. 😄

[DadiAnas]

I was using './src/product' as a folder and then I changed it to './src/products', but the built folder 'product' in ./dist did not updated so it caused this problem.
To solve this I just removed 'dist' folder and then re-built the project, while I'm using yarn I wrote on the terminal this command:
yarn build

[sourisengupta]

In my case I forgot to add the entity to my typeorm.config.ts file.
After adding that in the entities it ran perfectly.

[drnic]

My version of this issue was I had typed Entity() rather than @Entity().

Alas neither ts-node nor vs code decided this was a syntax error ("typescript": "3.3.3333" currently hardcoded by typeorm init)

[fkirc]

In my case, this error was triggered by WebPack's TerserPlugin (JavaScript-minification).
I extended the following blog to make this stuff work with create-react-app: https://www.telerik.com/blogs/using-webassembly-with-react, using the following create-react override config:

// eslint-disable-next-line @typescript-eslint/no-var-requires
const path = require("path");
// eslint-disable-next-line @typescript-eslint/no-var-requires
const webpack = require("webpack");
// eslint-disable-next-line @typescript-eslint/no-var-requires
const CopyPlugin = require("copy-webpack-plugin");
// eslint-disable-next-line @typescript-eslint/no-var-requires
const getClientEnvironment = require("./config/env");
// eslint-disable-next-line @typescript-eslint/no-var-requires
const paths = require("./config/paths");

module.exports = function override(config, env) {
  /**
   * Add WASM support
   */
  // Make file-loader ignore WASM files
  const wasmExtensionRegExp = /\.wasm$/;
  config.resolve.extensions.push(".wasm");
  config.module.rules.forEach((rule) => {
    (rule.oneOf || []).forEach((oneOf) => {
      if (oneOf.loader && oneOf.loader.indexOf("file-loader") >= 0) {
        oneOf.exclude.push(wasmExtensionRegExp);
      }
    });
  });

  // Add a dedicated loader for WASM
  config.module.rules.push({
    test: wasmExtensionRegExp,
    include: path.resolve(__dirname, "src"),
    use: [{ loader: require.resolve("wasm-loader"), options: {} }],
  });

  const mangleOptions =
    config.optimization?.minimizer[0]?.options?.terserOptions?.mangle;
  if (!mangleOptions) {
    console.log("Did not find mangle options of TerserPlugin");
  } else {
    const reservedArray = mangleOptions.reserved ?? [];
    reservedArray.push(
      ...[
        "Initial1588635951915",
        "MyEntity1",
        "MyEntity2",
        "MyEntity3",
      ]
    );
    mangleOptions.reserved = reservedArray;
    console.log(
      "Configured reservedArray for TerserPlugin",
      mangleOptions.reserved
    );
  }
  const plugins = config.plugins;
  if (!Array.isArray(plugins) || !plugins.length) {
    throw Error("Did not find plugins");
  }
  const clientEnv = getClientEnvironment(paths.publicUrlOrPath.slice(0, -1));
  if (clientEnv.platforms.isBrowser) {
    // Provide sql.js (wasm version) for TypeORM if not building for mobile
    plugins.push(
      new webpack.ProvidePlugin({
        "window.initSqlJs": "sql.js",
        "window.SQL": "sql.js/dist/sql-wasm.js",
      })
    );
    // Copy wasm file to the output dir
    plugins.push(
      new CopyPlugin([
        { from: "node_modules/sql.js/dist/sql-wasm.wasm", to: "static/js/" },
      ])
    );
    // replace typeorm with typeorm browser implementation
    plugins.push(
      new webpack.NormalModuleReplacementPlugin(/typeorm$/, function (result) {
        result.request = result.request.replace(/typeorm/, "typeorm/browser");
      })
    );
  }
  return config;
};

[dozieogbo]

For me, this issue happened because I forgot to add @Entity at the top of my class 🤦‍♂️ so don't forget to check if your issue is the same.

[akashlama1998]

In NestJS adding .js along side .ts worked for me

typeorm.config.ts

Before

import { TypeOrmModuleOptions } from '@nestjs/typeorm';

export const TypeORMConfig: TypeOrmModuleOptions = {
  type: 'postgres',
  url: process.env.DATABASE_URL,
  synchronize: true,
  entities: [__dirname + '/../**/*.entity.ts'],
  migrationsTableName: 'Migrations_History',
};

After

import { TypeOrmModuleOptions } from '@nestjs/typeorm';

export const TypeORMConfig: TypeOrmModuleOptions = {
  type: 'postgres',
  url: process.env.DATABASE_URL,
  synchronize: true,
  entities: [__dirname + '/../**/*.entity{.ts,.js}'],
  migrationsTableName: 'Migrations_History',
};