find-options.md

Find Options

All repository and manager find methods accept special options you can use to query data you need without using QueryBuilder:

• select - indicates which properties of the main object must be selected

userRepository.find({ select: ["firstName", "lastName"] });

• relations - relations needs to be loaded with the main entity. Sub-relations can also be loaded (shorthand for join and leftJoinAndSelect)

userRepository.find({ relations: ["profile", "photos", "videos"] });
userRepository.find({ relations: ["profile", "photos", "videos", "videos.video_attributes"] });

• join - joins needs to be performed for the entity. Extended version of "relations".

userRepository.find({ 
    join: {
        alias: "user",
        leftJoinAndSelect: {
            "profile": "user.profile",
            "photo": "user.photos",
            "video": "user.videos"
        }
    }
});

• where - simple conditions by which entity should be queried.

userRepository.find({ where: { firstName: "Timber", lastName: "Saw" } });

• order - selection order.

userRepository.find({ 
    order: {
        "name": "ASC",
        "id": "DESC"
    }
});

find methods which return multiple entities (find, findAndCount, findByIds) also accept following options:

• skip - offset (paginated) from where entities should be taken.

userRepository.find({ 
    skip: 5
});

• take - limit (paginated) - max number of entities that should be taken.

userRepository.find({ 
    take: 10
});

• cache - Enables or disables query result caching. See caching for more information and options.

userRepository.find({
    cache: true
})

Complete example of find options:

userRepository.find({ 
    select: ["firstName", "lastName"],
    relations: ["profile", "photos", "videos"],
    where: { 
        firstName: "Timber", 
        lastName: "Saw" 
    },
    order: {
        "name": "ASC",
        "id": "DESC"
    },
    skip: 5,
    take: 10,
    cache: true
});