@sqb/nestjs 4.21.0 → 4.21.1

package/README.md

@@ -41,6 +41,38 @@ $ npm install @sqb/nestjs --save
 
 - node >= 16.x
 
+## Environment Variables
+
+The library supports configuration through environment variables. Environment variables below is accepted.
+All environment variables starts with prefix (SQB\_). This can be configured while registering the module.
+
+<!--- BEGIN env --->
+
+| Environment Variable         | Type    | Default | Description                                           |
+|------------------------------|---------|---------|-------------------------------------------------------|
+| SQB_DIALECT                  | String  |         | Database dialect (e.g. postgres, mysql, oracle)       |
+| SQB_CONNECTION_NAME          | String  |         | Logical name of the database connection               |
+| SQB_HOST                     | String  |         | Database server host address                          |
+| SQB_PORT                     | Number  |         | Database server port                                  |
+| SQB_DATABASE                 | String  |         | Database name                                         |
+| SQB_SCHEMA                   | String  |         | Default database schema                               |
+| SQB_USER                     | String  |         | Database user name                                    |
+| SQB_PASSWORD                 | String  |         | Database user password                                |
+| SQB_DRIVER                   | String  |         | Database driver identifier                            |
+| SQB_POOL_MAX                 | Number  |         | Maximum number of connections in the pool             |
+| SQB_POOL_MIN                 | Number  |         | Minimum number of connections in the pool             |
+| SQB_POOL_IDLE_TIMEOUT        | Number  |         | Time (ms) before an idle connection is released       |
+| SQB_POOL_ACQUIRE_TIMEOUT     | Number  |         | Timeout (ms) for acquiring a connection               |
+| SQB_POOL_ACQUIRE_MAX_RETRIES | Number  |         | Maximum number of retries when acquiring a connection |
+| SQB_POOL_ACQUIRE_RETRY_WAIT  | Number  |         | Wait time (ms) between acquire retry attempts         |
+| SQB_POOL_FIFO                | Boolean |         | Whether the pool queue operates in FIFO mode          |
+| SQB_POOL_MAX_QUEUE           | Number  |         | Maximum number of queued connection requests          |
+| SQB_POOL_MIN_IDLE            | Number  |         | Minimum number of idle connections to keep            |
+| SQB_POOL_VALIDATION          | Boolean |         | Enables validation of connections before use          |
+| SQB_POOL_HOUSE_KEEP_INTERVAL | Number  |         | Interval (ms) for pool housekeeping tasks             |
+
+<!--- END env --->
+
 ### License
 
 SQB is available under [MIT](LICENSE) license.
@@ -61,3 +93,4 @@ SQB is available under [MIT](LICENSE) license.
 [devdependencies-url]: https://david-dm.org/sqbjs/@sqb/nestjs?type=dev
 [quality-image]: http://npm.packagequality.com/shield/@sqb/nestjs.png
 [quality-url]: http://packagequality.com/#?package=@sqb/nestjs
+

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sqb/nestjs",
   "description": "Nestjs module for data connection using SQB",
