typeorm 0.3.26-dev.5904ac3 → 0.3.26-dev.66ee307

package/README.md

@@ -215,11 +215,8 @@ await timber.remove()
 
         ```
         npm install @sap/hana-client
-        npm install hdb-pool
         ```
 
-        _SAP Hana support made possible by the sponsorship of [Neptune Software](https://www.neptune-software.com/)._
-
     - for **Google Cloud Spanner**
 
         ```

package/browser/driver/sap/SapConnectionOptions.d.ts

@@ -14,40 +14,66 @@ export interface SapConnectionOptions extends BaseDataSourceOptions, SapConnecti
     readonly schema?: string;
     /**
      * The driver objects
-     * This defaults to require("hdb-pool")
+     * This defaults to require("@sap/hana-client")
      */
     readonly driver?: any;
     /**
-     * The driver objects
-     * This defaults to require("@sap/hana-client")
+     * @deprecated Use {@link driver} instead.
      */
     readonly hanaClientDriver?: any;
     /**
      * Pool options.
      */
     readonly pool?: {
+        /**
+         * Maximum number of open connections created by the pool, each of which
+         * may be in the pool waiting to be reused or may no longer be in the
+         * pool and actively being used (default: 10).
+         */
+        readonly maxConnectedOrPooled?: number;
+        /**
+         * Defines the maximum time, in seconds, that connections are allowed to
+         * remain in the pool before being marked for eviction (default: 30).
+         */
+        readonly maxPooledIdleTime?: number;
+        /**
+         * Determines whether or not the pooled connection should be tested for
+         * viability before being reused (default: false).
+         */
+        readonly pingCheck?: boolean;
+        /**
+         * Maximum number of connections allowed to be in the pool, waiting to
+         * be reused (default: 0, no limit).
+         */
+        readonly poolCapacity?: number;
         /**
          * Max number of connections.
+         * @deprecated Use {@link maxConnectedOrPooled} instead.
          */
         readonly max?: number;
         /**
          * Minimum number of connections.
+         * @deprecated Obsolete, no alternative exists.
          */
         readonly min?: number;
         /**
-         * Maximum number of waiting requests allowed. (default=0, no limit).
+         * Maximum number of waiting requests allowed.
+         * @deprecated Obsolete, no alternative exists.
          */
         readonly maxWaitingRequests?: number;
         /**
-         * Max milliseconds a request will wait for a resource before timing out. (default=5000)
+         * Max milliseconds a request will wait for a resource before timing out.
+         * @deprecated Obsolete, no alternative exists.
          */
         readonly requestTimeout?: number;
         /**
-         * How often to run resource timeout checks. (default=0, disabled)
+         * How often to run resource timeout checks.
+         * @deprecated Obsolete, no alternative exists.
          */
         readonly checkInterval?: number;
         /**
-         * Idle timeout
+         * Idle timeout (in milliseconds).
+         * @deprecated Use {@link maxPooledIdleTime} (in seconds) instead .
          */
         readonly idleTimeout?: number;
         /**
@@ -56,5 +82,4 @@ export interface SapConnectionOptions extends BaseDataSourceOptions, SapConnecti
          */
         readonly poolErrorHandler?: (err: any) => any;
     };
-    readonly poolSize?: never;
 }

package/browser/driver/sap/SapConnectionOptions.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../browser/src/driver/sap/SapConnectionOptions.ts"],"names":[],"mappings":"","file":"SapConnectionOptions.js","sourcesContent":["import { BaseDataSourceOptions } from \"../../data-source/BaseDataSourceOptions\"\nimport { SapConnectionCredentialsOptions } from \"./SapConnectionCredentialsOptions\"\n\n/**\n * SAP Hana specific connection options.\n */\nexport interface SapConnectionOptions\n    extends BaseDataSourceOptions,\n        SapConnectionCredentialsOptions {\n    /**\n     * Database type.\n     */\n    readonly type: \"sap\"\n\n    /**\n     * Database schema.\n     */\n    readonly schema?: string\n\n    /**\n     * The driver objects\n     * This defaults to require(\"hdb-pool\")\n     */\n    readonly driver?: any\n\n    /**\n     * The driver objects\n     * This defaults to require(\"@sap/hana-client\")\n     */\n    readonly hanaClientDriver?: any\n\n    /**\n     * Pool options.\n     */\n    readonly pool?: {\n        /**\n         * Max number of connections.\n         */\n        readonly max?: number\n\n        /**\n         * Minimum number of connections.\n         */\n        readonly min?: number\n\n        /**\n         * Maximum number of waiting requests allowed. (default=0, no limit).\n         */\n        readonly maxWaitingRequests?: number\n        /**\n         * Max milliseconds a request will wait for a resource before timing out. (default=5000)\n         */\n        readonly requestTimeout?: number\n        /**\n         * How often to run resource timeout checks. (default=0, disabled)\n         */\n        readonly checkInterval?: number\n        /**\n         * Idle timeout\n         */\n        readonly idleTimeout?: number\n\n        /**\n         * Function handling errors thrown by drivers pool.\n         * Defaults to logging error with `warn` level.\n         */\n        readonly poolErrorHandler?: (err: any) => any\n    }\n\n    readonly poolSize?: never\n}\n"],"sourceRoot":"../.."}
+{"version":3,"sources":["../browser/src/driver/sap/SapConnectionOptions.ts"],"names":[],"mappings":"","file":"SapConnectionOptions.js","sourcesContent":["import { BaseDataSourceOptions } from \"../../data-source/BaseDataSourceOptions\"\nimport { SapConnectionCredentialsOptions } from \"./SapConnectionCredentialsOptions\"\n\n/**\n * SAP Hana specific connection options.\n */\nexport interface SapConnectionOptions\n    extends BaseDataSourceOptions,\n        SapConnectionCredentialsOptions {\n    /**\n     * Database type.\n     */\n    readonly type: \"sap\"\n\n    /**\n     * Database schema.\n     */\n    readonly schema?: string\n\n    /**\n     * The driver objects\n     * This defaults to require(\"@sap/hana-client\")\n     */\n    readonly driver?: any\n\n    /**\n     * @deprecated Use {@link driver} instead.\n     */\n    readonly hanaClientDriver?: any\n\n    /**\n     * Pool options.\n     */\n    readonly pool?: {\n        /**\n         * Maximum number of open connections created by the pool, each of which\n         * may be in the pool waiting to be reused or may no longer be in the\n         * pool and actively being used (default: 10).\n         */\n        readonly maxConnectedOrPooled?: number\n\n        /**\n         * Defines the maximum time, in seconds, that connections are allowed to\n         * remain in the pool before being marked for eviction (default: 30).\n         */\n        readonly maxPooledIdleTime?: number\n\n        /**\n         * Determines whether or not the pooled connection should be tested for\n         * viability before being reused (default: false).\n         */\n        readonly pingCheck?: boolean\n\n        /**\n         * Maximum number of connections allowed to be in the pool, waiting to\n         * be reused (default: 0, no limit).\n         */\n        readonly poolCapacity?: number\n\n        /**\n         * Max number of connections.\n         * @deprecated Use {@link maxConnectedOrPooled} instead.\n         */\n        readonly max?: number\n\n        /**\n         * Minimum number of connections.\n         * @deprecated Obsolete, no alternative exists.\n         */\n        readonly min?: number\n\n        /**\n         * Maximum number of waiting requests allowed.\n         * @deprecated Obsolete, no alternative exists.\n         */\n        readonly maxWaitingRequests?: number\n\n        /**\n         * Max milliseconds a request will wait for a resource before timing out.\n         * @deprecated Obsolete, no alternative exists.\n         */\n        readonly requestTimeout?: number\n\n        /**\n         * How often to run resource timeout checks.\n         * @deprecated Obsolete, no alternative exists.\n         */\n        readonly checkInterval?: number\n\n        /**\n         * Idle timeout (in milliseconds).\n         * @deprecated Use {@link maxPooledIdleTime} (in seconds) instead .\n         */\n        readonly idleTimeout?: number\n\n        /**\n         * Function handling errors thrown by drivers pool.\n         * Defaults to logging error with `warn` level.\n         */\n        readonly poolErrorHandler?: (err: any) => any\n    }\n}\n"],"sourceRoot":"../.."}

package/browser/driver/sap/SapDriver.d.ts

@@ -1,15 +1,15 @@
 import { ColumnType, DataSource, EntityMetadata, ObjectLiteral, Table, TableColumn, TableForeignKey } from "../..";
 import { ColumnMetadata } from "../../metadata/ColumnMetadata";
 import { RdbmsSchemaBuilder } from "../../schema-builder/RdbmsSchemaBuilder";
+import { View } from "../../schema-builder/view/View";
 import { Driver } from "../Driver";
 import { CteCapabilities } from "../types/CteCapabilities";
 import { DataTypeDefaults } from "../types/DataTypeDefaults";
 import { MappedColumnTypes } from "../types/MappedColumnTypes";
-import { SapConnectionOptions } from "./SapConnectionOptions";
-import { SapQueryRunner } from "./SapQueryRunner";
 import { ReplicationMode } from "../types/ReplicationMode";
-import { View } from "../../schema-builder/view/View";
 import { UpsertType } from "../types/UpsertType";
+import { SapConnectionOptions } from "./SapConnectionOptions";
+import { SapQueryRunner } from "./SapQueryRunner";
 /**
  * Organizes communication with SAP Hana DBMS.
  *
@@ -21,11 +21,11 @@ export declare class SapDriver implements Driver {
      */
     connection: DataSource;
     /**
-     * Hana Pool instance.
+     * SAP HANA Client Pool instance.
      */
     client: any;
     /**
-     * Hana Client streaming extension.
+     * SAP HANA Client streaming extension.
      */
     streamClient: any;
     /**
@@ -33,10 +33,9 @@ export declare class SapDriver implements Driver {
      */
     master: any;
     /**
-     * Pool for slave databases.
-     * Used in replication.
+     * Function handling errors thrown by drivers pool.
      */
-    slaves: any[];
+    poolErrorHandler: (error: any) => void;
     /**
      * Connection options.
      */
@@ -104,7 +103,7 @@ export declare class SapDriver implements Driver {
     dataTypeDefaults: DataTypeDefaults;
     /**
      * Max length allowed by SAP HANA for aliases (identifiers).
-     * @see https://help.sap.com/viewer/4fe29514fd584807ac9f2a04f6754767/2.0.03/en-US/20a760537519101497e3cfe07b348f3c.html
+     * @see https://help.sap.com/docs/hana-cloud-database/sap-hana-cloud-sap-hana-database-sql-reference-guide/system-limitations
      */
     maxAliasLength: number;
     cteCapabilities: CteCapabilities;
@@ -124,6 +123,18 @@ export declare class SapDriver implements Driver {
      * Closes connection with the database.
      */
     disconnect(): Promise<void>;
+    /**
+     * Obtains a new database connection to a master server.
+     * Used for replication.
+     * If replication is not setup then returns default connection's database connection.
+     */
+    obtainMasterConnection(): Promise<any>;
+    /**
+     * Obtains a new database connection to a slave server.
+     * Used for replication.
+     * If replication is not setup then returns master (default) connection's database connection.
+     */
+    obtainSlaveConnection(): Promise<any>;
     /**
      * Creates a schema builder used to build and sync a schema.
      */
@@ -187,18 +198,6 @@ export declare class SapDriver implements Driver {
      * Creates column type definition including length, precision and scale
      */
     createFullType(column: TableColumn): string;
-    /**
-     * Obtains a new database connection to a master server.
-     * Used for replication.
-     * If replication is not setup then returns default connection's database connection.
-     */
-    obtainMasterConnection(): Promise<any>;
-    /**
-     * Obtains a new database connection to a slave server.
-     * Used for replication.
-     * If replication is not setup then returns master (default) connection's database connection.
-     */
-    obtainSlaveConnection(): Promise<any>;
     /**
      * Creates generated map of values generated or returned by database after INSERT query.
      */

package/browser/driver/sap/SapDriver.js

@@ -1,3 +1,4 @@
+import { promisify } from "node:util";
 import { ConnectionIsNotSetError, } from "../..";
 import { DriverPackageNotInstalledError } from "../../error/DriverPackageNotInstalledError";
 import { TypeORMError } from "../../error/TypeORMError";
@@ -5,10 +6,10 @@ import { PlatformTools } from "../../platform/PlatformTools";
 import { RdbmsSchemaBuilder } from "../../schema-builder/RdbmsSchemaBuilder";
 import { ApplyValueTransformers } from "../../util/ApplyValueTransformers";
 import { DateUtils } from "../../util/DateUtils";
+import { InstanceChecker } from "../../util/InstanceChecker";
 import { OrmUtils } from "../../util/OrmUtils";
-import { SapQueryRunner } from "./SapQueryRunner";
 import { DriverUtils } from "../DriverUtils";
-import { InstanceChecker } from "../../util/InstanceChecker";
+import { SapQueryRunner } from "./SapQueryRunner";
 /**
  * Organizes communication with SAP Hana DBMS.
  *
@@ -19,11 +20,6 @@ export class SapDriver {
     // Constructor
     // -------------------------------------------------------------------------
     constructor(connection) {
-        /**
-         * Pool for slave databases.
-         * Used in replication.
-         */
-        this.slaves = [];
         /**
          * Indicates if replication is enabled.
          */
@@ -151,7 +147,7 @@ export class SapDriver {
         };
         /**
          * Max length allowed by SAP HANA for aliases (identifiers).
-         * @see https://help.sap.com/viewer/4fe29514fd584807ac9f2a04f6754767/2.0.03/en-US/20a760537519101497e3cfe07b348f3c.html
+         * @see https://help.sap.com/docs/hana-cloud-database/sap-hana-cloud-sap-hana-database-sql-reference-guide/system-limitations
          */
         this.maxAliasLength = 128;
         this.cteCapabilities = {
@@ -174,50 +170,55 @@ export class SapDriver {
      */
     async connect() {
         // HANA connection info
-        const dbParams = {
-            hostName: this.options.host,
+        const connectionOptions = {
+            host: this.options.host,
             port: this.options.port,
-            userName: this.options.username,
+            user: this.options.username,
             password: this.options.password,
-            ...this.options.extra,
+            database: this.options.database,
+            currentSchema: this.options.schema,
+            encrypt: this.options.encrypt,
+            sslValidateCertificate: this.options.sslValidateCertificate,
+            key: this.options.key,
+            cert: this.options.cert,
+            ca: this.options.ca,
         };
-        if (this.options.database)
-            dbParams.databaseName = this.options.database;
-        if (this.options.schema)
-            dbParams.currentSchema = this.options.schema;
-        if (this.options.encrypt)
-            dbParams.encrypt = this.options.encrypt;
-        if (this.options.sslValidateCertificate)
-            dbParams.validateCertificate = this.options.sslValidateCertificate;
-        if (this.options.key)
-            dbParams.key = this.options.key;
-        if (this.options.cert)
-            dbParams.cert = this.options.cert;
-        if (this.options.ca)
-            dbParams.ca = this.options.ca;
+        Object.keys(connectionOptions).forEach((key) => {
+            if (connectionOptions[key] === undefined) {
+                delete connectionOptions[key];
+            }
+        });
+        Object.assign(connectionOptions, this.options.extra ?? {});
         // pool options
-        const options = {
-            min: this.options.pool && this.options.pool.min
-                ? this.options.pool.min
-                : 1,
-            max: this.options.pool && this.options.pool.max
-                ? this.options.pool.max
-                : 10,
+        const poolOptions = {
+            maxConnectedOrPooled: this.options.pool?.maxConnectedOrPooled ??
+                this.options.pool?.max ??
+                this.options.poolSize ??
+                10,
+            maxPooledIdleTime: this.options.pool?.maxPooledIdleTime ??
+                (this.options.pool?.idleTimeout
+                    ? this.options.pool.idleTimeout / 1000
+                    : 30),
         };
-        if (this.options.pool && this.options.pool.checkInterval)
-            options.checkInterval = this.options.pool.checkInterval;
-        if (this.options.pool && this.options.pool.maxWaitingRequests)
-            options.maxWaitingRequests = this.options.pool.maxWaitingRequests;
-        if (this.options.pool && this.options.pool.requestTimeout)
-            options.requestTimeout = this.options.pool.requestTimeout;
-        if (this.options.pool && this.options.pool.idleTimeout)
-            options.idleTimeout = this.options.pool.idleTimeout;
-        const { logger } = this.connection;
-        const poolErrorHandler = options.poolErrorHandler ||
-            ((error) => logger.log("warn", `SAP Hana pool raised an error. ${error}`));
-        this.client.eventEmitter.on("poolError", poolErrorHandler);
+        if (this.options.pool?.pingCheck) {
+            poolOptions.pingCheck = this.options.pool.pingCheck;
+        }
+        if (this.options.pool?.poolCapacity) {
+            poolOptions.poolCapacity = this.options.pool.poolCapacity;
+        }
+        this.poolErrorHandler =
+            this.options.pool?.poolErrorHandler ??
+                ((error) => {
+                    this.connection.logger.log("warn", `SAP HANA pool raised an error: ${error}`);
+                });
         // create the pool
-        this.master = this.client.createPool(dbParams, options);
+        try {
+            this.master = this.client.createPool(connectionOptions, poolOptions);
+        }
+        catch (error) {
+            this.poolErrorHandler(error);
+            throw error;
+        }
         const queryRunner = this.createQueryRunner("master");
         const { version, database } = await queryRunner.getDatabaseAndVersion();
         this.version = version;
@@ -242,7 +243,39 @@ export class SapDriver {
             throw new ConnectionIsNotSetError("sap");
         }
         this.master = undefined;
-        await pool.clear();
+        try {
+            await promisify(pool.clear).call(pool);
+        }
+        catch (error) {
+            this.poolErrorHandler(error);
+            throw error;
+        }
+    }
+    /**
+     * Obtains a new database connection to a master server.
+     * Used for replication.
+     * If replication is not setup then returns default connection's database connection.
+     */
+    async obtainMasterConnection() {
+        const pool = this.master;
+        if (!pool) {
+            throw new TypeORMError("Driver not Connected");
+        }
+        try {
+            return await promisify(pool.getConnection).call(pool);
+        }
+        catch (error) {
+            this.poolErrorHandler(error);
+            throw error;
+        }
+    }
+    /**
+     * Obtains a new database connection to a slave server.
+     * Used for replication.
+     * If replication is not setup then returns master (default) connection's database connection.
+     */
+    async obtainSlaveConnection() {
+        return this.obtainMasterConnection();
     }
     /**
      * Creates a schema builder used to build and sync a schema.
@@ -553,25 +586,6 @@ export class SapDriver {
             type += " array";
         return type;
     }
-    /**
-     * Obtains a new database connection to a master server.
-     * Used for replication.
-     * If replication is not setup then returns default connection's database connection.
-     */
-    obtainMasterConnection() {
-        if (!this.master) {
-            throw new TypeORMError("Driver not Connected");
-        }
-        return this.master.getConnection();
-    }
-    /**
-     * Obtains a new database connection to a slave server.
-     * Used for replication.
-     * If replication is not setup then returns master (default) connection's database connection.
-     */
-    obtainSlaveConnection() {
-        return this.obtainMasterConnection();
-    }
     /**
      * Creates generated map of values generated or returned by database after INSERT query.
      */
@@ -651,21 +665,16 @@ export class SapDriver {
      * If driver dependency is not given explicitly, then try to load it via "require".
      */
     loadDependencies() {
-        try {
-            const client = this.options.driver || PlatformTools.load("hdb-pool");
+        const client = this.options.driver ?? this.options.hanaClientDriver;
+        if (client) {
             this.client = client;
-        }
-        catch (e) {
-            // todo: better error for browser env
-            throw new DriverPackageNotInstalledError("SAP Hana", "hdb-pool");
+            return;
         }
         try {
-            if (!this.options.hanaClientDriver) {
-                PlatformTools.load("@sap/hana-client");
-                this.streamClient = PlatformTools.load("@sap/hana-client/extension/Stream");
-            }
+            this.client = PlatformTools.load("@sap/hana-client");
+            this.streamClient = PlatformTools.load("@sap/hana-client/extension/Stream");
         }
-        catch (e) {
+        catch {
             // todo: better error for browser env
             throw new DriverPackageNotInstalledError("SAP Hana", "@sap/hana-client");
         }