Merge pull request #1766 from Junikorn/feature/manual-initialization-option

feat(): add support for manual init

Author: kamilmysliwiec

lib/interfaces/typeorm-options.interface.ts

@@ -33,6 +33,13 @@ export type TypeOrmModuleOptions = {
    * If `true`, will show verbose error messages on each connection retry.
    */
   verboseRetryLog?: boolean;
+  /**
+   * If `true` database initialization will not be performed during module initialization.
+   * This means that database connection will not be established and migrations will not run.
+   * Database initialization will have to be performed manually using `DataSource.initialize`
+   * and it will have to implement own retry mechanism (if necessary).
+   */
+  manualInitialization?: boolean;
 } & Partial<DataSourceOptions>;
 
 export interface TypeOrmOptionsFactory {

lib/typeorm-core.module.ts

@@ -213,32 +213,28 @@ export class TypeOrmCoreModule implements OnApplicationShutdown {
       });
     return await lastValueFrom(
       defer(async () => {
+        let dataSource: DataSource;
         if (!options.autoLoadEntities) {
-          const dataSource = await createTypeormDataSource(
+          dataSource = await createTypeormDataSource(
             options as DataSourceOptions,
           );
-          // TODO: remove "dataSource.initialize" condition (left for backward compatibility)
-          return (dataSource as any).initialize && !dataSource.isInitialized
-            ? dataSource.initialize()
-            : dataSource;
-        }
-
-        let entities = options.entities;
-        if (Array.isArray(entities)) {
-          entities = entities.concat(
-            EntitiesMetadataStorage.getEntitiesByDataSource(dataSourceToken),
-          );
         } else {
-          entities =
-            EntitiesMetadataStorage.getEntitiesByDataSource(dataSourceToken);
+          let entities = options.entities;
+          if (Array.isArray(entities)) {
+            entities = entities.concat(
+              EntitiesMetadataStorage.getEntitiesByDataSource(dataSourceToken),
+            );
+          } else {
+            entities =
+              EntitiesMetadataStorage.getEntitiesByDataSource(dataSourceToken);
+          }
+          dataSource = await createTypeormDataSource({
+            ...options,
+            entities,
+          } as DataSourceOptions);
         }
-        const dataSource = await createTypeormDataSource({
-          ...options,
-          entities,
-        } as DataSourceOptions);
-
         // TODO: remove "dataSource.initialize" condition (left for backward compatibility)
-        return (dataSource as any).initialize && !dataSource.isInitialized
+        return (dataSource as any).initialize && !dataSource.isInitialized && !options.manualInitialization
           ? dataSource.initialize()
           : dataSource;
       }).pipe(