import { QueryRunner } from "../../query-runner/QueryRunner"; import { ObjectLiteral } from "../../common/ObjectLiteral"; import { ColumnSchema } from "../../schema-builder/schema/ColumnSchema"; import { TableSchema } from "../../schema-builder/schema/TableSchema"; import { ForeignKeySchema } from "../../schema-builder/schema/ForeignKeySchema"; import { IndexSchema } from "../../schema-builder/schema/IndexSchema"; import { AggregationCursor, BulkWriteOpResultObject, Code, Collection, CollectionAggregationOptions, CollectionBluckWriteOptions, CollectionInsertManyOptions, CollectionInsertOneOptions, CollectionOptions, CollStats, CommandCursor, Cursor, Db, DeleteWriteOpResultObject, FindAndModifyWriteOpResultObject, FindOneAndReplaceOption, GeoHaystackSearchOptions, GeoNearOptions, InsertOneWriteOpResult, InsertWriteOpResult, MapReduceOptions, MongoCountPreferences, MongodbIndexOptions, OrderedBulkOperation, ParallelCollectionScanOptions, ReadPreference, ReplaceOneOptions, UnorderedBulkOperation, UpdateWriteOpResult } from "./typings"; import { Connection } from "../../connection/Connection"; import { ReadStream } from "../../platform/PlatformTools"; import { MongoEntityManager } from "../../entity-manager/MongoEntityManager"; /** * Runs queries on a single MongoDB connection. */ export declare class MongoQueryRunner implements QueryRunner { /** * Connection used by this query runner. */ connection: Connection; /** * Isolated entity manager working only with current query runner. */ manager: MongoEntityManager; /** * Indicates if connection for this query runner is released. * Once its released, query runner cannot run queries anymore. * Always false for mongodb since mongodb has a single query executor instance. */ isReleased: boolean; /** * Indicates if transaction is active in this query executor. * Always false for mongodb since mongodb does not support transactions. */ isTransactionActive: boolean; /** * Stores temporarily user data. * Useful for sharing data with subscribers. */ data: {}; /** * Real database connection from a connection pool used to perform queries. */ databaseConnection: Db; constructor(connection: Connection, databaseConnection: Db); /** * Creates a cursor for a query that can be used to iterate over results from MongoDB. */ cursor(collectionName: string, query?: ObjectLiteral): Cursor; /** * Execute an aggregation framework pipeline against the collection. */ aggregate(collectionName: string, pipeline: ObjectLiteral[], options?: CollectionAggregationOptions): AggregationCursor; /** * Perform a bulkWrite operation without a fluent API. */ bulkWrite(collectionName: string, operations: ObjectLiteral[], options?: CollectionBluckWriteOptions): Promise; /** * Count number of matching documents in the db to a query. */ count(collectionName: string, query?: ObjectLiteral, options?: MongoCountPreferences): Promise; /** * Creates an index on the db and collection. */ createCollectionIndex(collectionName: string, 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(collectionName: string, indexSpecs: ObjectLiteral[]): Promise; /** * Delete multiple documents on MongoDB. */ deleteMany(collectionName: string, query: ObjectLiteral, options?: CollectionOptions): Promise; /** * Delete a document on MongoDB. */ deleteOne(collectionName: string, query: ObjectLiteral, options?: CollectionOptions): Promise; /** * The distinct command returns returns a list of distinct values for the given key across a collection. */ distinct(collectionName: string, key: string, query: ObjectLiteral, options?: { readPreference?: ReadPreference | string; }): Promise; /** * Drops an index from this collection. */ dropCollectionIndex(collectionName: string, indexName: string, options?: CollectionOptions): Promise; /** * Drops all indexes from the collection. */ dropCollectionIndexes(collectionName: string): Promise; /** * Find a document and delete it in one atomic operation, requires a write lock for the duration of the operation. */ findOneAndDelete(collectionName: string, 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(collectionName: string, 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(collectionName: string, query: ObjectLiteral, update: Object, options?: FindOneAndReplaceOption): Promise; /** * Execute a geo search using a geo haystack index on a collection. */ geoHaystackSearch(collectionName: string, x: number, y: number, options?: GeoHaystackSearchOptions): Promise; /** * Execute the geoNear command to search for items in the collection. */ geoNear(collectionName: string, x: number, y: number, options?: GeoNearOptions): Promise; /** * Run a group command across a collection. */ group(collectionName: string, 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(collectionName: string): Promise; /** * Retrieve all the indexes on the collection. */ collectionIndexExists(collectionName: string, indexes: string | string[]): Promise; /** * Retrieves this collections index info. */ collectionIndexInformation(collectionName: string, 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(collectionName: string, 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(collectionName: string, options?: CollectionOptions): UnorderedBulkOperation; /** * Inserts an array of documents into MongoDB. */ insertMany(collectionName: string, docs: ObjectLiteral[], options?: CollectionInsertManyOptions): Promise; /** * Inserts a single document into MongoDB. */ insertOne(collectionName: string, doc: ObjectLiteral, options?: CollectionInsertOneOptions): Promise; /** * Returns if the collection is a capped collection. */ isCapped(collectionName: string): Promise; /** * Get the list of all indexes information for the collection. */ listCollectionIndexes(collectionName: string, 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(collectionName: string, 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(collectionName: string, 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(collectionName: string): 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(collectionName: string, newName: string, options?: { dropTarget?: boolean; }): Promise; /** * Replace a document on MongoDB. */ replaceOne(collectionName: string, query: ObjectLiteral, doc: ObjectLiteral, options?: ReplaceOneOptions): Promise; /** * Get all the collection statistics. */ stats(collectionName: string, options?: { scale: number; }): Promise; /** * Update multiple documents on MongoDB. */ updateMany(collectionName: string, query: ObjectLiteral, update: ObjectLiteral, options?: { upsert?: boolean; w?: any; wtimeout?: number; j?: boolean; }): Promise; /** * Update a single document on MongoDB. */ updateOne(collectionName: string, query: ObjectLiteral, update: ObjectLiteral, options?: ReplaceOneOptions): Promise; /** * Removes all collections from the currently connected database. * Be careful with using this method and avoid using it in production or migrations * (because it can clear all your database). */ clearDatabase(): Promise; /** * For MongoDB database we don't create connection, because its single connection already created by a driver. */ connect(): Promise; /** * For MongoDB database we don't release connection, because its single connection. */ release(): Promise; /** * Starts transaction. */ startTransaction(): Promise; /** * Commits transaction. */ commitTransaction(): Promise; /** * Rollbacks transaction. */ rollbackTransaction(): Promise; /** * Executes a given SQL query. */ query(query: string, parameters?: any[]): Promise; /** * Returns raw data stream. */ stream(query: string, parameters?: any[], onEnd?: Function, onError?: Function): Promise; /** * Insert a new row with given values into the given table. * Returns value of inserted object id. */ insert(collectionName: string, keyValues: ObjectLiteral): Promise; /** * Updates rows that match given conditions in the given table. */ update(collectionName: string, valuesMap: ObjectLiteral, conditions: ObjectLiteral): Promise; /** * Deletes from the given table by a given conditions. */ delete(collectionName: string, conditions: ObjectLiteral | string, maybeParameters?: any[]): Promise; /** * Inserts rows into the closure table. */ insertIntoClosureTable(collectionName: string, newEntityId: any, parentId: any, hasLevel: boolean): Promise; /** * Loads given table's data from the database. */ loadTableSchema(collectionName: string): Promise; /** * Loads all tables (with given names) from the database and creates a TableSchema from them. */ loadTableSchemas(collectionNames: string[]): Promise; /** * Checks if table with the given name exist in the database. */ hasTable(collectionName: string): Promise; /** * Creates a schema if it's not created. */ createSchema(): Promise; /** * Creates a new table from the given table schema and column schemas inside it. */ createTable(table: TableSchema): Promise; /** * Drops the table. */ dropTable(tableName: string): Promise; /** * Checks if column with the given name exist in the given table. */ hasColumn(collectionName: string, columnName: string): Promise; /** * Creates a new column from the column schema in the table. */ addColumn(tableSchemaOrName: TableSchema | string, column: ColumnSchema): Promise; /** * Creates a new columns from the column schema in the table. */ addColumns(tableSchemaOrName: TableSchema | string, columns: ColumnSchema[]): Promise; /** * Renames column in the given table. */ renameColumn(tableSchemaOrName: TableSchema | string, oldColumnSchemaOrName: ColumnSchema | string, newColumnSchemaOrName: ColumnSchema | string): Promise; /** * Changes a column in the table. */ changeColumn(tableSchemaOrName: TableSchema | string, oldColumnSchemaOrName: ColumnSchema | string, newColumn: ColumnSchema): Promise; /** * Changes a column in the table. */ changeColumns(tableSchema: TableSchema, changedColumns: { newColumn: ColumnSchema; oldColumn: ColumnSchema; }[]): Promise; /** * Drops column in the table. */ dropColumn(table: TableSchema, column: ColumnSchema): Promise; /** * Drops the columns in the table. */ dropColumns(table: TableSchema, columns: ColumnSchema[]): Promise; /** * Updates table's primary keys. */ updatePrimaryKeys(tableSchema: TableSchema): Promise; /** * Creates a new foreign key. */ createForeignKey(tableSchemaOrName: TableSchema | string, foreignKey: ForeignKeySchema): Promise; /** * Creates a new foreign keys. */ createForeignKeys(tableSchemaOrName: TableSchema | string, foreignKeys: ForeignKeySchema[]): Promise; /** * Drops a foreign key from the table. */ dropForeignKey(tableSchemaOrName: TableSchema | string, foreignKey: ForeignKeySchema): Promise; /** * Drops a foreign keys from the table. */ dropForeignKeys(tableSchemaOrName: TableSchema | string, foreignKeys: ForeignKeySchema[]): Promise; /** * Creates a new index. */ createIndex(collectionName: string, index: IndexSchema): Promise; /** * Drops an index from the table. */ dropIndex(collectionName: string, indexName: string): Promise; /** * Drops collection. */ truncate(collectionName: string): Promise; /** * Enables special query runner mode in which sql queries won't be executed, * instead they will be memorized into a special variable inside query runner. * You can get memorized sql using getMemorySql() method. */ enableSqlMemory(): void; /** * Disables special query runner mode in which sql queries won't be executed * started by calling enableSqlMemory() method. * * Previously memorized sql will be flushed. */ disableSqlMemory(): void; /** * Gets sql stored in the memory. Parameters in the sql are already replaced. */ getMemorySql(): (string | { up: string; down: string; })[]; /** * Gets collection from the database with a given name. */ protected getCollection(collectionName: string): Collection; }