///
import { DeepPartial } from "../common/DeepPartial";
import { ObjectType } from "../common/ObjectType";
import { Connection } from "../connection/Connection";
import { ObjectID } from "../driver/mongodb/typings";
import { IsolationLevel } from "../driver/types/IsolationLevel";
import { FindExtraOptions, FindOptions, FindOptionsWhere } from "../find-options/FindOptions";
import { EntitySchema } from "../index";
import { QueryPartialEntity } from "../query-builder/QueryPartialEntity";
import { DeleteResult } from "../query-builder/result/DeleteResult";
import { InsertResult } from "../query-builder/result/InsertResult";
import { UpdateResult } from "../query-builder/result/UpdateResult";
import { SelectQueryBuilder } from "../query-builder/SelectQueryBuilder";
import { PlainObjectToNewEntityTransformer } from "../query-builder/transformer/PlainObjectToNewEntityTransformer";
import { QueryRunner } from "../query-runner/QueryRunner";
import { MongoRepository } from "../repository/MongoRepository";
import { RemoveOptions } from "../repository/RemoveOptions";
import { Repository } from "../repository/Repository";
import { SaveOptions } from "../repository/SaveOptions";
import { TreeRepository } from "../repository/TreeRepository";
import Observable = require("zen-observable");
/**
* 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 {
/**
* Connection used by this entity manager.
*/
readonly connection: Connection;
/**
* 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 en repositories.
*/
protected repositories: Repository[];
/**
* Plain to object transformer used in create and merge operations.
*/
protected plainObjectToEntityTransformer: PlainObjectToNewEntityTransformer;
constructor(connection: Connection, 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: (entityManger: EntityManager) => Promise): Promise;
transaction(isolationLevel: IsolationLevel, runInTransaction: (entityManger: EntityManager) => Promise): Promise;
/**
* Executes raw SQL query and returns raw database results.
*/
query(query: string, parameters?: any[]): Promise;
/**
* Creates a new query builder that can be used to build a sql query.
*/
createQueryBuilder(entityClass: ObjectType | EntitySchema | Function | string, 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: Function | string, entity: any): any;
/**
* Creates a new entity instance.
*/
create(entityClass: ObjectType): 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(entityClass: ObjectType | EntitySchema | string, plainObject: DeepPartial): 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: ObjectType | EntitySchema | string, plainObjects: DeepPartial[]): Entity[];
/**
* Merges two entities into one new entity.
*/
merge(entityClass: ObjectType | EntitySchema | string, 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.
*/
preload(entityClass: ObjectType | EntitySchema | string, 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: ObjectType | EntitySchema | string, entities: T[], options?: SaveOptions): Promise;
/**
* Saves all given entities in the database.
* If entities do not exist in the database then inserts, otherwise updates.
*/
save>(targetOrEntity: ObjectType | EntitySchema | string, 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: ObjectType | EntitySchema | string, 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: ObjectType | EntitySchema | string, entity: Entity[], options?: RemoveOptions): 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.
*/
insert(target: ObjectType | EntitySchema | string, entity: QueryPartialEntity | (QueryPartialEntity[]), options?: SaveOptions): 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.
*/
update(target: ObjectType | EntitySchema | string, criteria: string | string[] | number | number[] | Date | Date[] | ObjectID | ObjectID[] | FindOptionsWhere, partialEntity: DeepPartial, options?: SaveOptions): 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.
*/
delete(targetOrEntity: ObjectType | EntitySchema | string, criteria: string | string[] | number | number[] | Date | Date[] | ObjectID | ObjectID[] | FindOptionsWhere, options?: RemoveOptions): Promise;
/**
* Finds entities that match given options.
*/
find(entityClass: ObjectType | EntitySchema | string, options?: FindOptions): Promise;
/**
* Finds entities that match given conditions.
*/
find(entityClass: ObjectType | EntitySchema | string, conditions?: 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).
*/
findAndCount(entityClass: ObjectType | EntitySchema | string, options?: FindOptions): 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(entityClass: ObjectType | EntitySchema | string, conditions?: FindOptionsWhere): Promise<[Entity[], number]>;
/**
* Finds entities with ids.
* Optionally find options can be applied.
*/
findByIds(entityClass: ObjectType | EntitySchema | string, ids: any[], options?: FindOptions): Promise;
/**
* Finds entities with ids.
* Optionally conditions can be applied.
*/
findByIds(entityClass: ObjectType | EntitySchema | string, ids: any[], conditions?: FindOptionsWhere): Promise;
/**
* Finds first entity that matches given find options.
*/
findOne(entityClass: ObjectType | EntitySchema | string, id?: string | number | Date | ObjectID, options?: FindOptions): Promise;
/**
* Finds first entity that matches given find options.
*/
findOne(entityClass: ObjectType | EntitySchema | string, options?: FindOptions): Promise;
/**
* Finds first entity that matches given conditions.
*/
findOne(entityClass: ObjectType | EntitySchema | string, conditions?: FindOptionsWhere, options?: FindOptions): Promise;
/**
* Finds first entity that matches given find options or rejects the returned promise on error.
*/
findOneOrFail(entityClass: ObjectType | EntitySchema | string, id?: string | number | Date | ObjectID, options?: FindOptions): Promise;
/**
* Finds first entity that matches given find options or rejects the returned promise on error.
*/
findOneOrFail(entityClass: ObjectType | EntitySchema | string, options?: FindOptions): Promise;
/**
* Finds first entity that matches given conditions or rejects the returned promise on error.
*/
findOneOrFail(entityClass: ObjectType | EntitySchema | string, conditions?: FindOptionsWhere, options?: FindOptions): Promise;
/**
* Counts entities that match given conditions.
* Useful for pagination.
*/
count(entityClass: ObjectType | EntitySchema | string, conditions?: FindOptionsWhere, options?: FindExtraOptions): Promise;
/**
* Finds entities that match given options and returns observable.
* Whenever new data appears that matches given query observable emits new value.
*/
observe(entityClass: ObjectType | EntitySchema | string, options?: FindOptions): Observable;
/**
* Finds entities that match given conditions and returns observable.
* Whenever new data appears that matches given query observable emits new value.
*/
observe(entityClass: ObjectType | EntitySchema | string, conditions?: FindOptionsWhere): Observable;
/**
* Finds entities and count that match given options and returns observable.
* Whenever new data appears that matches given query observable emits new value.
*/
observeManyAndCount(entityClass: ObjectType | EntitySchema | string, options?: FindOptions): Observable<[Entity[], number]>;
/**
* Finds entities and count that match given conditions and returns observable.
* Whenever new data appears that matches given query observable emits new value.
*/
observeManyAndCount(entityClass: ObjectType | EntitySchema | string, conditions?: FindOptionsWhere): Observable<[Entity[], number]>;
/**
* Finds entity that match given options and returns observable.
* Whenever new data appears that matches given query observable emits new value.
*/
observeOne(entityClass: ObjectType | EntitySchema | string, options?: FindOptions): Observable;
/**
* Finds entity that match given conditions and returns observable.
* Whenever new data appears that matches given query observable emits new value.
*/
observeOne(entityClass: ObjectType | EntitySchema | string, conditions?: FindOptionsWhere): Observable;
/**
* Gets the entities count match given options and returns observable.
* Whenever new data appears that matches given query observable emits new value.
*/
observeCount(entityClass: ObjectType | EntitySchema | string, options?: FindOptions): Observable;
/**
* Gets the entities count match given options and returns observable.
* Whenever new data appears that matches given query observable emits new value.
*/
observeCount(entityClass: ObjectType | EntitySchema | string, conditions?: FindOptionsWhere): Observable;
/**
* 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.
* @see https://stackoverflow.com/a/5972738/925151
*/
clear(entityClass: ObjectType | EntitySchema | string): Promise;
/**
* Increments some column by provided value of the entities matched given conditions.
*/
increment(entityClass: ObjectType | EntitySchema | string, conditions: FindOptionsWhere, propertyPath: string, value: number): Promise;
/**
* Decrements some column by provided value of the entities matched given conditions.
*/
decrement(entityClass: ObjectType | EntitySchema | string, conditions: FindOptionsWhere, propertyPath: string, value: number): 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.
*/
getRepository(target: ObjectType | EntitySchema | string): 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.
*/
getTreeRepository(target: ObjectType | EntitySchema | string): TreeRepository;
/**
* Gets mongodb repository for the given entity class.
*/
getMongoRepository(target: ObjectType | EntitySchema | string): MongoRepository;
/**
* Gets custom entity repository marked with @EntityRepository decorator.
*/
getCustomRepository(customRepository: ObjectType): T;
/**
* 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;
}