UNPKG

lakutata

Version:

An IoC-based universal application framework.

669 lines (664 loc) 36.8 kB
import { EntityTarget, ObjectLiteral, DeepPartial, PickKeysByType, ObjectType } from './TypeDef.internal.36.js'; import { MongoQueryRunner, FilterOperators, ObjectId, FindCursor, Document, AggregateOptions, AggregationCursor, AnyBulkWriteOperation, BulkWriteOptions, BulkWriteResult, Filter, CountOptions, CountDocumentsOptions, IndexSpecification, CreateIndexesOptions, IndexDescription, DeleteOptions, DeleteResult as DeleteResult$1, CommandOperationOptions, FindOneAndDeleteOptions, FindOneAndReplaceOptions, UpdateFilter, FindOneAndUpdateOptions, IndexInformationOptions, OrderedBulkOperation, UnorderedBulkOperation, OptionalId, InsertManyResult, InsertOneOptions, InsertOneResult, ListIndexesOptions, ListIndexesCursor, RenameOptions, Collection, ReplaceOptions, UpdateResult as UpdateResult$1, CollStatsOptions, CollStats, ChangeStreamOptions, ChangeStream, UpdateOptions } from './TypeDef.internal.55.js'; import { FindManyOptions, FindOptionsSelect, FindOptionsSelectByString, FindOptionsWhere, FindOneOptions } from './TypeDef.internal.74.js'; import { QueryDeepPartialEntity, SelectQueryBuilder } from './TypeDef.internal.38.js'; import { InsertResult, UpdateResult, DeleteResult } from './TypeDef.internal.81.js'; import { EntityMetadata, ColumnMetadata } from './TypeDef.internal.47.js'; import { DataSource } from './TypeDef.internal.33.js'; import { MongoFindManyOptions, MongoFindOneOptions } from './TypeDef.internal.82.js'; import { QueryRunner } from './TypeDef.internal.40.js'; import { Repository, TreeRepository, SaveOptions, RemoveOptions, UpsertOptions, MongoRepository } from './TypeDef.internal.37.js'; import { PlainObjectToNewEntityTransformer } from './TypeDef.internal.83.js'; import { IsolationLevel } from './TypeDef.internal.44.js'; /** * Entity manager supposed to work with any entity, automatically find its repository and call its methods, * whatever entity type are you passing. * * This implementation is used for MongoDB driver which has some specifics in its EntityManager. */ declare class MongoEntityManager extends EntityManager { readonly "@instanceof": symbol; get mongoQueryRunner(): MongoQueryRunner; constructor(connection: DataSource); /** * Finds entities that match given find options. */ /** * Finds entities that match given find options or conditions. */ find<Entity>(entityClassOrName: EntityTarget<Entity>, optionsOrConditions?: FindManyOptions<Entity> | Partial<Entity> | FilterOperators<Entity>): Promise<Entity[]>; /** * Finds entities that match given find options or conditions. * Also counts all entities that match given conditions, * but ignores pagination settings (from and take options). */ findAndCount<Entity>(entityClassOrName: EntityTarget<Entity>, options?: MongoFindManyOptions<Entity>): Promise<[Entity[], number]>; /** * Finds entities that match given where conditions. */ findAndCountBy<Entity>(entityClassOrName: EntityTarget<Entity>, where: any): Promise<[Entity[], number]>; /** * Finds entities by ids. * Optionally find options can be applied. * * @deprecated use `findBy` method instead. */ findByIds<Entity>(entityClassOrName: EntityTarget<Entity>, ids: any[], optionsOrConditions?: FindManyOptions<Entity> | Partial<Entity>): Promise<Entity[]>; /** * Finds first entity that matches given conditions and/or find options. */ findOne<Entity>(entityClassOrName: EntityTarget<Entity>, options: MongoFindOneOptions<Entity>): Promise<Entity | null>; /** * Finds first entity that matches given WHERE conditions. */ findOneBy<Entity>(entityClassOrName: EntityTarget<Entity>, where: any): Promise<Entity | null>; /** * Finds entity that matches given id. * * @deprecated use `findOneBy` method instead in conjunction with `In` operator, for example: * * .findOneBy({ * id: 1 // where "id" is your primary column name * }) */ findOneById<Entity>(entityClassOrName: EntityTarget<Entity>, id: string | number | Date | ObjectId): Promise<Entity | null>; /** * 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<Entity>(target: EntityTarget<Entity>, entity: QueryDeepPartialEntity<Entity> | QueryDeepPartialEntity<Entity>[]): 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. */ update<Entity>(target: EntityTarget<Entity>, criteria: string | string[] | number | number[] | Date | Date[] | ObjectId | ObjectId[] | ObjectLiteral, partialEntity: QueryDeepPartialEntity<Entity>): Promise<UpdateResult>; /** * Deletes entities by a given conditions. * 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. */ delete<Entity>(target: EntityTarget<Entity>, criteria: string | string[] | number | number[] | Date | Date[] | ObjectId | ObjectId[] | ObjectLiteral[]): Promise<DeleteResult>; /** * Creates a cursor for a query that can be used to iterate over results from MongoDB. */ createCursor<Entity, T = any>(entityClassOrName: EntityTarget<Entity>, query?: ObjectLiteral): FindCursor<T>; /** * Creates a cursor for a query that can be used to iterate over results from MongoDB. * This returns modified version of cursor that transforms each result into Entity model. */ createEntityCursor<Entity>(entityClassOrName: EntityTarget<Entity>, query?: ObjectLiteral): FindCursor<Entity>; /** * Execute an aggregation framework pipeline against the collection. */ aggregate<Entity, R = any>(entityClassOrName: EntityTarget<Entity>, pipeline: Document[], options?: AggregateOptions): AggregationCursor<R>; /** * Execute an aggregation framework pipeline against the collection. * This returns modified version of cursor that transforms each result into Entity model. */ aggregateEntity<Entity>(entityClassOrName: EntityTarget<Entity>, pipeline: Document[], options?: AggregateOptions): AggregationCursor<Entity>; /** * Perform a bulkWrite operation without a fluent API. */ bulkWrite<Entity>(entityClassOrName: EntityTarget<Entity>, operations: AnyBulkWriteOperation<Document>[], options?: BulkWriteOptions): Promise<BulkWriteResult>; /** * Count number of matching documents in the db to a query. */ count<Entity>(entityClassOrName: EntityTarget<Entity>, query?: Filter<Document>, options?: CountOptions): Promise<number>; /** * Count number of matching documents in the db to a query. */ countDocuments<Entity>(entityClassOrName: EntityTarget<Entity>, query?: Filter<Document>, options?: CountDocumentsOptions): Promise<number>; /** * Count number of matching documents in the db to a query. */ countBy<Entity>(entityClassOrName: EntityTarget<Entity>, query?: ObjectLiteral, options?: CountOptions): Promise<number>; /** * Creates an index on the db and collection. */ createCollectionIndex<Entity>(entityClassOrName: EntityTarget<Entity>, fieldOrSpec: IndexSpecification, options?: CreateIndexesOptions): Promise<string>; /** * Creates multiple indexes in the collection, this method is only supported for MongoDB 2.6 or higher. * Earlier version of MongoDB will throw a command not supported error. * Index specifications are defined at http://docs.mongodb.org/manual/reference/command/createIndexes/. */ createCollectionIndexes<Entity>(entityClassOrName: EntityTarget<Entity>, indexSpecs: IndexDescription[]): Promise<string[]>; /** * Delete multiple documents on MongoDB. */ deleteMany<Entity>(entityClassOrName: EntityTarget<Entity>, query: Filter<Document>, options?: DeleteOptions): Promise<DeleteResult$1>; /** * Delete a document on MongoDB. */ deleteOne<Entity>(entityClassOrName: EntityTarget<Entity>, query: Filter<Document>, options?: DeleteOptions): Promise<DeleteResult$1>; /** * The distinct command returns returns a list of distinct values for the given key across a collection. */ distinct<Entity>(entityClassOrName: EntityTarget<Entity>, key: string, query: Filter<Document>, options?: CommandOperationOptions): Promise<any>; /** * Drops an index from this collection. */ dropCollectionIndex<Entity>(entityClassOrName: EntityTarget<Entity>, indexName: string, options?: CommandOperationOptions): Promise<any>; /** * Drops all indexes from the collection. */ dropCollectionIndexes<Entity>(entityClassOrName: EntityTarget<Entity>): Promise<any>; /** * Find a document and delete it in one atomic operation, requires a write lock for the duration of the operation. */ findOneAndDelete<Entity>(entityClassOrName: EntityTarget<Entity>, query: ObjectLiteral, options?: FindOneAndDeleteOptions): Promise<Document | null>; /** * Find a document and replace it in one atomic operation, requires a write lock for the duration of the operation. */ findOneAndReplace<Entity>(entityClassOrName: EntityTarget<Entity>, query: Filter<Document>, replacement: Document, options?: FindOneAndReplaceOptions): Promise<Document | null>; /** * Find a document and update it in one atomic operation, requires a write lock for the duration of the operation. */ findOneAndUpdate<Entity>(entityClassOrName: EntityTarget<Entity>, query: Filter<Document>, update: UpdateFilter<Document>, options?: FindOneAndUpdateOptions): Promise<Document | null>; /** * Retrieve all the indexes on the collection. */ collectionIndexes<Entity>(entityClassOrName: EntityTarget<Entity>): Promise<Document>; /** * Retrieve all the indexes on the collection. */ collectionIndexExists<Entity>(entityClassOrName: EntityTarget<Entity>, indexes: string | string[]): Promise<boolean>; /** * Retrieves this collections index info. */ collectionIndexInformation<Entity>(entityClassOrName: EntityTarget<Entity>, options?: IndexInformationOptions): Promise<any>; /** * Initiate an In order bulk write operation, operations will be serially executed in the order they are added, creating a new operation for each switch in types. */ initializeOrderedBulkOp<Entity>(entityClassOrName: EntityTarget<Entity>, options?: BulkWriteOptions): OrderedBulkOperation; /** * Initiate a Out of order batch write operation. All operations will be buffered into insert/update/remove commands executed out of order. */ initializeUnorderedBulkOp<Entity>(entityClassOrName: EntityTarget<Entity>, options?: BulkWriteOptions): UnorderedBulkOperation; /** * Inserts an array of documents into MongoDB. */ insertMany<Entity>(entityClassOrName: EntityTarget<Entity>, docs: OptionalId<Document>[], options?: BulkWriteOptions): Promise<InsertManyResult>; /** * Inserts a single document into MongoDB. */ insertOne<Entity>(entityClassOrName: EntityTarget<Entity>, doc: OptionalId<Document>, options?: InsertOneOptions): Promise<InsertOneResult>; /** * Returns if the collection is a capped collection. */ isCapped<Entity>(entityClassOrName: EntityTarget<Entity>): Promise<any>; /** * Get the list of all indexes information for the collection. */ listCollectionIndexes<Entity>(entityClassOrName: EntityTarget<Entity>, options?: ListIndexesOptions): ListIndexesCursor; /** * Reindex all indexes on the collection Warning: reIndex is a blocking operation (indexes are rebuilt in the foreground) and will be slow for large collections. */ rename<Entity>(entityClassOrName: EntityTarget<Entity>, newName: string, options?: RenameOptions): Promise<Collection<Document>>; /** * Replace a document on MongoDB. */ replaceOne<Entity>(entityClassOrName: EntityTarget<Entity>, query: Filter<Document>, doc: Document, options?: ReplaceOptions): Promise<Document | UpdateResult$1>; /** * Get all the collection statistics. */ stats<Entity>(entityClassOrName: EntityTarget<Entity>, options?: CollStatsOptions): Promise<CollStats>; watch<Entity>(entityClassOrName: EntityTarget<Entity>, pipeline?: Document[], options?: ChangeStreamOptions): ChangeStream; /** * Update multiple documents on MongoDB. */ updateMany<Entity>(entityClassOrName: EntityTarget<Entity>, query: Filter<Document>, update: UpdateFilter<Document>, options?: UpdateOptions): Promise<Document | UpdateResult$1>; /** * Update a single document on MongoDB. */ updateOne<Entity>(entityClassOrName: EntityTarget<Entity>, query: Filter<Document>, update: UpdateFilter<Document>, options?: UpdateOptions): Promise<Document | UpdateResult$1>; /** * Converts FindManyOptions to mongodb query. */ protected convertFindManyOptionsOrConditionsToMongodbQuery<Entity>(optionsOrConditions: MongoFindManyOptions<Entity> | Partial<Entity> | FilterOperators<Entity> | any[] | undefined): ObjectLiteral | undefined; /** * Converts FindOneOptions to mongodb query. */ protected convertFindOneOptionsOrConditionsToMongodbQuery<Entity>(optionsOrConditions: MongoFindOneOptions<Entity> | Partial<Entity> | undefined): ObjectLiteral | undefined; /** * Converts FindOptions into mongodb order by criteria. */ protected convertFindOptionsOrderToOrderCriteria(order: ObjectLiteral): ObjectLiteral; /** * Converts FindOptions into mongodb select by criteria. */ protected convertFindOptionsSelectToProjectCriteria(selects: FindOptionsSelect<any> | FindOptionsSelectByString<any>): any; /** * Ensures given id is an id for query. */ protected convertMixedCriteria(metadata: EntityMetadata, idMap: any): ObjectLiteral; /** * Overrides cursor's toArray and next methods to convert results to entity automatically. */ protected applyEntityTransformationToCursor<Entity extends ObjectLiteral>(metadata: EntityMetadata, cursor: FindCursor<Entity> | AggregationCursor<Entity>): void; protected filterSoftDeleted<Entity>(cursor: FindCursor<Entity>, deleteDateColumn: ColumnMetadata, query?: ObjectLiteral): void; /** * Finds first entity that matches given conditions and/or find options. */ protected executeFindOne<Entity>(entityClassOrName: EntityTarget<Entity>, optionsOrConditions?: any, maybeOptions?: MongoFindOneOptions<Entity>): Promise<Entity | null>; protected executeFind<Entity>(entityClassOrName: EntityTarget<Entity>, optionsOrConditions?: MongoFindManyOptions<Entity> | Partial<Entity> | any[]): Promise<Entity[]>; /** * Finds entities that match given find options or conditions. */ executeFindAndCount<Entity>(entityClassOrName: EntityTarget<Entity>, optionsOrConditions?: MongoFindManyOptions<Entity> | Partial<Entity>): Promise<[Entity[], number]>; } /** * Entity manager supposed to work with any entity, automatically find its repository and call its methods, * whatever entity type are you passing. */ declare class EntityManager { readonly "@instanceof": symbol; /** * Connection used by this entity manager. */ readonly connection: DataSource; /** * 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 repositories. * Created as a future replacement for the #repositories to provide a bit more perf optimization. */ protected repositories: Map<EntityTarget<any>, Repository<any>>; /** * Once created and then reused by repositories. */ protected treeRepositories: TreeRepository<any>[]; /** * Plain to object transformer used in create and merge operations. */ protected plainObjectToEntityTransformer: PlainObjectToNewEntityTransformer; constructor(connection: DataSource, 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<T>(runInTransaction: (entityManager: EntityManager) => Promise<T>): Promise<T>; /** * Wraps given function execution (and all operations made there) in a transaction. * All database operations must be executed using provided entity manager. */ transaction<T>(isolationLevel: IsolationLevel, runInTransaction: (entityManager: EntityManager) => Promise<T>): Promise<T>; /** * Executes raw SQL query and returns raw database results. * * @see [Official docs](https://typeorm.io/entity-manager-api) for examples. */ query<T = any>(query: string, parameters?: any[]): Promise<T>; /** * Tagged template function that executes raw SQL query and returns raw database results. * Template expressions are automatically transformed into database parameters. * Raw query execution is supported only by relational databases (MongoDB is not supported). * Note: Don't call this as a regular function, it is meant to be used with backticks to tag a template literal. * Example: entityManager.sql`SELECT * FROM table_name WHERE id = ${id}` */ sql<T = any>(strings: TemplateStringsArray, ...values: unknown[]): Promise<T>; /** * Creates a new query builder that can be used to build a SQL query. */ createQueryBuilder<Entity extends ObjectLiteral>(entityClass: EntityTarget<Entity>, alias: string, queryRunner?: QueryRunner): SelectQueryBuilder<Entity>; /** * Creates a new query builder that can be used to build a SQL query. */ createQueryBuilder(queryRunner?: QueryRunner): SelectQueryBuilder<any>; /** * 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: EntityTarget<any>, entity: any): any; /** * 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<Entity, EntityLike extends DeepPartial<Entity>>(entityClass: EntityTarget<Entity>, plainObject?: EntityLike): 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<Entity, EntityLike extends DeepPartial<Entity>>(entityClass: EntityTarget<Entity>, plainObjects?: EntityLike[]): Entity[]; /** * Merges two entities into one new entity. */ merge<Entity extends ObjectLiteral>(entityClass: EntityTarget<Entity>, mergeIntoEntity: Entity, ...entityLikes: DeepPartial<Entity>[]): Entity; /** * 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. */ preload<Entity extends ObjectLiteral>(entityClass: EntityTarget<Entity>, entityLike: DeepPartial<Entity>): Promise<Entity | undefined>; /** * Saves all given entities in the database. * If entities do not exist in the database then inserts, otherwise updates. */ save<Entity>(entities: Entity[], options?: SaveOptions): Promise<Entity[]>; /** * Saves all given entities in the database. * If entities do not exist in the database then inserts, otherwise updates. */ save<Entity>(entity: Entity, options?: SaveOptions): Promise<Entity>; /** * Saves all given entities in the database. * If entities do not exist in the database then inserts, otherwise updates. */ save<Entity, T extends DeepPartial<Entity>>(targetOrEntity: EntityTarget<Entity>, entities: T[], options: SaveOptions & { reload: false; }): Promise<T[]>; /** * Saves all given entities in the database. * If entities do not exist in the database then inserts, otherwise updates. */ save<Entity, T extends DeepPartial<Entity>>(targetOrEntity: EntityTarget<Entity>, entities: T[], options?: SaveOptions): Promise<(T & Entity)[]>; /** * Saves a given entity in the database. * If entity does not exist in the database then inserts, otherwise updates. */ save<Entity, T extends DeepPartial<Entity>>(targetOrEntity: EntityTarget<Entity>, entity: T, options: SaveOptions & { reload: false; }): Promise<T>; /** * Saves a given entity in the database. * If entity does not exist in the database then inserts, otherwise updates. */ save<Entity, T extends DeepPartial<Entity>>(targetOrEntity: EntityTarget<Entity>, entity: T, options?: SaveOptions): Promise<T & Entity>; /** * Removes a given entity from the database. */ remove<Entity>(entity: Entity, options?: RemoveOptions): Promise<Entity>; /** * Removes a given entity from the database. */ remove<Entity>(targetOrEntity: EntityTarget<Entity>, entity: Entity, options?: RemoveOptions): Promise<Entity>; /** * Removes a given entity from the database. */ remove<Entity>(entity: Entity[], options?: RemoveOptions): Promise<Entity>; /** * Removes a given entity from the database. */ remove<Entity>(targetOrEntity: EntityTarget<Entity>, entity: Entity[], options?: RemoveOptions): Promise<Entity[]>; /** * Records the delete date of all given entities. */ softRemove<Entity>(entities: Entity[], options?: SaveOptions): Promise<Entity[]>; /** * Records the delete date of a given entity. */ softRemove<Entity>(entity: Entity, options?: SaveOptions): Promise<Entity>; /** * Records the delete date of all given entities. */ softRemove<Entity, T extends DeepPartial<Entity>>(targetOrEntity: EntityTarget<Entity>, entities: T[], options?: SaveOptions): Promise<T[]>; /** * Records the delete date of a given entity. */ softRemove<Entity, T extends DeepPartial<Entity>>(targetOrEntity: EntityTarget<Entity>, entity: T, options?: SaveOptions): Promise<T>; /** * Recovers all given entities. */ recover<Entity>(entities: Entity[], options?: SaveOptions): Promise<Entity[]>; /** * Recovers a given entity. */ recover<Entity>(entity: Entity, options?: SaveOptions): Promise<Entity>; /** * Recovers all given entities. */ recover<Entity, T extends DeepPartial<Entity>>(targetOrEntity: EntityTarget<Entity>, entities: T[], options?: SaveOptions): Promise<T[]>; /** * Recovers a given entity. */ recover<Entity, T extends DeepPartial<Entity>>(targetOrEntity: EntityTarget<Entity>, entity: T, options?: SaveOptions): 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. * You can execute bulk inserts using this method. */ insert<Entity extends ObjectLiteral>(target: EntityTarget<Entity>, entity: QueryDeepPartialEntity<Entity> | QueryDeepPartialEntity<Entity>[]): Promise<InsertResult>; upsert<Entity extends ObjectLiteral>(target: EntityTarget<Entity>, entityOrEntities: QueryDeepPartialEntity<Entity> | QueryDeepPartialEntity<Entity>[], conflictPathsOrOptions: string[] | UpsertOptions<Entity>): Promise<InsertResult>; /** * 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<Entity extends ObjectLiteral>(target: EntityTarget<Entity>, criteria: string | string[] | number | number[] | Date | Date[] | ObjectId | ObjectId[] | any, partialEntity: QueryDeepPartialEntity<Entity>): Promise<UpdateResult>; /** * Updates all entities of target type, setting fields from supplied partial entity. * This is a primitive operation without cascades, relations or other operations included. * Executes fast and efficient UPDATE query without WHERE clause. * * WARNING! This method updates ALL rows in the target table. */ updateAll<Entity extends ObjectLiteral>(target: EntityTarget<Entity>, partialEntity: QueryDeepPartialEntity<Entity>): Promise<UpdateResult>; /** * 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<Entity extends ObjectLiteral>(targetOrEntity: EntityTarget<Entity>, criteria: string | string[] | number | number[] | Date | Date[] | ObjectId | ObjectId[] | any): Promise<DeleteResult>; /** * Deletes all entities of target type. * This is a primitive operation without cascades, relations or other operations included. * Executes fast and efficient DELETE query without WHERE clause. * * WARNING! This method deletes ALL rows in the target table. */ deleteAll<Entity extends ObjectLiteral>(targetOrEntity: EntityTarget<Entity>): Promise<DeleteResult>; /** * Records the delete date of entities 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. */ softDelete<Entity extends ObjectLiteral>(targetOrEntity: EntityTarget<Entity>, criteria: string | string[] | number | number[] | Date | Date[] | ObjectId | ObjectId[] | any): Promise<UpdateResult>; /** * Restores 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. */ restore<Entity extends ObjectLiteral>(targetOrEntity: EntityTarget<Entity>, criteria: string | string[] | number | number[] | Date | Date[] | ObjectId | ObjectId[] | any): Promise<UpdateResult>; /** * Checks whether any entity exists with the given options. */ exists<Entity extends ObjectLiteral>(entityClass: EntityTarget<Entity>, options?: FindManyOptions<Entity>): Promise<boolean>; /** * Checks whether any entity exists with the given conditions. */ existsBy<Entity extends ObjectLiteral>(entityClass: EntityTarget<Entity>, where: FindOptionsWhere<Entity> | FindOptionsWhere<Entity>[]): Promise<boolean>; /** * Counts entities that match given options. * Useful for pagination. */ count<Entity extends ObjectLiteral>(entityClass: EntityTarget<Entity>, options?: FindManyOptions<Entity>): Promise<number>; /** * Counts entities that match given conditions. * Useful for pagination. */ countBy<Entity extends ObjectLiteral>(entityClass: EntityTarget<Entity>, where: FindOptionsWhere<Entity> | FindOptionsWhere<Entity>[]): Promise<number>; /** * Return the SUM of a column */ sum<Entity extends ObjectLiteral>(entityClass: EntityTarget<Entity>, columnName: PickKeysByType<Entity, number>, where?: FindOptionsWhere<Entity> | FindOptionsWhere<Entity>[]): Promise<number | null>; /** * Return the AVG of a column */ average<Entity extends ObjectLiteral>(entityClass: EntityTarget<Entity>, columnName: PickKeysByType<Entity, number>, where?: FindOptionsWhere<Entity> | FindOptionsWhere<Entity>[]): Promise<number | null>; /** * Return the MIN of a column */ minimum<Entity extends ObjectLiteral>(entityClass: EntityTarget<Entity>, columnName: PickKeysByType<Entity, number>, where?: FindOptionsWhere<Entity> | FindOptionsWhere<Entity>[]): Promise<number | null>; /** * Return the MAX of a column */ maximum<Entity extends ObjectLiteral>(entityClass: EntityTarget<Entity>, columnName: PickKeysByType<Entity, number>, where?: FindOptionsWhere<Entity> | FindOptionsWhere<Entity>[]): Promise<number | null>; private callAggregateFun; /** * Finds entities that match given find options. */ find<Entity extends ObjectLiteral>(entityClass: EntityTarget<Entity>, options?: FindManyOptions<Entity>): Promise<Entity[]>; /** * Finds entities that match given find options. */ findBy<Entity extends ObjectLiteral>(entityClass: EntityTarget<Entity>, where: FindOptionsWhere<Entity> | FindOptionsWhere<Entity>[]): Promise<Entity[]>; /** * Finds entities that match given find options. * Also counts all entities that match given conditions, * but ignores pagination settings (from and take options). */ findAndCount<Entity extends ObjectLiteral>(entityClass: EntityTarget<Entity>, options?: FindManyOptions<Entity>): Promise<[Entity[], number]>; /** * Finds entities that match given WHERE conditions. * Also counts all entities that match given conditions, * but ignores pagination settings (from and take options). */ findAndCountBy<Entity extends ObjectLiteral>(entityClass: EntityTarget<Entity>, where: FindOptionsWhere<Entity> | FindOptionsWhere<Entity>[]): Promise<[Entity[], number]>; /** * Finds entities with ids. * Optionally find options or conditions can be applied. * * @deprecated use `findBy` method instead in conjunction with `In` operator, for example: * * .findBy({ * id: In([1, 2, 3]) * }) */ findByIds<Entity extends ObjectLiteral>(entityClass: EntityTarget<Entity>, ids: any[]): Promise<Entity[]>; /** * Finds first entity by a given find options. * If entity was not found in the database - returns null. */ findOne<Entity extends ObjectLiteral>(entityClass: EntityTarget<Entity>, options: FindOneOptions<Entity>): Promise<Entity | null>; /** * Finds first entity that matches given where condition. * If entity was not found in the database - returns null. */ findOneBy<Entity extends ObjectLiteral>(entityClass: EntityTarget<Entity>, where: FindOptionsWhere<Entity> | FindOptionsWhere<Entity>[]): Promise<Entity | null>; /** * Finds first entity that matches given id. * If entity was not found in the database - returns null. * * @deprecated use `findOneBy` method instead in conjunction with `In` operator, for example: * * .findOneBy({ * id: 1 // where "id" is your primary column name * }) */ findOneById<Entity extends ObjectLiteral>(entityClass: EntityTarget<Entity>, id: number | string | Date | ObjectId): Promise<Entity | null>; /** * Finds first entity by a given find options. * If entity was not found in the database - rejects with error. */ findOneOrFail<Entity extends ObjectLiteral>(entityClass: EntityTarget<Entity>, options: FindOneOptions<Entity>): Promise<Entity>; /** * Finds first entity that matches given where condition. * If entity was not found in the database - rejects with error. */ findOneByOrFail<Entity extends ObjectLiteral>(entityClass: EntityTarget<Entity>, where: FindOptionsWhere<Entity> | FindOptionsWhere<Entity>[]): Promise<Entity>; /** * 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<Entity>(entityClass: EntityTarget<Entity>): Promise<void>; /** * Increments some column by provided value of the entities matched given conditions. */ increment<Entity extends ObjectLiteral>(entityClass: EntityTarget<Entity>, conditions: any, propertyPath: string, value: number | string): Promise<UpdateResult>; /** * Decrements some column by provided value of the entities matched given conditions. */ decrement<Entity extends ObjectLiteral>(entityClass: EntityTarget<Entity>, conditions: any, propertyPath: string, value: number | string): Promise<UpdateResult>; /** * 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<Entity extends ObjectLiteral>(target: EntityTarget<Entity>): Repository<Entity>; /** * 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<Entity extends ObjectLiteral>(target: EntityTarget<Entity>): TreeRepository<Entity>; /** * Gets mongodb repository for the given entity class. */ getMongoRepository<Entity extends ObjectLiteral>(target: EntityTarget<Entity>): MongoRepository<Entity>; /** * Creates a new repository instance out of a given Repository and * sets current EntityManager instance to it. Used to work with custom repositories * in transactions. */ withRepository<Entity extends ObjectLiteral, R extends Repository<any>>(repository: R & Repository<Entity>): R; /** * Gets custom entity repository marked with @EntityRepository decorator. * * @deprecated use Repository.extend to create custom repositories */ getCustomRepository<T>(customRepository: ObjectType<T>): 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<void>; } /** * A special EntityManager that includes import/export and load/save function * that are unique to Sql.js. */ declare class SqljsEntityManager extends EntityManager { readonly "@instanceof": symbol; private driver; constructor(connection: DataSource, queryRunner?: QueryRunner); /** * Loads either the definition from a file (Node.js) or localstorage (browser) * or uses the given definition to open a new database. */ loadDatabase(fileNameOrLocalStorageOrData: string | Uint8Array): Promise<void>; /** * Saves the current database to a file (Node.js) or localstorage (browser) * if fileNameOrLocalStorage is not set options.location is used. */ saveDatabase(fileNameOrLocalStorage?: string): Promise<void>; /** * Returns the current database definition. */ exportDatabase(): Uint8Array; } export { EntityManager, MongoEntityManager, SqljsEntityManager };