import type { DataSource } from "../data-source/DataSource"; import type { FindManyOptions } from "../find-options/FindManyOptions"; import type { EntityTarget } from "../common/EntityTarget"; import type { FindOneOptions } from "../find-options/FindOneOptions"; import type { DeepPartial } from "../common/DeepPartial"; import type { RemoveOptions } from "../repository/RemoveOptions"; import type { SaveOptions } from "../repository/SaveOptions"; import { MongoRepository } from "../repository/MongoRepository"; import { TreeRepository } from "../repository/TreeRepository"; import { Repository } from "../repository/Repository"; import { PlainObjectToNewEntityTransformer } from "../query-builder/transformer/PlainObjectToNewEntityTransformer"; import type { QueryRunner } from "../query-runner/QueryRunner"; import type { SelectQueryBuilder } from "../query-builder/SelectQueryBuilder"; import type { QueryDeepPartialEntity } from "../query-builder/QueryPartialEntity"; import type { ObjectId } from "../driver/mongodb/typings"; import type { InsertResult } from "../query-builder/result/InsertResult"; import type { UpdateResult } from "../query-builder/result/UpdateResult"; import type { DeleteResult } from "../query-builder/result/DeleteResult"; import type { FindOptionsWhere } from "../find-options/FindOptionsWhere"; import type { IsolationLevel } from "../driver/types/IsolationLevel"; import type { UpsertOptions } from "../repository/UpsertOptions"; import type { UpdateOptions } from "../repository/UpdateOptions"; import type { ObjectLiteral } from "../common/ObjectLiteral"; import type { PickKeysByType } from "../common/PickKeysByType"; /** * Entity manager supposed to work with any entity, automatically find its repository and call its methods, * whatever entity type are you passing. */ export declare class EntityManager { readonly "@instanceof": symbol; /** * DataSource used by this entity manager. */ readonly dataSource: DataSource; /** * DataSource used by this entity manager. * * @deprecated since 1.0.0. Use {@link dataSource} instance instead. */ get connection(): DataSource; /** * Custom query runner to be used for operations in this entity manager. * Used only in non-global entity manager. */ readonly queryRunner?: QueryRunner; /** * Once created and then reused by repositories. * Created as a future replacement for the #repositories to provide a bit more perf optimization. */ protected repositories: Map, Repository>; /** * Once created and then reused by repositories. */ protected treeRepositories: TreeRepository[]; /** * Plain to object transformer used in create and merge operations. */ protected plainObjectToEntityTransformer: PlainObjectToNewEntityTransformer; constructor(dataSource: DataSource, queryRunner?: QueryRunner); /** * Wraps given function execution (and all operations made there) in a transaction. * All database operations must be executed using provided entity manager. */ transaction(runInTransaction: (entityManager: EntityManager) => Promise): Promise; /** * Wraps given function execution (and all operations made there) in a transaction. * All database operations must be executed using provided entity manager. */ transaction(isolationLevel: IsolationLevel, runInTransaction: (entityManager: EntityManager) => Promise): Promise; /** * Executes raw SQL query and returns raw database results. * * @param query * @param parameters * @see [Official docs](https://typeorm.io/docs/Working%20with%20Entity%20Manager/entity-manager-api/) for examples. */ query(query: string, parameters?: any[] | ObjectLiteral): Promise; /** * Tagged template function that executes raw SQL query and returns raw database results. * Template expressions are automatically transformed into database parameters. * Raw query execution is supported only by relational databases (MongoDB is not supported). * Note: Don't call this as a regular function, it is meant to be used with backticks to tag a template literal. * * @example * entityManager.sql`SELECT * FROM table_name WHERE id = ${id}` * * @param strings * @param values */ sql(strings: TemplateStringsArray, ...values: unknown[]): Promise; /** * Creates a new query builder that can be used to build a SQL query. */ createQueryBuilder(entityClass: EntityTarget, alias: string, queryRunner?: QueryRunner): SelectQueryBuilder; /** * Creates a new query builder that can be used to build a SQL query. */ createQueryBuilder(queryRunner?: QueryRunner): SelectQueryBuilder; /** * Checks if entity has an id. */ hasId(entity: any): boolean; /** * Checks if entity of given schema name has an id. */ hasId(target: Function | string, entity: any): boolean; /** * Gets entity mixed id. */ getId(entity: any): any; /** * Gets entity mixed id. */ getId(target: EntityTarget, entity: any): any; /** * 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>(entityClass: EntityTarget, plainObject?: EntityLike): 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>(entityClass: EntityTarget, plainObjects?: EntityLike[]): Entity[]; /** * Merges two entities into one new entity. * * @param entityClass * @param mergeIntoEntity * @param entityLikes */ merge(entityClass: EntityTarget, mergeIntoEntity: Entity, ...entityLikes: DeepPartial[]): Entity; /** * Creates a new entity from the given plain 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. * * @param entityClass * @param entityLike */ preload(entityClass: EntityTarget, 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 all given entities in the database. * If entities do 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. */ save>(targetOrEntity: EntityTarget, entities: T[], options: SaveOptions & { reload: false; }): Promise; /** * Saves all given entities in the database. * If entities do not exist in the database then inserts, otherwise updates. */ save>(targetOrEntity: EntityTarget, entities: T[], options?: SaveOptions): Promise<(T & Entity)[]>; /** * Saves a given entity in the database. * If entity does not exist in the database then inserts, otherwise updates. */ save>(targetOrEntity: EntityTarget, entity: T, options: SaveOptions & { reload: false; }): Promise; /** * Saves a given entity in the database. * If entity does not exist in the database then inserts, otherwise updates. */ save>(targetOrEntity: EntityTarget, entity: T, options?: SaveOptions): Promise; /** * Removes a given entity from the database. */ remove(entity: Entity, options?: RemoveOptions): Promise; /** * Removes a given entity from the database. */ remove(targetOrEntity: EntityTarget, entity: Entity, options?: RemoveOptions): Promise; /** * Removes a given entity from the database. */ remove(entity: Entity[], options?: RemoveOptions): Promise; /** * Removes a given entity from the database. */ remove(targetOrEntity: EntityTarget, entity: Entity[], options?: RemoveOptions): Promise; /** * Records the delete date of all given entities. */ softRemove(entities: Entity[], options?: SaveOptions): Promise; /** * Records the delete date of a given entity. */ softRemove(entity: Entity, options?: SaveOptions): Promise; /** * Records the delete date of all given entities. */ softRemove>(targetOrEntity: EntityTarget, entities: T[], options?: SaveOptions): Promise; /** * Records the delete date of a given entity. */ softRemove>(targetOrEntity: EntityTarget, entity: T, options?: SaveOptions): Promise; /** * Recovers all given entities. */ recover(entities: Entity[], options?: SaveOptions): Promise; /** * Recovers a given entity. */ recover(entity: Entity, options?: SaveOptions): Promise; /** * Recovers all given entities. */ recover>(targetOrEntity: EntityTarget, entities: T[], options?: SaveOptions): Promise; /** * Recovers a given entity. */ recover>(targetOrEntity: EntityTarget, entity: T, options?: SaveOptions): Promise; /** * Inserts a given entity into the database. * Unlike save method executes a primitive operation without cascades, relations and other operations included. * Executes fast and efficient INSERT query. * Does not check if entity exist in the database, so query will fail if duplicate entity is being inserted. * You can execute bulk inserts using this method. * * @param target * @param entity */ insert(target: EntityTarget, entity: QueryDeepPartialEntity | QueryDeepPartialEntity[]): Promise; upsert(target: EntityTarget, entityOrEntities: QueryDeepPartialEntity | QueryDeepPartialEntity[], conflictPathsOrOptions: string[] | UpsertOptions): Promise; /** * Updates entity partially. Entity can be found by a given condition(s). * Unlike save method executes a primitive operation without cascades, relations and other operations included. * Executes fast and efficient UPDATE query. * Does not check if entity exist in the database. * Condition(s) cannot be empty. * * @param target * @param criteria * @param partialEntity * @param options */ update(target: EntityTarget, criteria: string | string[] | number | number[] | Date | Date[] | ObjectId | ObjectId[] | any, partialEntity: QueryDeepPartialEntity, options?: UpdateOptions): Promise; /** * Updates all entities of target type, setting fields from supplied partial entity. * This is a primitive operation without cascades, relations or other operations included. * Executes fast and efficient UPDATE query without WHERE clause. * * WARNING! This method updates ALL rows in the target table. * * @param target * @param partialEntity * @param options */ updateAll(target: EntityTarget, partialEntity: QueryDeepPartialEntity, options?: UpdateOptions): Promise; /** * Deletes entities by a given condition(s). * Unlike save method executes a primitive operation without cascades, relations and other operations included. * Executes fast and efficient DELETE query. * Does not check if entity exist in the database. * Condition(s) cannot be empty. * * @param targetOrEntity * @param criteria */ delete(targetOrEntity: EntityTarget, criteria: string | string[] | number | number[] | Date | Date[] | ObjectId | ObjectId[] | any): Promise; /** * Deletes all entities of target type. * This is a primitive operation without cascades, relations or other operations included. * Executes fast and efficient DELETE query without WHERE clause. * * WARNING! This method deletes ALL rows in the target table. * * @param targetOrEntity */ deleteAll(targetOrEntity: EntityTarget): Promise; /** * Records the delete date of entities by a given condition(s). * Unlike save method executes a primitive operation without cascades, relations and other operations included. * Executes fast and efficient UPDATE query. * Does not check if entity exist in the database. * Condition(s) cannot be empty. * * @param targetOrEntity * @param criteria */ softDelete(targetOrEntity: EntityTarget, criteria: string | string[] | number | number[] | Date | Date[] | ObjectId | ObjectId[] | any): Promise; /** * Restores entities by a given condition(s). * Unlike save method executes a primitive operation without cascades, relations and other operations included. * Executes fast and efficient UPDATE query. * Does not check if entity exist in the database. * Condition(s) cannot be empty. * * @param targetOrEntity * @param criteria */ restore(targetOrEntity: EntityTarget, criteria: string | string[] | number | number[] | Date | Date[] | ObjectId | ObjectId[] | any): Promise; /** * Checks whether any entity exists with the given options. * * @param entityClass * @param options */ exists(entityClass: EntityTarget, options?: FindManyOptions): Promise; /** * Checks whether any entity exists with the given conditions. * * @param entityClass * @param where */ existsBy(entityClass: EntityTarget, where: FindOptionsWhere | FindOptionsWhere[]): Promise; /** * Counts entities that match given options. * Useful for pagination. * * @param entityClass * @param options */ count(entityClass: EntityTarget, options?: FindManyOptions): Promise; /** * Counts entities that match given conditions. * Useful for pagination. * * @param entityClass * @param where */ countBy(entityClass: EntityTarget, where: FindOptionsWhere | FindOptionsWhere[]): Promise; /** * Return the SUM of a column * * @param entityClass * @param columnName * @param where */ sum(entityClass: EntityTarget, columnName: PickKeysByType, where?: FindOptionsWhere | FindOptionsWhere[]): Promise; /** * Return the AVG of a column * * @param entityClass * @param columnName * @param where */ average(entityClass: EntityTarget, columnName: PickKeysByType, where?: FindOptionsWhere | FindOptionsWhere[]): Promise; /** * Return the MIN of a column * * @param entityClass * @param columnName * @param where */ minimum(entityClass: EntityTarget, columnName: PickKeysByType, where?: FindOptionsWhere | FindOptionsWhere[]): Promise; /** * Return the MAX of a column * * @param entityClass * @param columnName * @param where */ maximum(entityClass: EntityTarget, columnName: PickKeysByType, where?: FindOptionsWhere | FindOptionsWhere[]): Promise; private callAggregateFun; /** * Finds entities that match given find options. * * @param entityClass * @param options */ find(entityClass: EntityTarget, options?: FindManyOptions): Promise; /** * Finds entities that match given find options. * * @param entityClass * @param where */ findBy(entityClass: EntityTarget, where: FindOptionsWhere | FindOptionsWhere[]): Promise; /** * Finds entities that match given find options. * Also counts all entities that match given conditions, * but ignores pagination settings (from and take options). * * @param entityClass * @param options */ findAndCount(entityClass: EntityTarget, options?: FindManyOptions): Promise<[Entity[], number]>; /** * Finds entities that match given WHERE conditions. * Also counts all entities that match given conditions, * but ignores pagination settings (from and take options). * * @param entityClass * @param where */ findAndCountBy(entityClass: EntityTarget, where: FindOptionsWhere | FindOptionsWhere[]): Promise<[Entity[], number]>; /** * Finds first entity by a given find options. * If entity was not found in the database - returns null. * * @param entityClass * @param options */ findOne(entityClass: EntityTarget, options: FindOneOptions): Promise; /** * Finds first entity that matches given where condition. * If entity was not found in the database - returns null. * * @param entityClass * @param where */ findOneBy(entityClass: EntityTarget, where: FindOptionsWhere | FindOptionsWhere[]): Promise; /** * Finds first entity by a given find options. * If entity was not found in the database - rejects with error. * * @param entityClass * @param options */ findOneOrFail(entityClass: EntityTarget, options: FindOneOptions): Promise; /** * Finds first entity that matches given where condition. * If entity was not found in the database - rejects with error. * * @param entityClass * @param where */ findOneByOrFail(entityClass: EntityTarget, where: FindOptionsWhere | FindOptionsWhere[]): Promise; /** * Clears all the data from the given table (truncates/drops it). * * Note: this method uses TRUNCATE and may not work as you expect in transactions on some platforms. * * @param entityClass * @param options * @param options.cascade * @see https://stackoverflow.com/a/5972738/925151 */ clear(entityClass: EntityTarget, options?: { cascade?: boolean; }): Promise; /** * Increments some column by provided value of the entities matched given conditions. * * @param entityClass * @param conditions * @param propertyPath * @param value */ increment(entityClass: EntityTarget, conditions: FindOptionsWhere, propertyPath: string, value: number | string): Promise; /** * Decrements some column by provided value of the entities matched given conditions. * * @param entityClass * @param conditions * @param propertyPath * @param value */ decrement(entityClass: EntityTarget, conditions: FindOptionsWhere, propertyPath: string, value: number | string): Promise; /** * Gets repository for the given entity class or name. * If single database connection mode is used, then repository is obtained from the * repository aggregator, where each repository is individually created for this entity manager. * When single database connection is not used, repository is being obtained from the connection. * * @param target */ getRepository(target: EntityTarget): Repository; /** * Gets tree repository for the given entity class or name. * If single database connection mode is used, then repository is obtained from the * repository aggregator, where each repository is individually created for this entity manager. * When single database connection is not used, repository is being obtained from the connection. * * @param target */ getTreeRepository(target: EntityTarget): TreeRepository; /** * Gets mongodb repository for the given entity class. * * @param target */ getMongoRepository(target: EntityTarget): MongoRepository; /** * Creates a new repository instance out of a given Repository and * sets current EntityManager instance to it. Used to work with custom repositories * in transactions. * * @param repository */ withRepository>(repository: R & Repository): R; /** * Releases all resources used by entity manager. * This is used when entity manager is created with a single query runner, * and this single query runner needs to be released after job with entity manager is done. */ release(): Promise; }