typeorm 0.3.29-dev.cc07c90 → 1.0.0-beta.1

package/driver/sqlserver/SqlServerDriver.d.ts

@@ -1,32 +1,38 @@
-import { Driver } from "../Driver";
-import { CteCapabilities } from "../types/CteCapabilities";
-import { SqlServerQueryRunner } from "./SqlServerQueryRunner";
-import { ObjectLiteral } from "../../common/ObjectLiteral";
-import { ColumnMetadata } from "../../metadata/ColumnMetadata";
-import { DataSource } from "../../data-source/DataSource";
+import type { ObjectLiteral } from "../../common/ObjectLiteral";
+import type { DataSource } from "../../data-source/DataSource";
+import { FindOperator } from "../../find-options/FindOperator";
+import type { ColumnMetadata } from "../../metadata/ColumnMetadata";
+import type { EntityMetadata } from "../../metadata/EntityMetadata";
 import { RdbmsSchemaBuilder } from "../../schema-builder/RdbmsSchemaBuilder";
-import { SqlServerConnectionOptions } from "./SqlServerConnectionOptions";
-import { MappedColumnTypes } from "../types/MappedColumnTypes";
-import { ColumnType } from "../types/ColumnTypes";
-import { DataTypeDefaults } from "../types/DataTypeDefaults";
-import { MssqlParameter } from "./MssqlParameter";
+import type { Table } from "../../schema-builder/table/Table";
 import { TableColumn } from "../../schema-builder/table/TableColumn";
