import { Repository } from "./Repository"; import { FindOptionsWhere } from "../find-options/FindOptionsWhere"; import { DeepPartial } from "../common/DeepPartial"; import { SaveOptions } from "./SaveOptions"; import { FindOneOptions } from "../find-options/FindOneOptions"; import { RemoveOptions } from "./RemoveOptions"; import { FindManyOptions } from "../find-options/FindManyOptions"; import { DataSource } from "../data-source"; import { SelectQueryBuilder } from "../query-builder/SelectQueryBuilder"; import { InsertResult } from "../query-builder/result/InsertResult"; import { UpdateResult } from "../query-builder/result/UpdateResult"; import { DeleteResult } from "../query-builder/result/DeleteResult"; import { ObjectID } from "../driver/mongodb/typings"; import { QueryDeepPartialEntity } from "../query-builder/QueryPartialEntity"; import { UpsertOptions } from "./UpsertOptions"; import { EntityTarget } from "../common/EntityTarget"; /** * Base abstract entity for all entities, used in ActiveRecord patterns. */ export declare class BaseEntity { /** * DataSource used in all static methods of the BaseEntity. */ private static dataSource; /** * Checks if entity has an id. * If entity composite compose ids, it will check them all. */ hasId(): boolean; /** * Saves current entity in the database. * If entity does not exist in the database then inserts, otherwise updates. */ save(options?: SaveOptions): Promise; /** * Removes current entity from the database. */ remove(options?: RemoveOptions): Promise; /** * Records the delete date of current entity. */ softRemove(options?: SaveOptions): Promise; /** * Recovers a given entity in the database. */ recover(options?: SaveOptions): Promise; /** * Reloads entity data from the database. */ reload(): Promise; /** * Sets DataSource to be used by entity. */ static useDataSource(dataSource: DataSource | null): void; /** * Gets current entity's Repository. */ static getRepository(this: { new (): T; } & typeof BaseEntity): Repository; /** * Returns object that is managed by this repository. * If this repository manages entity from schema, * then it returns a name of that schema instead. */ static get target(): EntityTarget; /** * Checks entity has an id. * If entity composite compose ids, it will check them all. */ static hasId(entity: BaseEntity): boolean; /** * Gets entity mixed id. */ static getId(this: { new (): T; } & typeof BaseEntity, entity: T): any; /** * Creates a new query builder that can be used to build a SQL query. */ static createQueryBuilder(this: { new (): T; } & typeof BaseEntity, alias?: string): SelectQueryBuilder; /** * Creates a new entity instance. */ static create(this: { new (): T; } & typeof BaseEntity): T; /** * 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. */ static create(this: { new (): T; } & typeof BaseEntity, entityLikeArray: DeepPartial[]): T[]; /** * 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. */ static create(this: { new (): T; } & typeof BaseEntity, entityLike: DeepPartial): T; /** * Merges multiple entities (or entity-like objects) into a given entity. */ static merge(this: { new (): T; } & typeof BaseEntity, mergeIntoEntity: T, ...entityLikes: DeepPartial[]): T; /** * 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. * * 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. */ static preload(this: { new (): T; } & typeof BaseEntity, entityLike: DeepPartial): Promise; /** * Saves all given entities in the database. * If entities do not exist in the database then inserts, otherwise updates. */ static save(this: { new (): T; } & typeof BaseEntity, entities: DeepPartial[], options?: SaveOptions): Promise; /** * Saves a given entity in the database. * If entity does not exist in the database then inserts, otherwise updates. */ static save(this: { new (): T; } & typeof BaseEntity, entity: DeepPartial, options?: SaveOptions): Promise; /** * Removes a given entities from the database. */ static remove(this: { new (): T; } & typeof BaseEntity, entities: T[], options?: RemoveOptions): Promise; /** * Removes a given entity from the database. */ static remove(this: { new (): T; } & typeof BaseEntity, entity: T, options?: RemoveOptions): Promise; /** * Records the delete date of all given entities. */ static softRemove(this: { new (): T; } & typeof BaseEntity, entities: T[], options?: SaveOptions): Promise; /** * Records the delete date of a given entity. */ static softRemove(this: { new (): T; } & typeof BaseEntity, 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. */ static insert(this: { new (): T; } & typeof BaseEntity, entity: QueryDeepPartialEntity | QueryDeepPartialEntity[]): Promise; /** * Updates entity partially. Entity can be found by a given conditions. * 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. */ static update(this: { new (): T; } & typeof BaseEntity, criteria: string | string[] | number | number[] | Date | Date[] | ObjectID | ObjectID[] | FindOptionsWhere, partialEntity: QueryDeepPartialEntity): Promise; /** * Inserts a given entity into the database, unless a unique constraint conflicts then updates the entity * Unlike save method executes a primitive operation without cascades, relations and other operations included. * Executes fast and efficient INSERT ... ON CONFLICT DO UPDATE/ON DUPLICATE KEY UPDATE query. */ static upsert(this: { new (): T; } & typeof BaseEntity, entityOrEntities: QueryDeepPartialEntity | QueryDeepPartialEntity[], conflictPathsOrOptions: string[] | UpsertOptions): Promise; /** * Deletes entities by a given criteria. * Unlike remove 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. */ static delete(this: { new (): T; } & typeof BaseEntity, criteria: string | string[] | number | number[] | Date | Date[] | ObjectID | ObjectID[] | FindOptionsWhere): Promise; /** * Counts entities that match given options. */ static count(this: { new (): T; } & typeof BaseEntity, options?: FindManyOptions): Promise; /** * Counts entities that match given WHERE conditions. */ static countBy(this: { new (): T; } & typeof BaseEntity, where: FindOptionsWhere): Promise; /** * Finds entities that match given options. */ static find(this: { new (): T; } & typeof BaseEntity, options?: FindManyOptions): Promise; /** * Finds entities that match given WHERE conditions. */ static findBy(this: { new (): T; } & typeof BaseEntity, where: 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). */ static findAndCount(this: { new (): T; } & typeof BaseEntity, options?: FindManyOptions): Promise<[T[], number]>; /** * Finds entities that match given WHERE conditions. * Also counts all entities that match given conditions, * but ignores pagination settings (from and take options). */ static findAndCountBy(this: { new (): T; } & typeof BaseEntity, where: FindOptionsWhere): Promise<[T[], number]>; /** * Finds entities by ids. * Optionally find options can be applied. * * @deprecated use `findBy` method instead in conjunction with `In` operator, for example: * * .findBy({ * id: In([1, 2, 3]) * }) */ static findByIds(this: { new (): T; } & typeof BaseEntity, ids: any[]): Promise; /** * Finds first entity that matches given conditions. */ static findOne(this: { new (): T; } & typeof BaseEntity, options: FindOneOptions): Promise; /** * Finds first entity that matches given conditions. */ static findOneBy(this: { new (): T; } & typeof BaseEntity, where: FindOptionsWhere): Promise; /** * Finds first entity that matches given options. * * @deprecated use `findOneBy` method instead in conjunction with `In` operator, for example: * * .findOneBy({ * id: 1 // where "id" is your primary column name * }) */ static findOneById(this: { new (): T; } & typeof BaseEntity, id: string | number | Date | ObjectID): Promise; /** * Finds first entity that matches given conditions. */ static findOneOrFail(this: { new (): T; } & typeof BaseEntity, options: FindOneOptions): Promise; /** * Finds first entity that matches given conditions. */ static findOneByOrFail(this: { new (): T; } & typeof BaseEntity, where: FindOptionsWhere): 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). */ static query(this: { new (): T; } & typeof BaseEntity, query: string, parameters?: any[]): Promise; /** * Clears all the data from the given table/collection (truncates/drops it). */ static clear(this: { new (): T; } & typeof BaseEntity): Promise; }