import { Connection } from "../connection/Connection"; import { EntityManager } from "./EntityManager"; import { EntityTarget } from "../common/EntityTarget"; import { AggregationCursor, BulkWriteOpResultObject, ChangeStream, ChangeStreamOptions, Code, Collection, CollectionAggregationOptions, CollectionBulkWriteOptions, CollectionInsertManyOptions, CollectionInsertOneOptions, CollectionOptions, CollStats, CommandCursor, Cursor, DeleteWriteOpResultObject, FindAndModifyWriteOpResultObject, FindOneAndReplaceOption, GeoHaystackSearchOptions, GeoNearOptions, InsertOneWriteOpResult, InsertWriteOpResult, MapReduceOptions, MongoCountPreferences, MongodbIndexOptions, ObjectID, OrderedBulkOperation, ParallelCollectionScanOptions, ReadPreference, ReplaceOneOptions, UnorderedBulkOperation, UpdateWriteOpResult } from "../driver/mongodb/typings"; import { ObjectLiteral } from "../common/ObjectLiteral"; import { MongoQueryRunner } from "../driver/mongodb/MongoQueryRunner"; import { FindManyOptions } from "../find-options/FindManyOptions"; import { FindOneOptions } from "../find-options/FindOneOptions"; import { DeepPartial } from "../common/DeepPartial"; import { QueryDeepPartialEntity } from "../query-builder/QueryPartialEntity"; import { InsertResult } from "../query-builder/result/InsertResult"; import { UpdateResult } from "../query-builder/result/UpdateResult"; import { DeleteResult } from "../query-builder/result/DeleteResult"; import { EntityMetadata } from "../metadata/EntityMetadata"; import { FindConditions } from "../index"; /** * 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. */ export declare class MongoEntityManager extends EntityManager { get mongoQueryRunner(): MongoQueryRunner; constructor(connection: Connection); /** * Finds entities that match given find options or conditions. */ find(entityClassOrName: EntityTarget, optionsOrConditions?: FindManyOptions | Partial): Promise; /** * 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(entityClassOrName: EntityTarget, optionsOrConditions?: FindManyOptions | Partial): Promise<[Entity[], number]>; /** * Finds entities by ids. * Optionally find options can be applied. */ findByIds(entityClassOrName: EntityTarget, ids: any[], optionsOrConditions?: FindManyOptions | Partial): Promise; /** * Finds first entity that matches given conditions and/or find options. */ findOne(entityClassOrName: EntityTarget, optionsOrConditions?: string | string[] | number | number[] | Date | Date[] | ObjectID | ObjectID[] | FindOneOptions | DeepPartial, maybeOptions?: FindOneOptions): 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. * You can execute bulk inserts using this method. */ insert(target: EntityTarget, 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. */ update(target: EntityTarget, criteria: string | string[] | number | number[] | Date | Date[] | ObjectID | ObjectID[] | FindConditions, partialEntity: QueryDeepPartialEntity): Promise; /** * 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(target: EntityTarget, criteria: string | string[] | number | number[] | Date | Date[] | ObjectID | ObjectID[] | FindConditions): Promise; /** * Creates a cursor for a query that can be used to iterate over results from MongoDB. */ createCursor(entityClassOrName: EntityTarget, query?: ObjectLiteral): Cursor; /** * 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(entityClassOrName: EntityTarget, query?: ObjectLiteral): Cursor; /** * Execute an aggregation framework pipeline against the collection. */ aggregate(entityClassOrName: EntityTarget, pipeline: ObjectLiteral[], options?: CollectionAggregationOptions): AggregationCursor; /** * Execute an aggregation framework pipeline against the collection. * This returns modified version of cursor that transforms each result into Entity model. */ aggregateEntity(entityClassOrName: EntityTarget, pipeline: ObjectLiteral[], options?: CollectionAggregationOptions): AggregationCursor; /** * Perform a bulkWrite operation without a fluent API. */ bulkWrite(entityClassOrName: EntityTarget, operations: ObjectLiteral[], options?: CollectionBulkWriteOptions): Promise; /** * Count number of matching documents in the db to a query. */ count(entityClassOrName: EntityTarget, query?: ObjectLiteral, options?: MongoCountPreferences): Promise; /** * Creates an index on the db and collection. */ createCollectionIndex(entityClassOrName: EntityTarget, fieldOrSpec: string | any, options?: MongodbIndexOptions): Promise; /** * 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(entityClassOrName: EntityTarget, indexSpecs: ObjectLiteral[]): Promise; /** * Delete multiple documents on MongoDB. */ deleteMany(entityClassOrName: EntityTarget, query: ObjectLiteral, options?: CollectionOptions): Promise; /** * Delete a document on MongoDB. */ deleteOne(entityClassOrName: EntityTarget, query: ObjectLiteral, options?: CollectionOptions): Promise; /** * The distinct command returns returns a list of distinct values for the given key across a collection. */ distinct(entityClassOrName: EntityTarget, key: string, query: ObjectLiteral, options?: { readPreference?: ReadPreference | string; }): Promise; /** * Drops an index from this collection. */ dropCollectionIndex(entityClassOrName: EntityTarget, indexName: string, options?: CollectionOptions): Promise; /** * Drops all indexes from the collection. */ dropCollectionIndexes(entityClassOrName: EntityTarget): Promise; /** * Find a document and delete it in one atomic operation, requires a write lock for the duration of the operation. */ findOneAndDelete(entityClassOrName: EntityTarget, query: ObjectLiteral, options?: { projection?: Object; sort?: Object; maxTimeMS?: number; }): Promise; /** * Find a document and replace it in one atomic operation, requires a write lock for the duration of the operation. */ findOneAndReplace(entityClassOrName: EntityTarget, query: ObjectLiteral, replacement: Object, options?: FindOneAndReplaceOption): Promise; /** * Find a document and update it in one atomic operation, requires a write lock for the duration of the operation. */ findOneAndUpdate(entityClassOrName: EntityTarget, query: ObjectLiteral, update: Object, options?: FindOneAndReplaceOption): Promise; /** * Execute a geo search using a geo haystack index on a collection. */ geoHaystackSearch(entityClassOrName: EntityTarget, x: number, y: number, options?: GeoHaystackSearchOptions): Promise; /** * Execute the geoNear command to search for items in the collection. */ geoNear(entityClassOrName: EntityTarget, x: number, y: number, options?: GeoNearOptions): Promise; /** * Run a group command across a collection. */ group(entityClassOrName: EntityTarget, keys: Object | Array | Function | Code, condition: Object, initial: Object, reduce: Function | Code, finalize: Function | Code, command: boolean, options?: { readPreference?: ReadPreference | string; }): Promise; /** * Retrieve all the indexes on the collection. */ collectionIndexes(entityClassOrName: EntityTarget): Promise; /** * Retrieve all the indexes on the collection. */ collectionIndexExists(entityClassOrName: EntityTarget, indexes: string | string[]): Promise; /** * Retrieves this collections index info. */ collectionIndexInformation(entityClassOrName: EntityTarget, options?: { full: boolean; }): Promise; /** * 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(entityClassOrName: EntityTarget, options?: CollectionOptions): OrderedBulkOperation; /** * Initiate a Out of order batch write operation. All operations will be buffered into insert/update/remove commands executed out of order. */ initializeUnorderedBulkOp(entityClassOrName: EntityTarget, options?: CollectionOptions): UnorderedBulkOperation; /** * Inserts an array of documents into MongoDB. */ insertMany(entityClassOrName: EntityTarget, docs: ObjectLiteral[], options?: CollectionInsertManyOptions): Promise; /** * Inserts a single document into MongoDB. */ insertOne(entityClassOrName: EntityTarget, doc: ObjectLiteral, options?: CollectionInsertOneOptions): Promise; /** * Returns if the collection is a capped collection. */ isCapped(entityClassOrName: EntityTarget): Promise; /** * Get the list of all indexes information for the collection. */ listCollectionIndexes(entityClassOrName: EntityTarget, options?: { batchSize?: number; readPreference?: ReadPreference | string; }): CommandCursor; /** * Run Map Reduce across a collection. Be aware that the inline option for out will return an array of results not a collection. */ mapReduce(entityClassOrName: EntityTarget, map: Function | string, reduce: Function | string, options?: MapReduceOptions): Promise; /** * Return N number of parallel cursors for a collection allowing parallel reading of entire collection. * There are no ordering guarantees for returned results. */ parallelCollectionScan(entityClassOrName: EntityTarget, options?: ParallelCollectionScanOptions): Promise[]>; /** * 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. */ reIndex(entityClassOrName: EntityTarget): Promise; /** * 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(entityClassOrName: EntityTarget, newName: string, options?: { dropTarget?: boolean; }): Promise>; /** * Replace a document on MongoDB. */ replaceOne(entityClassOrName: EntityTarget, query: ObjectLiteral, doc: ObjectLiteral, options?: ReplaceOneOptions): Promise; /** * Get all the collection statistics. */ stats(entityClassOrName: EntityTarget, options?: { scale: number; }): Promise; watch(entityClassOrName: EntityTarget, pipeline?: Object[], options?: ChangeStreamOptions): ChangeStream; /** * Update multiple documents on MongoDB. */ updateMany(entityClassOrName: EntityTarget, query: ObjectLiteral, update: ObjectLiteral, options?: { upsert?: boolean; w?: any; wtimeout?: number; j?: boolean; }): Promise; /** * Update a single document on MongoDB. */ updateOne(entityClassOrName: EntityTarget, query: ObjectLiteral, update: ObjectLiteral, options?: ReplaceOneOptions): Promise; /** * Converts FindManyOptions to mongodb query. */ protected convertFindManyOptionsOrConditionsToMongodbQuery(optionsOrConditions: FindManyOptions | Partial | undefined): ObjectLiteral | undefined; /** * Converts FindOneOptions to mongodb query. */ protected convertFindOneOptionsOrConditionsToMongodbQuery(optionsOrConditions: FindOneOptions | Partial | 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: (keyof 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(metadata: EntityMetadata, cursor: Cursor | AggregationCursor): void; }