API 参考
    正在准备搜索索引...

    类 BaseEntity

    Base abstract entity for all entities, used in ActiveRecord patterns.

    索引

    构造函数

    constructor

    访问器

    target

    方法

    hasId recover reload remove save softRemove average clear count countBy create createQueryBuilder delete exists existsBy find findAndCount findAndCountBy findBy findByIds findOne findOneBy findOneById findOneByOrFail findOneOrFail getId getRepository hasId insert maximum merge minimum preload query remove save softRemove sum update upsert useDataSource

    构造函数

    访问器

    • get target(): EntityTarget<any>

      Returns object that is managed by this repository. If this repository manages entity from schema, then it returns a name of that schema instead.

      返回 EntityTarget<any>

    方法

    • Checks if entity has an id. If entity composite compose ids, it will check them all.

      返回 boolean

    • Recovers a given entity in the database.

      参数

      返回 Promise<BaseEntity>

    • Reloads entity data from the database.

      返回 Promise<void>

    • Removes current entity from the database.

      参数

      返回 Promise<BaseEntity>

    • Saves current entity in the database. If entity does not exist in the database then inserts, otherwise updates.

      参数

      返回 Promise<BaseEntity>

    • Records the delete date of current entity.

      参数

      返回 Promise<BaseEntity>

    • Return the AVG of a column

      类型参数

      参数

      返回 Promise<null | number>

    • Clears all the data from the given table/collection (truncates/drops it).

      类型参数

      参数

      返回 Promise<void>

    • Counts entities that match given options.

      类型参数

      参数

      返回 Promise<number>

    • Counts entities that match given WHERE conditions.

      类型参数

      参数

      返回 Promise<number>

    • Creates a new entity instance.

      类型参数

      参数

      返回 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.

      类型参数

      参数

      返回 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.

      类型参数

      参数

      返回 T

    • Creates a new query builder that can be used to build a SQL query.

      类型参数

      参数

      • this: new () => T & typeof BaseEntity
      • 可选alias: string

      返回 SelectQueryBuilder<T>

    • 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.

      类型参数

      参数

      返回 Promise<DeleteResult>

    • Checks whether any entity exists that matches the given options.

      类型参数

      参数

      返回 Promise<boolean>

    • Checks whether any entity exists that matches the given conditions.

      类型参数

      参数

      返回 Promise<boolean>

    • Finds entities that match given options.

      类型参数

      参数

      返回 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).

      类型参数

      参数

      返回 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).

      类型参数

      参数

      返回 Promise<[T[], number]>

    • Finds entities that match given WHERE conditions.

      类型参数

      参数

      返回 Promise<T[]>

    • Finds entities by ids. Optionally find options can be applied.

      类型参数

      参数

      返回 Promise<T[]>

      use findBy method instead in conjunction with In operator, for example:

      .findBy({ id: In([1, 2, 3]) })

    • Finds first entity that matches given conditions.

      类型参数

      参数

      返回 Promise<null | T>

    • Finds first entity that matches given conditions.

      类型参数

      参数

      返回 Promise<null | T>

    • Finds first entity that matches given options.

      类型参数

      参数

      返回 Promise<null | T>

      use findOneBy method instead in conjunction with In operator, for example:

      .findOneBy({ id: 1 // where "id" is your primary column name })

    • Finds first entity that matches given conditions.

      类型参数

      参数

      返回 Promise<T>

    • Finds first entity that matches given conditions.

      类型参数

      参数

      返回 Promise<T>

    • Gets entity mixed id.

      类型参数

      参数

      返回 any

    • Gets current entity's Repository.

      类型参数

      参数

      返回 Repository<T>

    • Checks entity has an id. If entity composite compose ids, it will check them all.

      参数

      返回 boolean

    • 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.

      类型参数

      参数

      返回 Promise<InsertResult>

    • Return the MAX of a column

      类型参数

      参数

      返回 Promise<null | number>

    • Merges multiple entities (or entity-like objects) into a given entity.

      类型参数

      参数

      返回 T

    • Return the MIN of a column

      类型参数

      参数

      返回 Promise<null | number>

    • 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.

      类型参数

      参数

      返回 Promise<undefined | 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).

      类型参数

      参数

      • this: new () => T & typeof BaseEntity
      • query: string
      • 可选parameters: any[]

      返回 Promise<any>

    • Removes a given entities from the database.

      类型参数

      参数

      返回 Promise<T[]>

    • Removes a given entity from the database.

      类型参数

      参数

      返回 Promise<T>

    • Saves all given entities in the database. If entities do not exist in the database then inserts, otherwise updates.

      类型参数

      参数

      返回 Promise<T[]>

    • Saves a given entity in the database. If entity does not exist in the database then inserts, otherwise updates.

      类型参数

      参数

      返回 Promise<T>

    • Records the delete date of all given entities.

      类型参数

      参数

      返回 Promise<T[]>

    • Records the delete date of a given entity.

      类型参数

      参数

      返回 Promise<T>

    • Return the SUM of a column

      类型参数

      参数

      返回 Promise<null | number>

    • 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.

      类型参数

      参数

      • this: new () => T & typeof BaseEntity
      • criteria:
            | string
            | number
            | string[]
            | Date
            | ObjectId
            | number[]
            | Date[]
            | ObjectId[]
            | FindOptionsWhere<T>
      • partialEntity: QueryDeepPartialEntity<T>

      返回 Promise<UpdateResult>

    • 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.

      类型参数

      参数

      • this: new () => T & typeof BaseEntity
      • entityOrEntities:
            | _QueryDeepPartialEntity<ObjectLiteral extends T ? unknown : T>
            | _QueryDeepPartialEntity<ObjectLiteral extends T ? unknown : T>[]
      • conflictPathsOrOptions: string[] | UpsertOptions<T>

      返回 Promise<InsertResult>

    • Sets DataSource to be used by entity.

      参数

      返回 void

    显示设置

    成员可见性

    目录

    构造函数
    访问器
    方法