Custom repositories

You can create a custom repository which should contain methods to work with your database. Usually custom repositories are created for a single entity and contains its specific queries. For example, let's say we want to have a method called findByName(firstName: string, lastName: string) which will search for users by a given first and last names. The best place for this method is in Repository, so we could call it like userRepository.findByName(...). You can achieve this using custom repositories.
There are several ways how custom repositories can be created.
​Custom repository extends standard Repository​
​Custom repository extends standard AbstractRepository​
​Custom repository without extends​
​Using custom repositories in transactions​
Custom repository extends standard Repository
The first way to create a custom repository is to extend Repository. Example:
1
import {EntityRepository, Repository} from "typeorm";
2
import {User} from "../entity/User";
3
​
4
@EntityRepository(User)
5
export class UserRepository extends Repository<User> {
6
​
7
    findByName(firstName: string, lastName: string) {
8
        return this.findOne({ firstName, lastName });
9
    }
10
​
11
}
Copied!
Then you can use it this way:
1
import {getCustomRepository} from "typeorm";
2
import {UserRepository} from "./repository/UserRepository";
3
​
4
const userRepository = getCustomRepository(UserRepository); // or connection.getCustomRepository or manager.getCustomRepository()
5
const user = userRepository.create(); // same as const user = new User();
6
user.firstName = "Timber";
7
user.lastName = "Saw";
8
await userRepository.save(user);
9
​
10
const timber = await userRepository.findByName("Timber", "Saw");
Copied!
As you can see you can "get" the repository using getCustomRepository and you can access any method created inside it and any method in the standard entity repository.
Custom repository extends standard AbstractRepository
The second way to create a custom repository is to extend AbstractRepository:
1
import {EntityRepository, AbstractRepository} from "typeorm";
2
import {User} from "../entity/User";
3
​
4
@EntityRepository(User)
5
export class UserRepository extends AbstractRepository<User> {
6
​
7
    createAndSave(firstName: string, lastName: string) {
8
        const user = new User();
9
        user.firstName = firstName;
10
        user.lastName = lastName;
11
        return this.manager.save(user);
12
    }
13
​
14
    findByName(firstName: string, lastName: string) {
15
        return this.repository.findOne({ firstName, lastName });
16
    }
17
​
18
}
Copied!
Then you can use it this way:
1
import {getCustomRepository} from "typeorm";
2
import {UserRepository} from "./repository/UserRepository";
3
​
4
const userRepository = getCustomRepository(UserRepository); // or connection.getCustomRepository or manager.getCustomRepository()
5
await userRepository.createAndSave("Timber", "Saw");
6
const timber = await userRepository.findByName("Timber", "Saw");
Copied!
The difference between this type of repository and the previous one is that it does not expose all the methods Repository has. AbstractRepository does not have any public methods, it only has protected methods, like manager and repository, which you can use in your own public methods. Extending AbstractRepository is useful if you don't want to expose all methods the standard Repository has to the public.
Custom repository without extends
The third way to create a repository is to not extend anything, but define a constructor which always accepts an entity manager instance:
1
import {EntityRepository, Repository, EntityManager} from "typeorm";
2
import {User} from "../entity/User";
3
​
4
@EntityRepository()
5
export class UserRepository {
6
​
7
    constructor(private manager: EntityManager) {
8
    }
9
​
10
    createAndSave(firstName: string, lastName: string) {
11
        const user = new User();
12
        user.firstName = firstName;
13
        user.lastName = lastName;
14
        return this.manager.save(user);
15
    }
16
​
17
    findByName(firstName: string, lastName: string) {
18
        return this.manager.findOne(User, { firstName, lastName });
19
    }
20
​
21
}
Copied!
Then you can use it this way:
1
import {getCustomRepository} from "typeorm";
2
import {UserRepository} from "./repository/UserRepository";
3
​
4
const userRepository = getCustomRepository(UserRepository); // or connection.getCustomRepository or manager.getCustomRepository()
5
await userRepository.createAndSave("Timber", "Saw");
6
const timber = await userRepository.findByName("Timber", "Saw");
Copied!
This type of repository does not extend anything - you only need to define a constructor which must accept EntityManager. Then you can use it everywhere in your repository methods. Also, this type of repository is not bound to a specific entity, thus, you can operate with multiple entities inside them.
Using custom repositories in transactions or why custom repositories cannot be services
Custom repositories cannot be services, because there isn't a single instance of a custom repository (just like regular repositories or entity manager) in the app. Besides the fact that there can be multiple connections in your app (where entity manager and repositories are different) repositories and managers are different in transactions as well. For example:
1
await connection.transaction(async manager => {
2
    // in transactions you MUST use manager instance provided by a transaction,
3
    // you cannot use global managers, repositories or custom repositories
4
    // because this manager is exclusive and transactional
5
    // and if let's say we would do custom repository as a service
6
    // it has a "manager" property which should be unique instance of EntityManager
7
    // but there is no global EntityManager instance and cannot be
8
    // thats why custom managers are specific to each EntityManager and cannot be services.
9
    // this also opens opportunity to use custom repositories in transactions without any issues:
10
    
11
    const userRepository = manager.getCustomRepository(UserRepository); // DONT USE GLOBAL getCustomRepository here!
12
    await userRepository.createAndSave("Timber", "Saw");
13
    const timber = await userRepository.findByName("Timber", "Saw");
14
});
Copied!

Working with Connection

Decorator reference

Last modified 30d ago

Copy link

Contents

Custom repository extends standard Repository

Custom repository extends standard AbstractRepository

Custom repository without extends

Using custom repositories in transactions or why custom repositories cannot be services