-import { SqlServerConnectionCredentialsOptions } from "./SqlServerConnectionCredentialsOptions";
-import { EntityMetadata } from "../../metadata/EntityMetadata";
-import { ReplicationMode } from "../types/ReplicationMode";
-import { Table } from "../../schema-builder/table/Table";
-import { View } from "../../schema-builder/view/View";
-import { TableForeignKey } from "../../schema-builder/table/TableForeignKey";
-import { UpsertType } from "../types/UpsertType";
-import { FindOperator } from "../../find-options/FindOperator";
+import type { TableForeignKey } from "../../schema-builder/table/TableForeignKey";
+import type { View } from "../../schema-builder/view/View";
+import type { Driver } from "../Driver";
+import type { ColumnType } from "../types/ColumnTypes";
+import type { CteCapabilities } from "../types/CteCapabilities";
+import type { DataTypeDefaults } from "../types/DataTypeDefaults";
+import type { MappedColumnTypes } from "../types/MappedColumnTypes";
+import type { ReplicationMode } from "../types/ReplicationMode";
+import type { ReturningType } from "../types/ReturningType";
+import type { UpsertType } from "../types/UpsertType";
+import { MssqlParameter } from "./MssqlParameter";
+import type { SqlServerConnectionCredentialsOptions } from "./SqlServerConnectionCredentialsOptions";
+import type { SqlServerDataSourceOptions } from "./SqlServerDataSourceOptions";
+import { SqlServerQueryRunner } from "./SqlServerQueryRunner";
 /**
  * Organizes communication with SQL Server DBMS.
  */
 export declare class SqlServerDriver implements Driver {
     /**
-     * Connection used by driver.
+     * DataSource used by the driver.
+     */
+    dataSource: DataSource;
+    /**
+     * DataSource used by the driver.
+     * @deprecated since 1.0.0. Use {@link dataSource} instance instead.
      */
-    connection: DataSource;
+    get connection(): DataSource;
     /**
      * SQL Server library.
      */
@@ -41,9 +47,9 @@ export declare class SqlServerDriver implements Driver {
      */
     slaves: any[];
     /**
-     * Connection options.
+     * DataSource options.
      */
-    options: SqlServerConnectionOptions;
+    options: SqlServerDataSourceOptions;
     /**
      * Database name used to perform all write queries.
      */
@@ -75,7 +81,6 @@ export declare class SqlServerDriver implements Driver {
     transactionSupport: "simple";
     /**
      * Gets list of supported column data types by a driver.
-     *
      * @see https://docs.microsoft.com/en-us/sql/t-sql/data-types/data-types-transact-sql
      */
     supportedDataTypes: ColumnType[];
@@ -119,7 +124,7 @@ export declare class SqlServerDriver implements Driver {
      * @see https://docs.microsoft.com/en-us/sql/sql-server/maximum-capacity-specifications-for-sql-server
      */
     maxAliasLength: number;
-    constructor(connection: DataSource);
+    constructor(dataSource: DataSource);
     /**
      * Performs connection to the database.
      * Based on pooling options, it can either create connection immediately,
@@ -136,6 +141,7 @@ export declare class SqlServerDriver implements Driver {
     disconnect(): Promise<void>;
     /**
      * Closes connection pool.
+     * @param pool
      */
     protected closePool(pool: any): Promise<void>;
     /**
@@ -144,24 +150,32 @@ export declare class SqlServerDriver implements Driver {
     createSchemaBuilder(): RdbmsSchemaBuilder;
     /**
      * Creates a query runner used to execute database queries.
+     * @param mode
      */
     createQueryRunner(mode: ReplicationMode): SqlServerQueryRunner;
     /**
      * Replaces parameters in the given sql with special escaping character
      * and an array of parameter names to be passed to a query.
+     * @param sql
+     * @param parameters
      */
-    escapeQueryWithParameters(sql: string, parameters: ObjectLiteral, nativeParameters: ObjectLiteral): [string, any[]];
+    escapeQueryWithParameters(sql: string, parameters: ObjectLiteral): [string, any[]];
     /**
      * Escapes a column name.
+     * @param columnName
      */
     escape(columnName: string): string;
     /**
      * Build full table name with database name, schema name and table name.
      * E.g. myDB.mySchema.myTable
+     * @param tableName
+     * @param schema
+     * @param database
      */
     buildTableName(tableName: string, schema?: string, database?: string): string;
     /**
      * Parse a target table name or other types and return a normalized table definition.
+     * @param target
      */
     parseTableName(target: EntityMetadata | Table | View | TableForeignKey | string): {
         database?: string;
@@ -170,14 +184,23 @@ export declare class SqlServerDriver implements Driver {
     };
     /**
      * Prepares given value to a value to be persisted, based on its column type and metadata.
+     * @param value
+     * @param columnMetadata
      */
     preparePersistentValue(value: any, columnMetadata: ColumnMetadata): any;
     /**
      * Prepares given value to a value to be persisted, based on its column type or metadata.
+     * @param value
+     * @param columnMetadata
      */
     prepareHydratedValue(value: any, columnMetadata: ColumnMetadata): any;
     /**
      * Creates a database type from a given column metadata.
+     * @param column
+     * @param column.type
+     * @param column.length
+     * @param column.precision
+     * @param column.scale
      */
     normalizeType(column: {
         type?: ColumnType;
@@ -187,18 +210,22 @@ export declare class SqlServerDriver implements Driver {
     }): string;
     /**
      * Normalizes "default" value of the column.
+     * @param columnMetadata
      */
     normalizeDefault(columnMetadata: ColumnMetadata): string | undefined;
     /**
      * Normalizes "isUnique" value of the column.
+     * @param column
      */
     normalizeIsUnique(column: ColumnMetadata): boolean;
     /**
      * Returns default column lengths, which is required on column creation.
+     * @param column
      */
     getColumnLength(column: ColumnMetadata | TableColumn): string;
     /**
      * Creates column type definition including length, precision and scale
+     * @param column
      */
     createFullType(column: TableColumn): string;
     /**
@@ -215,17 +242,22 @@ export declare class SqlServerDriver implements Driver {
     obtainSlaveConnection(): Promise<any>;
     /**
      * Creates generated map of values generated or returned by database after INSERT query.
+     * @param metadata
+     * @param insertResult
      */
     createGeneratedMap(metadata: EntityMetadata, insertResult: ObjectLiteral): ObjectLiteral | undefined;
     /**
      * Differentiate columns of this table and columns from the given column metadatas columns
      * and returns only changed.
+     * @param tableColumns
+     * @param columnMetadatas
      */
     findChangedColumns(tableColumns: TableColumn[], columnMetadatas: ColumnMetadata[]): ColumnMetadata[];
     /**
      * Returns true if driver supports RETURNING / OUTPUT statement.
+     * @param returningType
      */
-    isReturningSqlSupported(): boolean;
+    isReturningSqlSupported(returningType: ReturningType): boolean;
     /**
      * Returns true if driver supports uuid values generation on its own.
      */
@@ -236,11 +268,15 @@ export declare class SqlServerDriver implements Driver {
     isFullTextColumnTypeSupported(): boolean;
     /**
      * Creates an escaped parameter.
+     * @param parameterName
+     * @param index
      */
     createParameter(parameterName: string, index: number): string;
     /**
      * Sql server's parameters needs to be wrapped into special object with type information about this value.
      * This method wraps given value into MssqlParameter based on its column definition.
+     * @param column
+     * @param value
      */
     parametrizeValue(column: ColumnMetadata, value: any): MssqlParameter;
     /**
@@ -253,11 +289,15 @@ export declare class SqlServerDriver implements Driver {
      *
      * This ensures SQL Server receives properly typed parameters for queries involving operators like
      * In, MoreThan, Between, etc.
+     * @param column
+     * @param value
      */
     parametrizeValues(column: ColumnMetadata, value: any): FindOperator<any> | MssqlParameter;
     /**
      * Sql server's parameters needs to be wrapped into special object with type information about this value.
      * This method wraps all values of the given object into MssqlParameter based on their column definitions in the given table.
+     * @param tablePath
+     * @param map
      */
     parametrizeMap(tablePath: string, map: ObjectLiteral): ObjectLiteral;
     buildTableVariableDeclaration(identifier: string, columns: ColumnMetadata[]): string;
@@ -270,6 +310,8 @@ export declare class SqlServerDriver implements Driver {
     protected lowerDefaultValueIfNecessary(value: string | undefined): string | undefined;
     /**
      * Creates a new connection pool for a given database credentials.
+     * @param options
+     * @param credentials
      */
-    protected createPool(options: SqlServerConnectionOptions, credentials: SqlServerConnectionCredentialsOptions): Promise<any>;
+    protected createPool(options: SqlServerDataSourceOptions, credentials: SqlServerConnectionCredentialsOptions): Promise<any>;
 }

package/driver/sqlserver/SqlServerDriver.js

@@ -1,28 +1,35 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SqlServerDriver = void 0;
+const error_1 = require("../../error");
 const ConnectionIsNotSetError_1 = require("../../error/ConnectionIsNotSetError");
 const DriverPackageNotInstalledError_1 = require("../../error/DriverPackageNotInstalledError");
-const DriverUtils_1 = require("../DriverUtils");
-const SqlServerQueryRunner_1 = require("./SqlServerQueryRunner");
-const DateUtils_1 = require("../../util/DateUtils");
+const FindOperator_1 = require("../../find-options/FindOperator");
 const PlatformTools_1 = require("../../platform/PlatformTools");
 const RdbmsSchemaBuilder_1 = require("../../schema-builder/RdbmsSchemaBuilder");
-const MssqlParameter_1 = require("./MssqlParameter");
 const TableColumn_1 = require("../../schema-builder/table/TableColumn");
-const OrmUtils_1 = require("../../util/OrmUtils");
 const ApplyValueTransformers_1 = require("../../util/ApplyValueTransformers");
-const error_1 = require("../../error");
+const DateUtils_1 = require("../../util/DateUtils");
 const InstanceChecker_1 = require("../../util/InstanceChecker");
-const FindOperator_1 = require("../../find-options/FindOperator");
+const OrmUtils_1 = require("../../util/OrmUtils");
+const DriverUtils_1 = require("../DriverUtils");
+const MssqlParameter_1 = require("./MssqlParameter");
+const SqlServerQueryRunner_1 = require("./SqlServerQueryRunner");
 /**
  * Organizes communication with SQL Server DBMS.
  */
 class SqlServerDriver {
+    /**
+     * DataSource used by the driver.
+     * @deprecated since 1.0.0. Use {@link dataSource} instance instead.
+     */
+    get connection() {
+        return this.dataSource;
+    }
     // -------------------------------------------------------------------------
     // Constructor
     // -------------------------------------------------------------------------
-    constructor(connection) {
+    constructor(dataSource) {
         /**
          * Pool for slave databases.
          * Used in replication.
@@ -42,7 +49,6 @@ class SqlServerDriver {
         this.transactionSupport = "simple";
         /**
          * Gets list of supported column data types by a driver.
-         *
          * @see https://docs.microsoft.com/en-us/sql/t-sql/data-types/data-types-transact-sql
          */
         this.supportedDataTypes = [
@@ -177,8 +183,8 @@ class SqlServerDriver {
          * @see https://docs.microsoft.com/en-us/sql/sql-server/maximum-capacity-specifications-for-sql-server
          */
         this.maxAliasLength = 128;
-        this.connection = connection;
-        this.options = connection.options;
+        this.dataSource = dataSource;
+        this.options = dataSource.options;
         this.isReplicated = this.options.replication ? true : false;
         // load mssql package
         this.loadDependencies();
@@ -247,6 +253,7 @@ class SqlServerDriver {
     }
     /**
      * Closes connection pool.
+     * @param pool
      */
     async closePool(pool) {
         return new Promise((ok, fail) => {
@@ -257,10 +264,11 @@ class SqlServerDriver {
      * Creates a schema builder used to build and sync a schema.
      */
     createSchemaBuilder() {
-        return new RdbmsSchemaBuilder_1.RdbmsSchemaBuilder(this.connection);
+        return new RdbmsSchemaBuilder_1.RdbmsSchemaBuilder(this.dataSource);
     }
     /**
      * Creates a query runner used to execute database queries.
+     * @param mode
      */
     createQueryRunner(mode) {
         return new SqlServerQueryRunner_1.SqlServerQueryRunner(this, mode);
@@ -268,9 +276,11 @@ class SqlServerDriver {
     /**
      * Replaces parameters in the given sql with special escaping character
      * and an array of parameter names to be passed to a query.
+     * @param sql
+     * @param parameters
      */
-    escapeQueryWithParameters(sql, parameters, nativeParameters) {
-        const escapedParameters = Object.keys(nativeParameters).map((key) => nativeParameters[key]);
+    escapeQueryWithParameters(sql, parameters) {
+        const escapedParameters = [];
         if (!parameters || !Object.keys(parameters).length)
             return [sql, escapedParameters];
         const parameterIndexMap = new Map();
@@ -301,13 +311,17 @@ class SqlServerDriver {
     }
     /**
      * Escapes a column name.
+     * @param columnName
      */
     escape(columnName) {
-        return `"${columnName}"`;
+        return `"${columnName.replaceAll('"', '""')}"`;
     }
     /**
      * Build full table name with database name, schema name and table name.
      * E.g. myDB.mySchema.myTable
+     * @param tableName
+     * @param schema
+     * @param database
      */
     buildTableName(tableName, schema, database) {
         const tablePath = [tableName];
@@ -324,6 +338,7 @@ class SqlServerDriver {
     }
     /**
      * Parse a target table name or other types and return a normalized table definition.
+     * @param target
      */
     parseTableName(target) {
         const driverDatabase = this.database;
@@ -379,6 +394,8 @@ class SqlServerDriver {
     }
     /**
      * Prepares given value to a value to be persisted, based on its column type and metadata.
+     * @param value
+     * @param columnMetadata
      */
     preparePersistentValue(value, columnMetadata) {
         if (columnMetadata.transformer)
@@ -424,6 +441,8 @@ class SqlServerDriver {
     }
     /**
      * Prepares given value to a value to be persisted, based on its column type or metadata.
+     * @param value
+     * @param columnMetadata
      */
     prepareHydratedValue(value, columnMetadata) {
         if (value === null || value === undefined)
@@ -477,6 +496,11 @@ class SqlServerDriver {
     }
     /**
      * Creates a database type from a given column metadata.
+     * @param column
+     * @param column.type
+     * @param column.length
+     * @param column.precision
+     * @param column.scale
      */
     normalizeType(column) {
         if (column.type === Number || column.type === "integer") {
@@ -491,7 +515,8 @@ class SqlServerDriver {
         else if (column.type === Boolean) {
             return "bit";
         }
-        else if (column.type === Buffer) {
+        else if (typeof column.type === "function" &&
+            column.type.prototype instanceof Uint8Array) {
             return "binary";
         }
         else if (column.type === "uuid") {
@@ -519,6 +544,7 @@ class SqlServerDriver {
     }
     /**
      * Normalizes "default" value of the column.
+     * @param columnMetadata
      */
     normalizeDefault(columnMetadata) {
         const defaultValue = columnMetadata.default;
@@ -545,12 +571,14 @@ class SqlServerDriver {
     }
     /**
      * Normalizes "isUnique" value of the column.
+     * @param column
      */
     normalizeIsUnique(column) {
         return column.entityMetadata.uniques.some((uq) => uq.columns.length === 1 && uq.columns[0] === column);
     }
     /**
      * Returns default column lengths, which is required on column creation.
+     * @param column
      */
     getColumnLength(column) {
         if (column.length)
@@ -563,6 +591,7 @@ class SqlServerDriver {
     }
     /**
      * Creates column type definition including length, precision and scale
+     * @param column
      */
     createFullType(column) {
         // The Database Engine determines the data type of the computed column by applying the rules
@@ -616,6 +645,8 @@ class SqlServerDriver {
     }
     /**
      * Creates generated map of values generated or returned by database after INSERT query.
+     * @param metadata
+     * @param insertResult
      */
     createGeneratedMap(metadata, insertResult) {
         if (!insertResult)
@@ -631,6 +662,8 @@ class SqlServerDriver {
     /**
      * Differentiate columns of this table and columns from the given column metadatas columns
      * and returns only changed.
+     * @param tableColumns
+     * @param columnMetadatas
      */
     findChangedColumns(tableColumns, columnMetadatas) {
         return columnMetadatas.filter((columnMetadata) => {
@@ -729,8 +762,9 @@ class SqlServerDriver {
     }
     /**
      * Returns true if driver supports RETURNING / OUTPUT statement.
+     * @param returningType
      */
-    isReturningSqlSupported() {
+    isReturningSqlSupported(returningType) {
         if (this.options.options &&
             this.options.options.disableOutputReturning) {
             return false;
@@ -751,6 +785,8 @@ class SqlServerDriver {
     }
     /**
      * Creates an escaped parameter.
+     * @param parameterName
+     * @param index
      */
     createParameter(parameterName, index) {
         return this.parametersPrefix + index;
@@ -761,6 +797,8 @@ class SqlServerDriver {
     /**
      * Sql server's parameters needs to be wrapped into special object with type information about this value.
      * This method wraps given value into MssqlParameter based on its column definition.
+     * @param column
+     * @param value
      */
     parametrizeValue(column, value) {
         // if its already MssqlParameter then simply return it
@@ -795,6 +833,8 @@ class SqlServerDriver {
      *
      * This ensures SQL Server receives properly typed parameters for queries involving operators like
      * In, MoreThan, Between, etc.
+     * @param column
+     * @param value
      */
     parametrizeValues(column, value) {
         if (value instanceof FindOperator_1.FindOperator) {
@@ -811,13 +851,15 @@ class SqlServerDriver {
     /**
      * Sql server's parameters needs to be wrapped into special object with type information about this value.
      * This method wraps all values of the given object into MssqlParameter based on their column definitions in the given table.
+     * @param tablePath
+     * @param map
      */
     parametrizeMap(tablePath, map) {
         // find metadata for the given table
-        if (!this.connection.hasMetadata(tablePath))
+        if (!this.dataSource.hasMetadata(tablePath))
             // if no metadata found then we can't proceed because we don't have columns and their types
             return map;
-        const metadata = this.connection.getMetadata(tablePath);
+        const metadata = this.dataSource.getMetadata(tablePath);
         return Object.keys(map).reduce((newMap, key) => {
             const value = map[key];
             // find column metadata
@@ -886,20 +928,11 @@ class SqlServerDriver {
     }
     /**
      * Creates a new connection pool for a given database credentials.
+     * @param options
+     * @param credentials
      */
     createPool(options, credentials) {
         credentials = Object.assign({}, credentials, DriverUtils_1.DriverUtils.buildDriverOptions(credentials)); // todo: do it better way
-        // todo: credentials.domain is deprecation. remove it in future
-        const authentication = !credentials.domain
-            ? credentials.authentication
-            : {
-                type: "ntlm",
-                options: {
-                    domain: credentials.domain,
-                    userName: credentials.username,
-                    password: credentials.password,
-                },
-            };
         // build connection options for the driver
         const connectionOptions = Object.assign({}, {
             connectionTimeout: this.options.connectionTimeout,
@@ -913,7 +946,7 @@ class SqlServerDriver {
             port: credentials.port,
             user: credentials.username,
             password: credentials.password,
-            authentication: authentication,
+            authentication: credentials.authentication,
         }, options.extra || {});
         // set default useUTC option if it hasn't been set
         if (!connectionOptions.options) {
@@ -929,7 +962,7 @@ class SqlServerDriver {
         // either when its not defined at all (e.g. enabled by default)
         return new Promise((ok, fail) => {
             const pool = new this.mssql.ConnectionPool(connectionOptions);
-            const { logger } = this.connection;
+            const { logger } = this.dataSource;
             const poolErrorHandler = (options.pool && options.pool.errorHandler) ||
                 ((error) => logger.log("warn", `MSSQL pool raised an error. ${error}`));
             /**
@@ -946,5 +979,4 @@ class SqlServerDriver {
     }
 }
 exports.SqlServerDriver = SqlServerDriver;
-
-//# sourceMappingURL=SqlServerDriver.js.map
+//# sourceMappingURL=SqlServerDriver.js.map