-  "version": "4.21.0",
+  "version": "4.21.1",
   "author": "Panates",
   "license": "Apache-2.0",
   "dependencies": {
@@ -12,8 +12,8 @@
   "peerDependencies": {
     "@nestjs/common": ">=7.4.0",
     "@nestjs/core": ">=7.4.0",
-    "@sqb/builder": "^4.21.0",
-    "@sqb/connect": "^4.21.0",
+    "@sqb/builder": "^4.21.1",
+    "@sqb/connect": "^4.21.1",
     "reflect-metadata": "^0.2.2",
     "rxjs": ">=6.6.0"
   },

package/sqb-core.module.d.ts

@@ -1,12 +1,14 @@
-import { DynamicModule, OnApplicationShutdown } from '@nestjs/common';
+import { DynamicModule, Logger, OnApplicationShutdown } from '@nestjs/common';
 import { ModuleRef } from '@nestjs/core';
 import type { SqbModuleAsyncOptions, SqbModuleOptions } from './sqb.interface.js';
 export declare class SqbCoreModule implements OnApplicationShutdown {
     private readonly options;
     private readonly moduleRef;
-    constructor(options: SqbModuleOptions, moduleRef: ModuleRef);
+    private logger?;
+    constructor(options: SqbModuleOptions, moduleRef: ModuleRef, logger?: Logger | undefined);
     static forRoot(options?: SqbModuleOptions): DynamicModule;
     static forRootAsync(options: SqbModuleAsyncOptions): DynamicModule;
+    onApplicationBootstrap(): Promise<void> | undefined;
     onApplicationShutdown(): Promise<void>;
     private static createAsyncProviders;
     private static createAsyncOptionsProvider;

package/sqb-core.module.js

@@ -1,6 +1,6 @@
 var SqbCoreModule_1;
 import { __decorate, __metadata, __param } from "tslib";
-import { Global, Inject, Module, } from '@nestjs/common';
+import { Global, Inject, Logger, Module, } from '@nestjs/common';
 import { ModuleRef } from '@nestjs/core';
 import { SqbClient } from '@sqb/connect';
 import * as crypto from 'crypto';
@@ -12,9 +12,11 @@ import { getSQBToken, handleRetry } from './sqb.utils.js';
 let SqbCoreModule = SqbCoreModule_1 = class SqbCoreModule {
     options;
     moduleRef;
-    constructor(options, moduleRef) {
+    logger;
+    constructor(options, moduleRef, logger) {
         this.options = options;
         this.moduleRef = moduleRef;
+        this.logger = logger;
     }
     static forRoot(options = {}) {
         const optionsProvider = {
@@ -35,6 +37,12 @@ let SqbCoreModule = SqbCoreModule_1 = class SqbCoreModule {
                     provide: SQB_CONNECTION_OPTIONS,
                     useValue: getSqbConfig(options.useValue || {}, options.envPrefix),
                 },
+                {
+                    provide: Logger,
+                    useValue: typeof options.logger === 'string'
+                        ? new Logger(options.logger)
+                        : options.logger,
+                },
             ],
             exports: [connectionProvider],
         };
@@ -60,10 +68,28 @@ let SqbCoreModule = SqbCoreModule_1 = class SqbCoreModule {
                     provide: SQB_MODULE_ID,
                     useValue: crypto.randomUUID(),
                 },
+                {
+                    provide: Logger,
+                    useValue: typeof options.logger === 'string'
+                        ? new Logger(options.logger)
+                        : options.logger,
+                },
             ],
             exports: [connectionProvider],
         };
     }
+    onApplicationBootstrap() {
+        const client = this.moduleRef.get(getSQBToken(this.options.name));
+        const op = this.moduleRef.get(SQB_CONNECTION_OPTIONS);
+        if (this.options.lazyConnect)
+            return;
+        this.logger?.log(`Connecting to database [${op.database}] at ${op.host}:${op.port} using ${op.dialect} dialect`);
+        Logger.flush();
+        return client.test().catch(e => {
+            this.logger?.error(`${op.dialect} connection failed: ` + e.message);
+            throw e;
+        });
+    }
     async onApplicationShutdown() {
         const client = this.moduleRef.get(getSQBToken(this.options.name));
         const op = this.moduleRef.get(SQB_CONNECTION_OPTIONS);
@@ -121,6 +147,7 @@ SqbCoreModule = SqbCoreModule_1 = __decorate([
     Global(),
     Module({}),
     __param(0, Inject(SQB_MODULE_OPTIONS)),
-    __metadata("design:paramtypes", [Object, ModuleRef])
+    __metadata("design:paramtypes", [Object, ModuleRef,
+        Logger])
 ], SqbCoreModule);
 export { SqbCoreModule };

package/sqb.interface.d.ts

@@ -39,6 +39,7 @@ interface BaseModuleOptions {
     logger?: LoggerService | string;
     global?: boolean;
     name?: string;
+    lazyConnect?: boolean;
 }
 export interface SqbModuleOptions extends BaseModuleOptions {
     useValue?: SqbClientConnectionOptions;