import { Repository } from "./Repository";
|
import { FindConditions } from "../index";
|
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 { Connection } from "../connection/Connection";
|
import { ObjectType } from "../common/ObjectType";
|
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";
|
/**
|
* Base abstract entity for all entities, used in ActiveRecord patterns.
|
*/
|
export declare class BaseEntity {
|
/**
|
* Connection used in all static methods of the BaseEntity.
|
*/
|
private static usedConnection?;
|
/**
|
* 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(): Promise<this>;
|
/**
|
* Removes current entity from the database.
|
*/
|
remove(): Promise<this>;
|
/**
|
* Reloads entity data from the database.
|
*/
|
reload(): Promise<void>;
|
/**
|
* Sets connection to be used by entity.
|
*/
|
static useConnection(connection: Connection): void;
|
/**
|
* Gets current entity's Repository.
|
*/
|
static getRepository<T extends BaseEntity>(this: ObjectType<T>): Repository<T>;
|
/**
|
* 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 readonly target: Function | string;
|
/**
|
* 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<T extends BaseEntity>(this: ObjectType<T>, entity: T): any;
|
/**
|
* Creates a new query builder that can be used to build a sql query.
|
*/
|
static createQueryBuilder<T extends BaseEntity>(this: ObjectType<T>, alias?: string): SelectQueryBuilder<T>;
|
/**
|
* Creates a new entity instance.
|
*/
|
static create<T extends BaseEntity>(this: ObjectType<T>): 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<T extends BaseEntity>(this: ObjectType<T>, entityLikeArray: DeepPartial<T>[]): 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<T extends BaseEntity>(this: ObjectType<T>, entityLike: DeepPartial<T>): T;
|
/**
|
* Merges multiple entities (or entity-like objects) into a given entity.
|
*/
|
static merge<T extends BaseEntity>(this: ObjectType<T>, mergeIntoEntity: T, ...entityLikes: DeepPartial<T>[]): T;
|
/**
|
* 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.
|
*/
|
static preload<T extends BaseEntity>(this: ObjectType<T>, entityLike: DeepPartial<T>): Promise<T | undefined>;
|
/**
|
* Saves all given entities in the database.
|
* If entities do not exist in the database then inserts, otherwise updates.
|
*/
|
static save<T extends BaseEntity>(this: ObjectType<T>, entities: T[], options?: SaveOptions): Promise<T[]>;
|
/**
|
* Saves a given entity in the database.
|
* If entity does not exist in the database then inserts, otherwise updates.
|
*/
|
static save<T extends BaseEntity>(this: ObjectType<T>, entity: T, options?: SaveOptions): Promise<T>;
|
/**
|
* Removes a given entities from the database.
|
*/
|
static remove<T extends BaseEntity>(this: ObjectType<T>, entities: T[], options?: RemoveOptions): Promise<T[]>;
|
/**
|
* Removes a given entity from the database.
|
*/
|
static remove<T extends BaseEntity>(this: ObjectType<T>, entity: T, options?: RemoveOptions): Promise<T>;
|
/**
|
* 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<T extends BaseEntity>(this: ObjectType<T>, entity: QueryDeepPartialEntity<T> | QueryDeepPartialEntity<T>[], options?: SaveOptions): Promise<InsertResult>;
|
/**
|
* 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<T extends BaseEntity>(this: ObjectType<T>, criteria: string | string[] | number | number[] | Date | Date[] | ObjectID | ObjectID[] | FindConditions<T>, partialEntity: QueryDeepPartialEntity<T>, options?: SaveOptions): Promise<UpdateResult>;
|
/**
|
* Deletes entities by a given criteria.
|
* 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.
|
*/
|
static delete<T extends BaseEntity>(this: ObjectType<T>, criteria: string | string[] | number | number[] | Date | Date[] | ObjectID | ObjectID[] | FindConditions<T>, options?: RemoveOptions): Promise<DeleteResult>;
|
/**
|
* Counts entities that match given options.
|
*/
|
static count<T extends BaseEntity>(this: ObjectType<T>, options?: FindManyOptions<T>): Promise<number>;
|
/**
|
* Counts entities that match given conditions.
|
*/
|
static count<T extends BaseEntity>(this: ObjectType<T>, conditions?: FindConditions<T>): Promise<number>;
|
/**
|
* Finds entities that match given options.
|
*/
|
static find<T extends BaseEntity>(this: ObjectType<T>, options?: FindManyOptions<T>): Promise<T[]>;
|
/**
|
* Finds entities that match given conditions.
|
*/
|
static find<T extends BaseEntity>(this: ObjectType<T>, conditions?: FindConditions<T>): Promise<T[]>;
|
/**
|
* 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<T extends BaseEntity>(this: ObjectType<T>, options?: FindManyOptions<T>): Promise<[T[], number]>;
|
/**
|
* Finds entities that match given conditions.
|
* Also counts all entities that match given conditions,
|
* but ignores pagination settings (from and take options).
|
*/
|
static findAndCount<T extends BaseEntity>(this: ObjectType<T>, conditions?: FindConditions<T>): Promise<[T[], number]>;
|
/**
|
* Finds entities by ids.
|
* Optionally find options can be applied.
|
*/
|
static findByIds<T extends BaseEntity>(this: ObjectType<T>, ids: any[], options?: FindManyOptions<T>): Promise<T[]>;
|
/**
|
* Finds entities by ids.
|
* Optionally conditions can be applied.
|
*/
|
static findByIds<T extends BaseEntity>(this: ObjectType<T>, ids: any[], conditions?: FindConditions<T>): Promise<T[]>;
|
/**
|
* Finds first entity that matches given options.
|
*/
|
static findOne<T extends BaseEntity>(this: ObjectType<T>, id?: string | number | Date | ObjectID, options?: FindOneOptions<T>): Promise<T | undefined>;
|
/**
|
* Finds first entity that matches given options.
|
*/
|
static findOne<T extends BaseEntity>(this: ObjectType<T>, options?: FindOneOptions<T>): Promise<T | undefined>;
|
/**
|
* Finds first entity that matches given conditions.
|
*/
|
static findOne<T extends BaseEntity>(this: ObjectType<T>, conditions?: FindConditions<T>, options?: FindOneOptions<T>): Promise<T | undefined>;
|
/**
|
* Finds first entity that matches given options.
|
*/
|
static findOneOrFail<T extends BaseEntity>(this: ObjectType<T>, id?: string | number | Date | ObjectID, options?: FindOneOptions<T>): Promise<T>;
|
/**
|
* Finds first entity that matches given options.
|
*/
|
static findOneOrFail<T extends BaseEntity>(this: ObjectType<T>, options?: FindOneOptions<T>): Promise<T>;
|
/**
|
* Finds first entity that matches given conditions.
|
*/
|
static findOneOrFail<T extends BaseEntity>(this: ObjectType<T>, conditions?: FindConditions<T>, options?: FindOneOptions<T>): Promise<T>;
|
/**
|
* 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<T extends BaseEntity>(this: ObjectType<T>, query: string, parameters?: any[]): Promise<any>;
|
/**
|
* Clears all the data from the given table/collection (truncates/drops it).
|
*/
|
static clear<T extends BaseEntity>(this: ObjectType<T>): Promise<void>;
|
}
|
