How to inject a custom repository

[andrzepakula]

[x] Support request

Hi. How to inject a custom repository http://typeorm.io/#/custom-repository ? And second question this indicates that we shouldn't be creating services from custom repositories, especially if you want to use transactions. What do you think
? Best Regards

[xmlking]

So far I am implementing like this.
Wanted to validate with @kamilmysliwiec if this is the intended way of use for custom repositories!

project.repository.ts

import { Connection, EntityRepository } from 'typeorm';
import { Project } from './project.entity';
import { Injectable } from '@nestjs/common';
import { AuditMongoRepository } from '../core/repositories/audit-mongo.repository';

@Injectable()
@EntityRepository(Project)
export class ProjectRepository extends AuditMongoRepository<Project> {
}

export const ProjectRepositoryProvider = {
  provide: 'ProjectRepository',
  useFactory: (connection: Connection) => connection.getCustomRepository(ProjectRepository),
  inject: [Connection],
};

audit-mongo.repository.ts

export abstract class AuditMongoRepository<Entity> extends MongoRepository<Entity> {
// overwrite some methods for audit
}

project.module.ts

@Module({
  imports: [
    SharedModule,
    TypeOrmModule.forFeature([Project])],
  providers: [
    ProjectService,
    ProjectRepositoryProvider,
  ],
  controllers: [ProjectController],
})
export class ProjectModule {}

project.service.ts

@Injectable()
export class ProjectService  {
  private readonly logger = new Logger(ProjectService.name);
  constructor(
    private readonly projectRepository: ProjectRepository,
  ) {
  }
}

[xmlking]

I also see following implementation, but it doesn't work for me :(

https://github.com/QuentinouLeTwist/nestjs-vuejs-boilerplate/tree/master/backend/src/modules/api/user

[andrzepakula]

I think that this is not the way to solve this problem, because @kamilmysliwiec did not respond to the next comments in the thread #14. Functionality is theoretically merged, but it is hard for me to understand how to implement it only after the changes .. A more important problem is that the TypeOrm documentation does not recommend the global registration of custom repositories, as they are not a single instance .

[xmlking]

Looks like custom repositories are injected same way like entities

https://github.com/evebook/api/tree/master/src/modules/character

[mentos1386]

@xmlking Yeah, they are injected same way as entities. It was added with this PR #12

It should probably be noted in documentation that there is a way of injecting them...

EDIT: It is documented in the docs https://docs.nestjs.com/techniques/database under Repository Pattern

[kamilmysliwiec]

EDIT: It is documented in the docs https://docs.nestjs.com/techniques/database under Repository Pattern

So is there anything that still should be clarified?

[et]

@kamilmysliwiec - that only demonstrates how to set up the entity.
I am very grateful for @xmlking sharing the custom repository example. As obvious as the implementation is to do it, it wasn't clear to me how to actually achieve it. Maybe having something in the nestjs samples folder would help.

[MattIzSpooky]

Hello everyone, I ran into the same issue and I finally figured it out how to do it. I don't agree with the first answer given because you aren't supposed to make the repository a provider/service as is written here. This is not documented so that's why I'd like to share how I did it.

Edit: I created a separate issue that can be found here. You can find the answer there.

[kamilmysliwiec]

Just created an issue in the documentation repository. I'll use @MattIzSpooky example and share solution very soon :)

[Roms1383]

Looks like custom repositories are injected same way like entities

https://github.com/evebook/api/tree/master/src/modules/character

Sadly this link is broken 😿

[kamilmysliwiec]

https://docs.nestjs.com/techniques/database#custom-repository