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

package/entity-manager/EntityManager.js

@@ -22,6 +22,7 @@ const OrmUtils_1 = require("../util/OrmUtils");
 class EntityManager {
     /**
      * DataSource used by this entity manager.
+     *
      * @deprecated since 1.0.0. Use {@link dataSource} instance instead.
      */
     get connection() {
@@ -58,6 +59,7 @@ class EntityManager {
     /**
      * Wraps given function execution (and all operations made there) in a transaction.
      * All database operations must be executed using provided entity manager.
+     *
      * @param isolationOrRunInTransaction
      * @param runInTransactionParam
      */
@@ -71,11 +73,11 @@ class EntityManager {
         if (!runInTransaction) {
             throw new error_1.TypeORMError(`Transaction method requires callback in second parameter if isolation level is supplied.`);
         }
-        if (this.queryRunner && this.queryRunner.isReleased)
+        if (this.queryRunner?.isReleased)
             throw new QueryRunnerProviderAlreadyReleasedError_1.QueryRunnerProviderAlreadyReleasedError();
         // if query runner is already defined in this class, it means this entity manager was already created for a single connection
         // if its not defined we create a new query runner - single connection where we'll execute all our operations
-        const queryRunner = this.queryRunner || this.dataSource.createQueryRunner();
+        const queryRunner = this.queryRunner ?? this.dataSource.createQueryRunner();
         try {
             await queryRunner.startTransaction(isolation);
             const result = await runInTransaction(queryRunner.manager);
@@ -98,6 +100,7 @@ class EntityManager {
     }
     /**
      * Executes raw SQL query and returns raw database results.
+     *
      * @param query
      * @param parameters
      * @see [Official docs](https://typeorm.io/docs/Working%20with%20Entity%20Manager/entity-manager-api/) for examples.
@@ -110,7 +113,10 @@ class EntityManager {
      * 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}`
+     *
+     * @example
+     * entityManager.sql`SELECT * FROM table_name WHERE id = ${id}`
+     *
      * @param strings
      * @param values
      */
@@ -124,22 +130,24 @@ class EntityManager {
     }
     /**
      * Creates a new query builder that can be used to build a SQL query.
+     *
      * @param entityClass
      * @param alias
      * @param queryRunner
      */
     createQueryBuilder(entityClass, alias, queryRunner) {
         if (alias) {
-            return this.dataSource.createQueryBuilder(entityClass, alias, queryRunner || this.queryRunner);
+            return this.dataSource.createQueryBuilder(entityClass, alias, queryRunner ?? this.queryRunner);
         }
         else {
-            return this.dataSource.createQueryBuilder(entityClass ||
-                queryRunner ||
+            return this.dataSource.createQueryBuilder(entityClass ??
+                queryRunner ??
                 this.queryRunner);
         }
     }
     /**
      * Checks if entity has an id by its Function type or schema name.
+     *
      * @param targetOrEntity
      * @param maybeEntity
      */
@@ -151,6 +159,7 @@ class EntityManager {
     }
     /**
      * Gets entity mixed id.
+     *
      * @param targetOrEntity
      * @param maybeEntity
      */
@@ -163,6 +172,7 @@ class EntityManager {
     /**
      * Creates a new entity instance or instances.
      * Can copy properties from the given object into new entities.
+     *
      * @param entityClass
      * @param plainObjectOrObjects
      */
@@ -178,6 +188,7 @@ class EntityManager {
     }
     /**
      * Merges two entities into one new entity.
+     *
      * @param entityClass
      * @param mergeIntoEntity
      * @param entityLikes
@@ -193,6 +204,7 @@ class EntityManager {
      * 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.
+     *
      * @param entityClass
      * @param entityLike
      */
@@ -206,6 +218,7 @@ class EntityManager {
     }
     /**
      * Saves a given entity in the database.
+     *
      * @param targetOrEntity
      * @param maybeEntityOrOptions
      * @param maybeOptions
@@ -236,6 +249,7 @@ class EntityManager {
     }
     /**
      * Removes a given entity from the database.
+     *
      * @param targetOrEntity
      * @param maybeEntityOrOptions
      * @param maybeOptions
@@ -264,6 +278,7 @@ class EntityManager {
     }
     /**
      * Records the delete date of one or many given entities.
+     *
      * @param targetOrEntity
      * @param maybeEntityOrOptions
      * @param maybeOptions
@@ -294,6 +309,7 @@ class EntityManager {
     }
     /**
      * Recovers one or many given entities.
+     *
      * @param targetOrEntity
      * @param maybeEntityOrOptions
      * @param maybeOptions
@@ -328,6 +344,7 @@ class EntityManager {
      * 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.
+     *
      * @param target
      * @param entity
      */
@@ -363,7 +380,7 @@ class EntityManager {
             col.isUpdate !== false &&
             !col.generatedType &&
             entities.some((entity) => typeof col.getEntityValue(entity) !== "undefined"));
-        const upsertType = options.upsertType || this.dataSource.driver.supportedUpsertTypes[0];
+        const upsertType = options.upsertType ?? this.dataSource.driver.supportedUpsertTypes[0];
         const qb = this.createQueryBuilder()
             .insert()
             .into(target)
@@ -384,6 +401,7 @@ class EntityManager {
      * Executes fast and efficient UPDATE query.
      * Does not check if entity exist in the database.
      * Condition(s) cannot be empty.
+     *
      * @param target
      * @param criteria
      * @param partialEntity
@@ -422,6 +440,7 @@ class EntityManager {
      * Executes fast and efficient UPDATE query without WHERE clause.
      *
      * WARNING! This method updates ALL rows in the target table.
+     *
      * @param target
      * @param partialEntity
      * @param options
@@ -439,6 +458,7 @@ class EntityManager {
      * Executes fast and efficient DELETE query.
      * Does not check if entity exist in the database.
      * Condition(s) cannot be empty.
+     *
      * @param targetOrEntity
      * @param criteria
      */
@@ -469,6 +489,7 @@ class EntityManager {
      * Executes fast and efficient DELETE query without WHERE clause.
      *
      * WARNING! This method deletes ALL rows in the target table.
+     *
      * @param targetOrEntity
      */
     deleteAll(targetOrEntity) {
@@ -480,6 +501,7 @@ class EntityManager {
      * Executes fast and efficient UPDATE query.
      * Does not check if entity exist in the database.
      * Condition(s) cannot be empty.
+     *
      * @param targetOrEntity
      * @param criteria
      */
@@ -510,6 +532,7 @@ class EntityManager {
      * Executes fast and efficient UPDATE query.
      * Does not check if entity exist in the database.
      * Condition(s) cannot be empty.
+     *
      * @param targetOrEntity
      * @param criteria
      */
@@ -536,17 +559,19 @@ class EntityManager {
     }
     /**
      * Checks whether any entity exists with the given options.
+     *
      * @param entityClass
      * @param options
      */
     async exists(entityClass, options) {
         const metadata = this.dataSource.getMetadata(entityClass);
         return this.createQueryBuilder(entityClass, metadata.name)
-            .setFindOptions(options || {})
+            .setFindOptions(options ?? {})
             .getExists();
     }
     /**
      * Checks whether any entity exists with the given conditions.
+     *
      * @param entityClass
      * @param where
      */
@@ -559,18 +584,20 @@ class EntityManager {
     /**
      * Counts entities that match given options.
      * Useful for pagination.
+     *
      * @param entityClass
      * @param options
      */
     async count(entityClass, options) {
         const metadata = this.dataSource.getMetadata(entityClass);
         return this.createQueryBuilder(entityClass, metadata.name)
-            .setFindOptions(options || {})
+            .setFindOptions(options ?? {})
             .getCount();
     }
     /**
      * Counts entities that match given conditions.
      * Useful for pagination.
+     *
      * @param entityClass
      * @param where
      */
@@ -582,6 +609,7 @@ class EntityManager {
     }
     /**
      * Return the SUM of a column
+     *
      * @param entityClass
      * @param columnName
      * @param where
@@ -591,6 +619,7 @@ class EntityManager {
     }
     /**
      * Return the AVG of a column
+     *
      * @param entityClass
      * @param columnName
      * @param where
@@ -600,6 +629,7 @@ class EntityManager {
     }
     /**
      * Return the MIN of a column
+     *
      * @param entityClass
      * @param columnName
      * @param where
@@ -609,6 +639,7 @@ class EntityManager {
     }
     /**
      * Return the MAX of a column
+     *
      * @param entityClass
      * @param columnName
      * @param where
@@ -633,17 +664,19 @@ class EntityManager {
     }
     /**
      * Finds entities that match given find options.
+     *
      * @param entityClass
      * @param options
      */
     async find(entityClass, options) {
         const metadata = this.dataSource.getMetadata(entityClass);
         return this.createQueryBuilder(entityClass, metadata.name)
-            .setFindOptions(options || {})
+            .setFindOptions(options ?? {})
             .getMany();
     }
     /**
      * Finds entities that match given find options.
+     *
      * @param entityClass
      * @param where
      */
@@ -657,19 +690,21 @@ class EntityManager {
      * Finds entities that match given find options.
      * Also counts all entities that match given conditions,
      * but ignores pagination settings (from and take options).
+     *
      * @param entityClass
      * @param options
      */
     async findAndCount(entityClass, options) {
         const metadata = this.dataSource.getMetadata(entityClass);
         return this.createQueryBuilder(entityClass, metadata.name)
-            .setFindOptions(options || {})
+            .setFindOptions(options ?? {})
             .getManyAndCount();
     }
     /**
      * Finds entities that match given WHERE conditions.
      * Also counts all entities that match given conditions,
      * but ignores pagination settings (from and take options).
+     *
      * @param entityClass
      * @param where
      */
@@ -682,6 +717,7 @@ class EntityManager {
     /**
      * Finds first entity by a given find options.
      * If entity was not found in the database - returns null.
+     *
      * @param entityClass
      * @param options
      */
@@ -701,6 +737,7 @@ class EntityManager {
     /**
      * Finds first entity that matches given where condition.
      * If entity was not found in the database - returns null.
+     *
      * @param entityClass
      * @param where
      */
@@ -717,6 +754,7 @@ class EntityManager {
     /**
      * Finds first entity by a given find options.
      * If entity was not found in the database - rejects with error.
+     *
      * @param entityClass
      * @param options
      */
@@ -731,6 +769,7 @@ class EntityManager {
     /**
      * Finds first entity that matches given where condition.
      * If entity was not found in the database - rejects with error.
+     *
      * @param entityClass
      * @param where
      */
@@ -746,6 +785,7 @@ class EntityManager {
      * 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.
+     *
      * @param entityClass
      * @param options
      * @param options.cascade
@@ -753,7 +793,7 @@ class EntityManager {
      */
     async clear(entityClass, options) {
         const metadata = this.dataSource.getMetadata(entityClass);
-        const queryRunner = this.queryRunner || this.dataSource.createQueryRunner();
+        const queryRunner = this.queryRunner ?? this.dataSource.createQueryRunner();
         try {
             return await queryRunner.clearTable(metadata.tablePath, options);
         }
@@ -764,6 +804,7 @@ class EntityManager {
     }
     /**
      * Increments some column by provided value of the entities matched given conditions.
+     *
      * @param entityClass
      * @param conditions
      * @param propertyPath
@@ -790,6 +831,7 @@ class EntityManager {
     }
     /**
      * Decrements some column by provided value of the entities matched given conditions.
+     *
      * @param entityClass
      * @param conditions
      * @param propertyPath
@@ -819,6 +861,7 @@ class EntityManager {
      * 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.
+     *
      * @param target
      */
     getRepository(target) {
@@ -843,6 +886,7 @@ class EntityManager {
      * 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.
+     *
      * @param target
      */
     getTreeRepository(target) {
@@ -860,6 +904,7 @@ class EntityManager {
     }
     /**
      * Gets mongodb repository for the given entity class.
+     *
      * @param target
      */
     getMongoRepository(target) {
@@ -869,6 +914,7 @@ class EntityManager {
      * 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.
+     *
      * @param repository
      */
     withRepository(repository) {