import type { Repository } from "./Repository"; import type { FindOptionsWhere } from "../find-options/FindOptionsWhere"; import type { DeepPartial } from "../common/DeepPartial"; import type { SaveOptions } from "./SaveOptions"; import type { FindOneOptions } from "../find-options/FindOneOptions"; import type { RemoveOptions } from "./RemoveOptions"; import type { FindManyOptions } from "../find-options/FindManyOptions"; import type { DataSource } from "../data-source"; import type { SelectQueryBuilder } from "../query-builder/SelectQueryBuilder"; 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 { ObjectId } from "../driver/mongodb/typings"; import type { QueryDeepPartialEntity } from "../query-builder/QueryPartialEntity"; import type { UpsertOptions } from "./UpsertOptions"; import type { UpdateOptions } from "./UpdateOptions"; import type { EntityTarget } from "../common/EntityTarget"; import type { PickKeysByType } from "../common/PickKeysByType"; import type { ObjectLiteral } from "../common/ObjectLiteral"; /** * 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. * * @param options */ save(options?: SaveOptions): Promise; /** * Removes current entity from the database. * * @param options */ remove(options?: RemoveOptions): Promise; /** * Records the delete date of current entity. * * @param options */ softRemove(options?: SaveOptions): Promise; /** * Recovers a given entity in the database. * * @param options */ recover(options?: SaveOptions): Promise; /** * Reloads entity data from the database. */ reload(): Promise; /** * Sets DataSource to be used by entity. * * @param dataSource */ 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. * * @param entity */ static hasId(entity: BaseEntity): boolean; /** * Gets entity mixed id. * * @param entity */ static getId(this: { new (): T; } & typeof BaseEntity, entity: T): any; /** * Creates a new query builder that can be used to build a SQL query. * * @param alias */ 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. * * @param mergeIntoEntity * @param entityLikes */ 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. * * @param entityLike */ 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. * * @param entity */ 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. * * @param criteria * @param partialEntity * @param options */ static update(this: { new (): T; } & typeof BaseEntity, criteria: string | string[] | number | number[] | Date | Date[] | ObjectId | ObjectId[] | FindOptionsWhere, partialEntity: QueryDeepPartialEntity, options?: UpdateOptions): 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. * * @param entityOrEntities * @param conflictPathsOrOptions */ 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. * * @param criteria */ static delete(this: { new (): T; } & typeof BaseEntity, criteria: string | string[] | number | number[] | Date | Date[] | ObjectId | ObjectId[] | FindOptionsWhere): Promise; /** * Checks whether any entity exists that matches the given options. * * @param options */ static exists(this: { new (): T; } & typeof BaseEntity, options?: FindManyOptions): Promise; /** * Checks whether any entity exists that matches the given conditions. * * @param where */ static existsBy(this: { new (): T; } & typeof BaseEntity, where: FindOptionsWhere): Promise; /** * Counts entities that match given options. * * @param options */ static count(this: { new (): T; } & typeof BaseEntity, options?: FindManyOptions): Promise; /** * Counts entities that match given WHERE conditions. * * @param where */ static countBy(this: { new (): T; } & typeof BaseEntity, where: FindOptionsWhere): Promise; /** * Return the SUM of a column * * @param columnName * @param where */ static sum(this: { new (): T; } & typeof BaseEntity, columnName: PickKeysByType, where: FindOptionsWhere): Promise; /** * Return the AVG of a column * * @param columnName * @param where */ static average(this: { new (): T; } & typeof BaseEntity, columnName: PickKeysByType, where: FindOptionsWhere): Promise; /** * Return the MIN of a column * * @param columnName * @param where */ static minimum(this: { new (): T; } & typeof BaseEntity, columnName: PickKeysByType, where: FindOptionsWhere): Promise; /** * Return the MAX of a column * * @param columnName * @param where */ static maximum(this: { new (): T; } & typeof BaseEntity, columnName: PickKeysByType, where: FindOptionsWhere): Promise; /** * Finds entities that match given options. * * @param options */ static find(this: { new (): T; } & typeof BaseEntity, options?: FindManyOptions): Promise; /** * Finds entities that match given WHERE conditions. * * @param where */ 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). * * @param 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). * * @param where */ static findAndCountBy(this: { new (): T; } & typeof BaseEntity, where: FindOptionsWhere): Promise<[T[], number]>; /** * Finds first entity that matches given conditions. * * @param options */ static findOne(this: { new (): T; } & typeof BaseEntity, options: FindOneOptions): Promise; /** * Finds first entity that matches given conditions. * * @param where */ static findOneBy(this: { new (): T; } & typeof BaseEntity, where: FindOptionsWhere): Promise; /** * Finds first entity that matches given conditions. * * @param options */ static findOneOrFail(this: { new (): T; } & typeof BaseEntity, options: FindOneOptions): Promise; /** * Finds first entity that matches given conditions. * * @param where */ 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). * * @param query * @param parameters */ static query(this: { new (): T; } & typeof BaseEntity, query: string, parameters?: any[] | ObjectLiteral): Promise; /** * Clears all the data from the given table/collection (truncates/drops it). * * @param options * @param options.cascade */ static clear(this: { new (): T; } & typeof BaseEntity, options?: { cascade?: boolean; }): Promise; }