import { EntityMetadata } from "../metadata/EntityMetadata"; import { FindManyOptions } from "../find-options/FindManyOptions"; import { ObjectLiteral } from "../common/ObjectLiteral"; import { FindOneOptions } from "../find-options/FindOneOptions"; import { DeepPartial } from "../common/DeepPartial"; import { SaveOptions } from "./SaveOptions"; import { RemoveOptions } from "./RemoveOptions"; import { EntityManager } from "../entity-manager/EntityManager"; import { QueryRunner } from "../query-runner/QueryRunner"; import { SelectQueryBuilder } from "../query-builder/SelectQueryBuilder"; /** * Repository is supposed to work with your entity objects. Find entities, insert, update, delete, etc. */ export declare class Repository { /** * Entity Manager used by this repository. */ readonly manager: EntityManager; /** * Entity metadata of the entity current repository manages. */ readonly metadata: EntityMetadata; /** * Query runner provider used for this repository. */ readonly queryRunner?: QueryRunner; /** * Creates a new query builder that can be used to build a sql query. */ createQueryBuilder(alias: string, queryRunner?: QueryRunner): SelectQueryBuilder; /** * Returns object that is managed by this repository. * If this repository manages entity from schema, * then it returns a name of that schema instead. */ readonly target: Function | string; /** * Checks if entity has an id. * If entity composite compose ids, it will check them all. */ hasId(entity: Entity): boolean; /** * Gets entity mixed id. */ getId(entity: Entity): any; /** * Creates a new entity instance. */ create(): Entity; /** * Creates a new entities and copies all entity properties from given objects into their new entities. * Note that it copies only properties that present in entity schema. */ create(entityLikeArray: DeepPartial[]): Entity[]; /** * Creates a new entity instance and copies all entity properties from this object into a new entity. * Note that it copies only properties that present in entity schema. */ create(entityLike: DeepPartial): Entity; /** * Merges multiple entities (or entity-like objects) into a given entity. */ merge(mergeIntoEntity: Entity, ...entityLikes: DeepPartial[]): Entity; /** * Creates a new entity from the given plan javascript object. If entity already exist in the database, then * it loads it (and everything related to it), replaces all values with the new ones from the given object * and returns this new entity. This new entity is actually a loaded from the db entity with all properties * replaced from the new object. * * Note that given entity-like object must have an entity id / primary key to find entity by. * Returns undefined if entity with given id was not found. */ preload(entityLike: DeepPartial): Promise; /** * Saves all given entities in the database. * If entities do not exist in the database then inserts, otherwise updates. */ save(entities: Entity[], options?: SaveOptions): Promise; /** * Saves a given entity in the database. * If entity does not exist in the database then inserts, otherwise updates. */ save(entity: Entity, options?: SaveOptions): Promise; /** * Saves all given entities in the database. * If entities do not exist in the database then inserts, otherwise updates. */ persist(entities: Entity[], options?: SaveOptions): Promise; /** * Saves a given entity in the database. * If entity does not exist in the database then inserts, otherwise updates. */ persist(entity: Entity, options?: SaveOptions): Promise; /** * Updates entity partially. Entity can be found by a given conditions. */ update(conditions: Partial, partialEntity: DeepPartial, options?: SaveOptions): Promise; /** * Updates entity partially. Entity can be found by a given find options. */ update(findOptions: FindOneOptions, partialEntity: DeepPartial, options?: SaveOptions): Promise; /** * Updates entity partially. Entity will be found by a given id. */ updateById(id: any, partialEntity: DeepPartial, options?: SaveOptions): Promise; /** * Removes a given entities from the database. */ remove(entities: Entity[], options?: RemoveOptions): Promise; /** * Removes a given entity from the database. */ remove(entity: Entity, options?: RemoveOptions): Promise; /** * Removes entity by a given entity id. */ removeById(id: any, options?: RemoveOptions): Promise; /** * Removes entity by a given entity id. */ removeByIds(ids: any[], options?: RemoveOptions): Promise; /** * Counts entities that match given options. */ count(options?: FindManyOptions): Promise; /** * Counts entities that match given conditions. */ count(conditions?: DeepPartial): Promise; /** * Finds entities that match given options. */ find(options?: FindManyOptions): Promise; /** * Finds entities that match given conditions. */ find(conditions?: DeepPartial): Promise; /** * Finds entities that match given find options. * Also counts all entities that match given conditions, * but ignores pagination settings (from and take options). */ findAndCount(options?: FindManyOptions): Promise<[Entity[], number]>; /** * Finds entities that match given conditions. * Also counts all entities that match given conditions, * but ignores pagination settings (from and take options). */ findAndCount(conditions?: DeepPartial): Promise<[Entity[], number]>; /** * Finds entities by ids. * Optionally find options can be applied. */ findByIds(ids: any[], options?: FindManyOptions): Promise; /** * Finds entities by ids. * Optionally conditions can be applied. */ findByIds(ids: any[], conditions?: DeepPartial): Promise; /** * Finds first entity that matches given options. */ findOne(options?: FindOneOptions): Promise; /** * Finds first entity that matches given conditions. */ findOne(conditions?: DeepPartial): Promise; /** * Finds entity by given id. * Optionally find options can be applied. */ findOneById(id: any, options?: FindOneOptions): Promise; /** * Finds entity by given id. * Optionally conditions can be applied. */ findOneById(id: any, conditions?: DeepPartial): Promise; /** * Executes a raw SQL query and returns a raw database results. * Raw query execution is supported only by relational databases (MongoDB is not supported). */ query(query: string, parameters?: any[]): Promise; /** * Clears all the data from the given table/collection (truncates/drops it). * * Note: this method uses TRUNCATE and may not work as you expect in transactions on some platforms. * @see https://stackoverflow.com/a/5972738/925151 */ clear(): Promise; }