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

package/browser/driver/mongodb/MongoQueryRunner.js

@@ -9,6 +9,7 @@ const Broadcaster_1 = require("../../subscriber/Broadcaster");
 class MongoQueryRunner {
     /**
      * DataSource used by the driver.
+     *
      * @deprecated since 1.0.0. Use {@link dataSource} instance instead.
      */
     get connection() {
@@ -55,6 +56,7 @@ class MongoQueryRunner {
     }
     /**
      * Creates a cursor for a query that can be used to iterate over results from MongoDB.
+     *
      * @param collectionName
      * @param filter
      */
@@ -63,52 +65,58 @@ class MongoQueryRunner {
     }
     /**
      * Execute an aggregation framework pipeline against the collection.
+     *
      * @param collectionName
      * @param pipeline
      * @param options
      */
     aggregate(collectionName, pipeline, options) {
-        return this.getCollection(collectionName).aggregate(pipeline, options || {});
+        return this.getCollection(collectionName).aggregate(pipeline, options ?? {});
     }
     /**
      * Perform a bulkWrite operation without a fluent API.
+     *
      * @param collectionName
      * @param operations
      * @param options
      */
     async bulkWrite(collectionName, operations, options) {
-        return await this.getCollection(collectionName).bulkWrite(operations, options || {});
+        return await this.getCollection(collectionName).bulkWrite(operations, options ?? {});
     }
     /**
      * Count number of matching documents in the db to a query.
+     *
      * @param collectionName
      * @param filter
      * @param options
      */
     async count(collectionName, filter, options) {
-        return this.getCollection(collectionName).count(filter || {}, options || {});
+        return this.getCollection(collectionName).count(filter || {}, options ?? {});
     }
     /**
      * Count number of matching documents in the db to a query.
+     *
      * @param collectionName
      * @param filter
      * @param options
      */
     async countDocuments(collectionName, filter, options) {
-        return this.getCollection(collectionName).countDocuments(filter || {}, options || {});
+        return this.getCollection(collectionName).countDocuments(filter || {}, options ?? {});
     }
     /**
      * Creates an index on the db and collection.
+     *
      * @param collectionName
      * @param indexSpec
      * @param options
      */
     async createCollectionIndex(collectionName, indexSpec, options) {
-        return this.getCollection(collectionName).createIndex(indexSpec, options || {});
+        return this.getCollection(collectionName).createIndex(indexSpec, options ?? {});
     }
     /**
      * Creates multiple indexes in the collection.
      * Index specifications are defined at http://docs.mongodb.org/manual/reference/command/createIndexes/.
+     *
      * @param collectionName
      * @param indexSpecs
      */
@@ -117,6 +125,7 @@ class MongoQueryRunner {
     }
     /**
      * Delete multiple documents on MongoDB.
+     *
      * @param collectionName
      * @param filter
      * @param options
@@ -126,34 +135,38 @@ class MongoQueryRunner {
     }
     /**
      * Delete a document on MongoDB.
+     *
      * @param collectionName
      * @param filter
      * @param options
      */
     async deleteOne(collectionName, filter, options) {
-        return this.getCollection(collectionName).deleteOne(filter, options || {});
+        return this.getCollection(collectionName).deleteOne(filter, options ?? {});
     }
     /**
      * The distinct command returns returns a list of distinct values for the given key across a collection.
+     *
      * @param collectionName
      * @param key
      * @param filter
      * @param options
      */
     async distinct(collectionName, key, filter, options) {
-        return this.getCollection(collectionName).distinct(key, filter, options || {});
+        return this.getCollection(collectionName).distinct(key, filter, options ?? {});
     }
     /**
      * Drops an index from this collection.
+     *
      * @param collectionName
      * @param indexName
      * @param options
      */
     async dropCollectionIndex(collectionName, indexName, options) {
-        return this.getCollection(collectionName).dropIndex(indexName, options || {});
+        return this.getCollection(collectionName).dropIndex(indexName, options ?? {});
     }
     /**
      * Drops all indexes from the collection.
+     *
      * @param collectionName
      */
     async dropCollectionIndexes(collectionName) {
@@ -161,35 +174,39 @@ class MongoQueryRunner {
     }
     /**
      * 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
      */
     async findOneAndDelete(collectionName, filter, options) {
-        return this.getCollection(collectionName).findOneAndDelete(filter, options || {});
+        return this.getCollection(collectionName).findOneAndDelete(filter, options ?? {});
     }
     /**
      * 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
      * @param options
      */
     async findOneAndReplace(collectionName, filter, replacement, options) {
-        return this.getCollection(collectionName).findOneAndReplace(filter, replacement, options || {});
+        return this.getCollection(collectionName).findOneAndReplace(filter, replacement, options ?? {});
     }
     /**
      * 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
      * @param options
      */
     async findOneAndUpdate(collectionName, filter, update, options) {
-        return this.getCollection(collectionName).findOneAndUpdate(filter, update, options || {});
+        return this.getCollection(collectionName).findOneAndUpdate(filter, update, options ?? {});
     }
     /**
      * Retrieve all the indexes on the collection.
+     *
      * @param collectionName
      */
     async collectionIndexes(collectionName) {
@@ -197,6 +214,7 @@ class MongoQueryRunner {
     }
     /**
      * Retrieve all the indexes on the collection.
+     *
      * @param collectionName
      * @param indexes
      */
@@ -205,14 +223,16 @@ class MongoQueryRunner {
     }
     /**
      * Retrieves this collections index info.
+     *
      * @param collectionName
      * @param options
      */
     async collectionIndexInformation(collectionName, options) {
-        return this.getCollection(collectionName).indexInformation(options || {});
+        return this.getCollection(collectionName).indexInformation(options ?? {});
     }
     /**
      * 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
      */
@@ -221,6 +241,7 @@ class MongoQueryRunner {
     }
     /**
      * 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
      */
@@ -229,24 +250,27 @@ class MongoQueryRunner {
     }
     /**
      * Inserts an array of documents into MongoDB.
+     *
      * @param collectionName
      * @param docs
      * @param options
      */
     async insertMany(collectionName, docs, options) {
-        return this.getCollection(collectionName).insertMany(docs, options || {});
+        return this.getCollection(collectionName).insertMany(docs, options ?? {});
     }
     /**
      * Inserts a single document into MongoDB.
+     *
      * @param collectionName
      * @param doc
      * @param options
      */
     async insertOne(collectionName, doc, options) {
-        return this.getCollection(collectionName).insertOne(doc, options || {});
+        return this.getCollection(collectionName).insertOne(doc, options ?? {});
     }
     /**
      * Returns if the collection is a capped collection.
+     *
      * @param collectionName
      */
     async isCapped(collectionName) {
@@ -254,6 +278,7 @@ class MongoQueryRunner {
     }
     /**
      * Get the list of all indexes information for the collection.
+     *
      * @param collectionName
      * @param options
      */
@@ -262,25 +287,28 @@ class MongoQueryRunner {
     }
     /**
      * 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
      */
     async rename(collectionName, newName, options) {
-        return this.getCollection(collectionName).rename(newName, options || {});
+        return this.getCollection(collectionName).rename(newName, options ?? {});
     }
     /**
      * Replace a document on MongoDB.
+     *
      * @param collectionName
      * @param filter
      * @param replacement
      * @param options
      */
     async replaceOne(collectionName, filter, replacement, options) {
-        return this.getCollection(collectionName).replaceOne(filter, replacement, options || {});
+        return this.getCollection(collectionName).replaceOne(filter, replacement, options ?? {});
     }
     /**
      * Watching new changes as stream.
+     *
      * @param collectionName
      * @param pipeline
      * @param options
@@ -290,23 +318,25 @@ class MongoQueryRunner {
     }
     /**
      * Update multiple documents on MongoDB.
+     *
      * @param collectionName
      * @param filter
      * @param update
      * @param options
      */
     async updateMany(collectionName, filter, update, options) {
-        return this.getCollection(collectionName).updateMany(filter, update, options || {});
+        return this.getCollection(collectionName).updateMany(filter, update, options ?? {});
     }
     /**
      * Update a single document on MongoDB.
+     *
      * @param collectionName
      * @param filter
      * @param update
      * @param options
      */
     async updateOne(collectionName, filter, update, options) {
-        return await this.getCollection(collectionName).updateOne(filter, update, options || {});
+        return await this.getCollection(collectionName).updateOne(filter, update, options ?? {});
     }
     // -------------------------------------------------------------------------
     // Public Implemented Methods (from QueryRunner)
@@ -354,6 +384,7 @@ class MongoQueryRunner {
     }
     /**
      * Executes a given SQL query.
+     *
      * @param query
      * @param parameters
      */
@@ -362,6 +393,7 @@ class MongoQueryRunner {
     }
     /**
      * Unsupported - Executing SQL query is not supported by MongoDB driver.
+     *
      * @param strings
      * @param values
      */
@@ -370,6 +402,7 @@ class MongoQueryRunner {
     }
     /**
      * Returns raw data stream.
+     *
      * @param query
      * @param parameters
      * @param onEnd
@@ -387,6 +420,7 @@ class MongoQueryRunner {
     /**
      * Returns all available schema names including system schemas.
      * If database parameter specified, returns schemas of that database.
+     *
      * @param database
      */
     async getSchemas(database) {
@@ -394,6 +428,7 @@ class MongoQueryRunner {
     }
     /**
      * Loads given table's data from the database.
+     *
      * @param collectionName
      */
     async getTable(collectionName) {
@@ -401,6 +436,7 @@ class MongoQueryRunner {
     }
     /**
      * Loads all tables (with given names) from the database and creates a Table from them.
+     *
      * @param collectionNames
      */
     async getTables(collectionNames) {
@@ -408,6 +444,7 @@ class MongoQueryRunner {
     }
     /**
      * Loads given views's data from the database.
+     *
      * @param collectionName
      */
     async getView(collectionName) {
@@ -415,6 +452,7 @@ class MongoQueryRunner {
     }
     /**
      * Loads all views (with given names) from the database and creates a Table from them.
+     *
      * @param collectionNames
      */
     async getViews(collectionNames) {
@@ -425,6 +463,7 @@ class MongoQueryRunner {
     }
     /**
      * Checks if database with the given name exist.
+     *
      * @param database
      */
     async hasDatabase(database) {
@@ -438,6 +477,7 @@ class MongoQueryRunner {
     }
     /**
      * Checks if schema with the given name exist.
+     *
      * @param schema
      */
     async hasSchema(schema) {
@@ -451,6 +491,7 @@ class MongoQueryRunner {
     }
     /**
      * Checks if table with the given name exist in the database.
+     *
      * @param collectionName
      */
     async hasTable(collectionName) {
@@ -458,6 +499,7 @@ class MongoQueryRunner {
     }
     /**
      * Checks if column with the given name exist in the given table.
+     *
      * @param tableOrName
      * @param columnName
      */
@@ -466,6 +508,7 @@ class MongoQueryRunner {
     }
     /**
      * Creates a database if it's not created.
+     *
      * @param database
      */
     async createDatabase(database) {
@@ -473,6 +516,7 @@ class MongoQueryRunner {
     }
     /**
      * Drops database.
+     *
      * @param database
      * @param ifExists
      */
@@ -481,6 +525,7 @@ class MongoQueryRunner {
     }
     /**
      * Creates a new table schema.
+     *
      * @param schemaPath
      * @param ifNotExists
      */
@@ -489,6 +534,7 @@ class MongoQueryRunner {
     }
     /**
      * Drops table schema.
+     *
      * @param schemaPath
      * @param ifExists
      */
@@ -497,6 +543,7 @@ class MongoQueryRunner {
     }
     /**
      * Creates a new table from the given table and columns inside it.
+     *
      * @param table
      */
     async createTable(table) {
@@ -504,6 +551,7 @@ class MongoQueryRunner {
     }
     /**
      * Drops the table.
+     *
      * @param tableName
      */
     async dropTable(tableName) {
@@ -511,6 +559,7 @@ class MongoQueryRunner {
     }
     /**
      * Creates a new view.
+     *
      * @param view
      */
     async createView(view) {
@@ -518,6 +567,7 @@ class MongoQueryRunner {
     }
     /**
      * Drops the view.
+     *
      * @param target
      * @param ifExists
      */
@@ -526,6 +576,7 @@ class MongoQueryRunner {
     }
     /**
      * Renames the given table.
+     *
      * @param oldTableOrName
      * @param newTableOrName
      */
@@ -534,6 +585,7 @@ class MongoQueryRunner {
     }
     /**
      * Creates a new column from the column in the table.
+     *
      * @param tableOrName
      * @param column
      */
@@ -542,6 +594,7 @@ class MongoQueryRunner {
     }
     /**
      * Creates a new columns from the column in the table.
+     *
      * @param tableOrName
      * @param columns
      */
@@ -550,6 +603,7 @@ class MongoQueryRunner {
     }
     /**
      * Renames column in the given table.
+     *
      * @param tableOrName
      * @param oldTableColumnOrName
      * @param newTableColumnOrName
@@ -559,6 +613,7 @@ class MongoQueryRunner {
     }
     /**
      * Changes a column in the table.
+     *
      * @param tableOrName
      * @param oldTableColumnOrName
      * @param newColumn
@@ -568,6 +623,7 @@ class MongoQueryRunner {
     }
     /**
      * Changes a column in the table.
+     *
      * @param tableOrName
      * @param changedColumns
      */
@@ -576,6 +632,7 @@ class MongoQueryRunner {
     }
     /**
      * Drops column in the table.
+     *
      * @param tableOrName
      * @param columnOrName
      * @param ifExists
@@ -585,6 +642,7 @@ class MongoQueryRunner {
     }
     /**
      * Drops the columns in the table.
+     *
      * @param tableOrName
      * @param columns
      * @param ifExists
@@ -594,6 +652,7 @@ class MongoQueryRunner {
     }
     /**
      * Creates a new primary key.
+     *
      * @param tableOrName
      * @param columnNames
      */
@@ -602,6 +661,7 @@ class MongoQueryRunner {
     }
     /**
      * Updates composite primary keys.
+     *
      * @param tableOrName
      * @param columns
      */
@@ -610,6 +670,7 @@ class MongoQueryRunner {
     }
     /**
      * Drops a primary key.
+     *
      * @param tableOrName
      * @param constraintName
      * @param ifExists
@@ -619,6 +680,7 @@ class MongoQueryRunner {
     }
     /**
      * Creates a new unique constraint.
+     *
      * @param tableOrName
      * @param uniqueConstraint
      */
@@ -627,6 +689,7 @@ class MongoQueryRunner {
     }
     /**
      * Creates a new unique constraints.
+     *
      * @param tableOrName
      * @param uniqueConstraints
      */
@@ -635,6 +698,7 @@ class MongoQueryRunner {
     }
     /**
      * Drops a unique constraint.
+     *
      * @param tableOrName
      * @param uniqueOrName
      * @param ifExists
@@ -644,6 +708,7 @@ class MongoQueryRunner {
     }
     /**
      * Drops unique constraints.
+     *
      * @param tableOrName
      * @param uniqueConstraints
      * @param ifExists
@@ -653,6 +718,7 @@ class MongoQueryRunner {
     }
     /**
      * Creates a new check constraint.
+     *
      * @param tableOrName
      * @param checkConstraint
      */
@@ -661,6 +727,7 @@ class MongoQueryRunner {
     }
     /**
      * Creates a new check constraints.
+     *
      * @param tableOrName
      * @param checkConstraints
      */
@@ -669,6 +736,7 @@ class MongoQueryRunner {
     }
     /**
      * Drops check constraint.
+     *
      * @param tableOrName
      * @param checkOrName
      * @param ifExists
@@ -678,6 +746,7 @@ class MongoQueryRunner {
     }
     /**
      * Drops check constraints.
+     *
      * @param tableOrName
      * @param checkConstraints
      * @param ifExists
@@ -687,6 +756,7 @@ class MongoQueryRunner {
     }
     /**
      * Creates a new exclusion constraint.
+     *
      * @param tableOrName
      * @param exclusionConstraint
      */
@@ -695,6 +765,7 @@ class MongoQueryRunner {
     }
     /**
      * Creates a new exclusion constraints.
+     *
      * @param tableOrName
      * @param exclusionConstraints
      */
@@ -703,6 +774,7 @@ class MongoQueryRunner {
     }
     /**
      * Drops exclusion constraint.
+     *
      * @param tableOrName
      * @param exclusionOrName
      * @param ifExists
@@ -712,6 +784,7 @@ class MongoQueryRunner {
     }
     /**
      * Drops exclusion constraints.
+     *
      * @param tableOrName
      * @param exclusionConstraints
      * @param ifExists
@@ -721,6 +794,7 @@ class MongoQueryRunner {
     }
     /**
      * Creates a new foreign key.
+     *
      * @param tableOrName
      * @param foreignKey
      */
@@ -729,6 +803,7 @@ class MongoQueryRunner {
     }
     /**
      * Creates a new foreign keys.
+     *
      * @param tableOrName
      * @param foreignKeys
      */
@@ -737,6 +812,7 @@ class MongoQueryRunner {
     }
     /**
      * Drops a foreign key from the table.
+     *
      * @param tableOrName
      * @param foreignKey
      * @param ifExists
@@ -746,6 +822,7 @@ class MongoQueryRunner {
     }
     /**
      * Drops a foreign keys from the table.
+     *
      * @param tableOrName
      * @param foreignKeys
      * @param ifExists
@@ -755,6 +832,7 @@ class MongoQueryRunner {
     }
     /**
      * Creates a new index.
+     *
      * @param tableOrName
      * @param index
      */
@@ -763,6 +841,7 @@ class MongoQueryRunner {
     }
     /**
      * Creates a new indices
+     *
      * @param tableOrName
      * @param indices
      */
@@ -771,6 +850,7 @@ class MongoQueryRunner {
     }
     /**
      * Drops an index from the table.
+     *
      * @param collectionName
      * @param indexName
      * @param ifExists
@@ -780,6 +860,7 @@ class MongoQueryRunner {
     }
     /**
      * Drops an indices from the table.
+     *
      * @param tableOrName
      * @param indices
      * @param ifExists
@@ -789,6 +870,7 @@ class MongoQueryRunner {
     }
     /**
      * Drops collection.
+     *
      * @param collectionName
      * @param options
      * @param options.cascade
@@ -847,6 +929,7 @@ class MongoQueryRunner {
     // -------------------------------------------------------------------------
     /**
      * Gets collection from the database with a given name.
+     *
      * @param collectionName
      */
     getCollection(collectionName) {
@@ -856,6 +939,7 @@ class MongoQueryRunner {
     }
     /**
      * Change table comment.
+     *
      * @param tableOrName
      * @param comment
      */