typeorm 1.0.0-beta.1 → 1.0.0-beta.2

package/browser/driver/mongodb/MongoQueryRunner.d.ts

@@ -24,6 +24,7 @@ export declare class MongoQueryRunner implements QueryRunner {
     dataSource: DataSource;
     /**
      * DataSource used by the driver.
+     *
      * @deprecated since 1.0.0. Use {@link dataSource} instance instead.
      */
     get connection(): DataSource;
@@ -66,12 +67,14 @@ export declare class MongoQueryRunner implements QueryRunner {
     afterMigration(): Promise<void>;
     /**
      * Creates a cursor for a query that can be used to iterate over results from MongoDB.
+     *
      * @param collectionName
      * @param filter
      */
     cursor(collectionName: string, filter: Filter<Document>): FindCursor<any>;
     /**
      * Execute an aggregation framework pipeline against the collection.
+     *
      * @param collectionName
      * @param pipeline
      * @param options
@@ -79,6 +82,7 @@ export declare class MongoQueryRunner implements QueryRunner {
     aggregate(collectionName: string, pipeline: Document[], options?: AggregateOptions): AggregationCursor<any>;
     /**
      * Perform a bulkWrite operation without a fluent API.
+     *
      * @param collectionName
      * @param operations
      * @param options
@@ -86,6 +90,7 @@ export declare class MongoQueryRunner implements QueryRunner {
     bulkWrite(collectionName: string, operations: AnyBulkWriteOperation<Document>[], options?: BulkWriteOptions): Promise<BulkWriteResult>;
     /**
      * Count number of matching documents in the db to a query.
+     *
      * @param collectionName
      * @param filter
      * @param options
@@ -93,6 +98,7 @@ export declare class MongoQueryRunner implements QueryRunner {
     count(collectionName: string, filter: Filter<Document>, options?: CountOptions): Promise<number>;
     /**
      * Count number of matching documents in the db to a query.
+     *
      * @param collectionName
      * @param filter
      * @param options
@@ -100,6 +106,7 @@ export declare class MongoQueryRunner implements QueryRunner {
     countDocuments(collectionName: string, filter: Filter<Document>, options?: CountDocumentsOptions): Promise<any>;
     /**
      * Creates an index on the db and collection.
+     *
      * @param collectionName
      * @param indexSpec
      * @param options
@@ -108,12 +115,14 @@ export declare class MongoQueryRunner implements QueryRunner {
     /**
      * Creates multiple indexes in the collection.
      * Index specifications are defined at http://docs.mongodb.org/manual/reference/command/createIndexes/.
+     *
      * @param collectionName
      * @param indexSpecs
      */
     createCollectionIndexes(collectionName: string, indexSpecs: IndexDescription[]): Promise<string[]>;
     /**
      * Delete multiple documents on MongoDB.
+     *
      * @param collectionName
      * @param filter
      * @param options
@@ -121,6 +130,7 @@ export declare class MongoQueryRunner implements QueryRunner {
     deleteMany(collectionName: string, filter: Filter<Document>, options: DeleteOptions): Promise<DeleteResult>;
     /**
      * Delete a document on MongoDB.
+     *
      * @param collectionName
      * @param filter
      * @param options
@@ -128,6 +138,7 @@ export declare class MongoQueryRunner implements QueryRunner {
     deleteOne(collectionName: string, filter: Filter<Document>, options?: DeleteOptions): Promise<DeleteResult>;
     /**
      * The distinct command returns returns a list of distinct values for the given key across a collection.
+     *
      * @param collectionName
      * @param key
      * @param filter
@@ -136,6 +147,7 @@ export declare class MongoQueryRunner implements QueryRunner {
     distinct(collectionName: string, key: any, filter: Filter<Document>, options?: CommandOperationOptions): Promise<any>;
     /**
      * Drops an index from this collection.
+     *
      * @param collectionName
      * @param indexName
      * @param options
@@ -143,11 +155,13 @@ export declare class MongoQueryRunner implements QueryRunner {
     dropCollectionIndex(collectionName: string, indexName: string, options?: CommandOperationOptions): Promise<Document>;
     /**
      * Drops all indexes from the collection.
+     *
      * @param collectionName
      */
     dropCollectionIndexes(collectionName: string): Promise<boolean>;
     /**
      * Find a document and delete it in one atomic operation, requires a write lock for the duration of the operation.
+     *
      * @param collectionName
      * @param filter
      * @param options
@@ -155,6 +169,7 @@ export declare class MongoQueryRunner implements QueryRunner {
     findOneAndDelete(collectionName: string, filter: Filter<Document>, 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.
+     *
      * @param collectionName
      * @param filter
      * @param replacement
@@ -163,6 +178,7 @@ export declare class MongoQueryRunner implements QueryRunner {
     findOneAndReplace(collectionName: string, filter: 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.
+     *
      * @param collectionName
      * @param filter
      * @param update
@@ -171,35 +187,41 @@ export declare class MongoQueryRunner implements QueryRunner {
     findOneAndUpdate(collectionName: string, filter: Filter<Document>, update: UpdateFilter<Document>, options?: FindOneAndUpdateOptions): Promise<Document | null>;
     /**
      * Retrieve all the indexes on the collection.
+     *
      * @param collectionName
      */
     collectionIndexes(collectionName: string): Promise<Document>;
     /**
      * Retrieve all the indexes on the collection.
+     *
      * @param collectionName
      * @param indexes
      */
     collectionIndexExists(collectionName: string, indexes: string | string[]): Promise<boolean>;
     /**
      * Retrieves this collections index info.
+     *
      * @param collectionName
      * @param options
      */
     collectionIndexInformation(collectionName: string, 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.
+     *
      * @param collectionName
      * @param options
      */
     initializeOrderedBulkOp(collectionName: string, 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.
+     *
      * @param collectionName
      * @param options
      */
     initializeUnorderedBulkOp(collectionName: string, options?: BulkWriteOptions): UnorderedBulkOperation;
     /**
      * Inserts an array of documents into MongoDB.
+     *
      * @param collectionName
      * @param docs
      * @param options
@@ -207,6 +229,7 @@ export declare class MongoQueryRunner implements QueryRunner {
     insertMany(collectionName: string, docs: OptionalId<Document>[], options?: BulkWriteOptions): Promise<InsertManyResult>;
     /**
      * Inserts a single document into MongoDB.
+     *
      * @param collectionName
      * @param doc
      * @param options
@@ -214,17 +237,20 @@ export declare class MongoQueryRunner implements QueryRunner {
     insertOne(collectionName: string, doc: OptionalId<Document>, options?: InsertOneOptions): Promise<InsertOneResult>;
     /**
      * Returns if the collection is a capped collection.
+     *
      * @param collectionName
      */
     isCapped(collectionName: string): Promise<boolean>;
     /**
      * Get the list of all indexes information for the collection.
+     *
      * @param collectionName
      * @param options
      */
     listCollectionIndexes(collectionName: string, 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.
+     *
      * @param collectionName
      * @param newName
      * @param options
@@ -232,6 +258,7 @@ export declare class MongoQueryRunner implements QueryRunner {
     rename(collectionName: string, newName: string, options?: RenameOptions): Promise<Collection<Document>>;
     /**
      * Replace a document on MongoDB.
+     *
      * @param collectionName
      * @param filter
      * @param replacement
@@ -240,6 +267,7 @@ export declare class MongoQueryRunner implements QueryRunner {
     replaceOne(collectionName: string, filter: Filter<Document>, replacement: Document, options?: ReplaceOptions): Promise<Document | UpdateResult>;
     /**
      * Watching new changes as stream.
+     *
      * @param collectionName
      * @param pipeline
      * @param options
@@ -247,6 +275,7 @@ export declare class MongoQueryRunner implements QueryRunner {
     watch(collectionName: string, pipeline?: Document[], options?: ChangeStreamOptions): ChangeStream;
     /**
      * Update multiple documents on MongoDB.
+     *
      * @param collectionName
      * @param filter
      * @param update
@@ -255,6 +284,7 @@ export declare class MongoQueryRunner implements QueryRunner {
     updateMany(collectionName: string, filter: Filter<Document>, update: UpdateFilter<Document>, options?: UpdateOptions): Promise<Document | UpdateResult>;
     /**
      * Update a single document on MongoDB.
+     *
      * @param collectionName
      * @param filter
      * @param update
@@ -290,18 +320,21 @@ export declare class MongoQueryRunner implements QueryRunner {
     rollbackTransaction(): Promise<void>;
     /**
      * Executes a given SQL query.
+     *
      * @param query
      * @param parameters
      */
     query(query: string, parameters?: any[]): Promise<any>;
     /**
      * Unsupported - Executing SQL query is not supported by MongoDB driver.
+     *
      * @param strings
      * @param values
      */
     sql(strings: TemplateStringsArray, ...values: unknown[]): Promise<any>;
     /**
      * Returns raw data stream.
+     *
      * @param query
      * @param parameters
      * @param onEnd
@@ -315,32 +348,38 @@ export declare class MongoQueryRunner implements QueryRunner {
     /**
      * Returns all available schema names including system schemas.
      * If database parameter specified, returns schemas of that database.
+     *
      * @param database
      */
     getSchemas(database?: string): Promise<string[]>;
     /**
      * Loads given table's data from the database.
+     *
      * @param collectionName
      */
     getTable(collectionName: string): Promise<Table | undefined>;
     /**
      * Loads all tables (with given names) from the database and creates a Table from them.
+     *
      * @param collectionNames
      */
     getTables(collectionNames: string[]): Promise<Table[]>;
     /**
      * Loads given views's data from the database.
+     *
      * @param collectionName
      */
     getView(collectionName: string): Promise<View | undefined>;
     /**
      * Loads all views (with given names) from the database and creates a Table from them.
+     *
      * @param collectionNames
      */
     getViews(collectionNames: string[]): Promise<View[]>;
     getReplicationMode(): ReplicationMode;
     /**
      * Checks if database with the given name exist.
+     *
      * @param database
      */
     hasDatabase(database: string): Promise<boolean>;
@@ -350,6 +389,7 @@ export declare class MongoQueryRunner implements QueryRunner {
     getCurrentDatabase(): Promise<undefined>;
     /**
      * Checks if schema with the given name exist.
+     *
      * @param schema
      */
     hasSchema(schema: string): Promise<boolean>;
@@ -359,79 +399,93 @@ export declare class MongoQueryRunner implements QueryRunner {
     getCurrentSchema(): Promise<undefined>;
     /**
      * Checks if table with the given name exist in the database.
+     *
      * @param collectionName
      */
     hasTable(collectionName: string): Promise<boolean>;
     /**
      * Checks if column with the given name exist in the given table.
+     *
      * @param tableOrName
      * @param columnName
      */
     hasColumn(tableOrName: Table | string, columnName: string): Promise<boolean>;
     /**
      * Creates a database if it's not created.
+     *
      * @param database
      */
     createDatabase(database: string): Promise<void>;
     /**
      * Drops database.
+     *
      * @param database
      * @param ifExists
      */
     dropDatabase(database: string, ifExists?: boolean): Promise<void>;
     /**
      * Creates a new table schema.
+     *
      * @param schemaPath
      * @param ifNotExists
      */
     createSchema(schemaPath: string, ifNotExists?: boolean): Promise<void>;
     /**
      * Drops table schema.
+     *
      * @param schemaPath
      * @param ifExists
      */
     dropSchema(schemaPath: string, ifExists?: boolean): Promise<void>;
     /**
      * Creates a new table from the given table and columns inside it.
+     *
      * @param table
      */
     createTable(table: Table): Promise<void>;
     /**
      * Drops the table.
+     *
      * @param tableName
      */
     dropTable(tableName: Table | string): Promise<void>;
     /**
      * Creates a new view.
+     *
      * @param view
      */
     createView(view: View): Promise<void>;
     /**
      * Drops the view.
+     *
      * @param target
      * @param ifExists
      */
     dropView(target: View | string, ifExists?: boolean): Promise<void>;
     /**
      * Renames the given table.
+     *
      * @param oldTableOrName
      * @param newTableOrName
      */
     renameTable(oldTableOrName: Table | string, newTableOrName: Table | string): Promise<void>;
     /**
      * Creates a new column from the column in the table.
+     *
      * @param tableOrName
      * @param column
      */
     addColumn(tableOrName: Table | string, column: TableColumn): Promise<void>;
     /**
      * Creates a new columns from the column in the table.
+     *
      * @param tableOrName
      * @param columns
      */
     addColumns(tableOrName: Table | string, columns: TableColumn[]): Promise<void>;
     /**
      * Renames column in the given table.
+     *
      * @param tableOrName
      * @param oldTableColumnOrName
      * @param newTableColumnOrName
@@ -439,6 +493,7 @@ export declare class MongoQueryRunner implements QueryRunner {
     renameColumn(tableOrName: Table | string, oldTableColumnOrName: TableColumn | string, newTableColumnOrName: TableColumn | string): Promise<void>;
     /**
      * Changes a column in the table.
+     *
      * @param tableOrName
      * @param oldTableColumnOrName
      * @param newColumn
@@ -446,6 +501,7 @@ export declare class MongoQueryRunner implements QueryRunner {
     changeColumn(tableOrName: Table | string, oldTableColumnOrName: TableColumn | string, newColumn: TableColumn): Promise<void>;
     /**
      * Changes a column in the table.
+     *
      * @param tableOrName
      * @param changedColumns
      */
@@ -455,6 +511,7 @@ export declare class MongoQueryRunner implements QueryRunner {
     }[]): Promise<void>;
     /**
      * Drops column in the table.
+     *
      * @param tableOrName
      * @param columnOrName
      * @param ifExists
@@ -462,6 +519,7 @@ export declare class MongoQueryRunner implements QueryRunner {
     dropColumn(tableOrName: Table | string, columnOrName: TableColumn | string, ifExists?: boolean): Promise<void>;
     /**
      * Drops the columns in the table.
+     *
      * @param tableOrName
      * @param columns
      * @param ifExists
@@ -469,18 +527,21 @@ export declare class MongoQueryRunner implements QueryRunner {
     dropColumns(tableOrName: Table | string, columns: TableColumn[] | string[], ifExists?: boolean): Promise<void>;
     /**
      * Creates a new primary key.
+     *
      * @param tableOrName
      * @param columnNames
      */
     createPrimaryKey(tableOrName: Table | string, columnNames: string[]): Promise<void>;
     /**
      * Updates composite primary keys.
+     *
      * @param tableOrName
      * @param columns
      */
     updatePrimaryKeys(tableOrName: Table | string, columns: TableColumn[]): Promise<void>;
     /**
      * Drops a primary key.
+     *
      * @param tableOrName
      * @param constraintName
      * @param ifExists
@@ -488,18 +549,21 @@ export declare class MongoQueryRunner implements QueryRunner {
     dropPrimaryKey(tableOrName: Table | string, constraintName?: string, ifExists?: boolean): Promise<void>;
     /**
      * Creates a new unique constraint.
+     *
      * @param tableOrName
      * @param uniqueConstraint
      */
     createUniqueConstraint(tableOrName: Table | string, uniqueConstraint: TableUnique): Promise<void>;
     /**
      * Creates a new unique constraints.
+     *
      * @param tableOrName
      * @param uniqueConstraints
      */
     createUniqueConstraints(tableOrName: Table | string, uniqueConstraints: TableUnique[]): Promise<void>;
     /**
      * Drops a unique constraint.
+     *
      * @param tableOrName
      * @param uniqueOrName
      * @param ifExists
@@ -507,6 +571,7 @@ export declare class MongoQueryRunner implements QueryRunner {
     dropUniqueConstraint(tableOrName: Table | string, uniqueOrName: TableUnique | string, ifExists?: boolean): Promise<void>;
     /**
      * Drops unique constraints.
+     *
      * @param tableOrName
      * @param uniqueConstraints
      * @param ifExists
@@ -514,18 +579,21 @@ export declare class MongoQueryRunner implements QueryRunner {
     dropUniqueConstraints(tableOrName: Table | string, uniqueConstraints: TableUnique[], ifExists?: boolean): Promise<void>;
     /**
      * Creates a new check constraint.
+     *
      * @param tableOrName
      * @param checkConstraint
      */
     createCheckConstraint(tableOrName: Table | string, checkConstraint: TableCheck): Promise<void>;
     /**
      * Creates a new check constraints.
+     *
      * @param tableOrName
      * @param checkConstraints
      */
     createCheckConstraints(tableOrName: Table | string, checkConstraints: TableCheck[]): Promise<void>;
     /**
      * Drops check constraint.
+     *
      * @param tableOrName
      * @param checkOrName
      * @param ifExists
@@ -533,6 +601,7 @@ export declare class MongoQueryRunner implements QueryRunner {
     dropCheckConstraint(tableOrName: Table | string, checkOrName: TableCheck | string, ifExists?: boolean): Promise<void>;
     /**
      * Drops check constraints.
+     *
      * @param tableOrName
      * @param checkConstraints
      * @param ifExists
@@ -540,18 +609,21 @@ export declare class MongoQueryRunner implements QueryRunner {
     dropCheckConstraints(tableOrName: Table | string, checkConstraints: TableCheck[], ifExists?: boolean): Promise<void>;
     /**
      * Creates a new exclusion constraint.
+     *
      * @param tableOrName
      * @param exclusionConstraint
      */
     createExclusionConstraint(tableOrName: Table | string, exclusionConstraint: TableExclusion): Promise<void>;
     /**
      * Creates a new exclusion constraints.
+     *
      * @param tableOrName
      * @param exclusionConstraints
      */
     createExclusionConstraints(tableOrName: Table | string, exclusionConstraints: TableExclusion[]): Promise<void>;
     /**
      * Drops exclusion constraint.
+     *
      * @param tableOrName
      * @param exclusionOrName
      * @param ifExists
@@ -559,6 +631,7 @@ export declare class MongoQueryRunner implements QueryRunner {
     dropExclusionConstraint(tableOrName: Table | string, exclusionOrName: TableExclusion | string, ifExists?: boolean): Promise<void>;
     /**
      * Drops exclusion constraints.
+     *
      * @param tableOrName
      * @param exclusionConstraints
      * @param ifExists
@@ -566,18 +639,21 @@ export declare class MongoQueryRunner implements QueryRunner {
     dropExclusionConstraints(tableOrName: Table | string, exclusionConstraints: TableExclusion[], ifExists?: boolean): Promise<void>;
     /**
      * Creates a new foreign key.
+     *
      * @param tableOrName
      * @param foreignKey
      */
     createForeignKey(tableOrName: Table | string, foreignKey: TableForeignKey): Promise<void>;
     /**
      * Creates a new foreign keys.
+     *
      * @param tableOrName
      * @param foreignKeys
      */
     createForeignKeys(tableOrName: Table | string, foreignKeys: TableForeignKey[]): Promise<void>;
     /**
      * Drops a foreign key from the table.
+     *
      * @param tableOrName
      * @param foreignKey
      * @param ifExists
@@ -585,6 +661,7 @@ export declare class MongoQueryRunner implements QueryRunner {
     dropForeignKey(tableOrName: Table | string, foreignKey: TableForeignKey, ifExists?: boolean): Promise<void>;
     /**
      * Drops a foreign keys from the table.
+     *
      * @param tableOrName
      * @param foreignKeys
      * @param ifExists
@@ -592,18 +669,21 @@ export declare class MongoQueryRunner implements QueryRunner {
     dropForeignKeys(tableOrName: Table | string, foreignKeys: TableForeignKey[], ifExists?: boolean): Promise<void>;
     /**
      * Creates a new index.
+     *
      * @param tableOrName
      * @param index
      */
     createIndex(tableOrName: Table | string, index: TableIndex): Promise<void>;
     /**
      * Creates a new indices
+     *
      * @param tableOrName
      * @param indices
      */
     createIndices(tableOrName: Table | string, indices: TableIndex[]): Promise<void>;
     /**
      * Drops an index from the table.
+     *
      * @param collectionName
      * @param indexName
      * @param ifExists
@@ -611,6 +691,7 @@ export declare class MongoQueryRunner implements QueryRunner {
     dropIndex(collectionName: string, indexName: string, ifExists?: boolean): Promise<void>;
     /**
      * Drops an indices from the table.
+     *
      * @param tableOrName
      * @param indices
      * @param ifExists
@@ -618,6 +699,7 @@ export declare class MongoQueryRunner implements QueryRunner {
     dropIndices(tableOrName: Table | string, indices: TableIndex[], ifExists?: boolean): Promise<void>;
     /**
      * Drops collection.
+     *
      * @param collectionName
      * @param options
      * @param options.cascade
@@ -656,11 +738,13 @@ export declare class MongoQueryRunner implements QueryRunner {
     executeMemoryDownSql(): Promise<void>;
     /**
      * Gets collection from the database with a given name.
+     *
      * @param collectionName
      */
     protected getCollection(collectionName: string): Collection<any>;
     /**
      * Change table comment.
+     *
      * @param tableOrName
      * @param comment
      */