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

package/driver/cockroachdb/CockroachDriver.d.ts

@@ -1,31 +1,37 @@
-import { ObjectLiteral } from "../../common/ObjectLiteral";
-import { DataSource } from "../../data-source/DataSource";
-import { ColumnMetadata } from "../../metadata/ColumnMetadata";
-import { EntityMetadata } from "../../metadata/EntityMetadata";
-import { QueryRunner } from "../../query-runner/QueryRunner";
+import type { ObjectLiteral } from "../../common/ObjectLiteral";
+import type { DataSource } from "../../data-source/DataSource";
+import type { ColumnMetadata } from "../../metadata/ColumnMetadata";
+import type { EntityMetadata } from "../../metadata/EntityMetadata";
+import type { QueryRunner } from "../../query-runner/QueryRunner";
 import { RdbmsSchemaBuilder } from "../../schema-builder/RdbmsSchemaBuilder";
-import { Table } from "../../schema-builder/table/Table";
-import { TableColumn } from "../../schema-builder/table/TableColumn";
-import { TableForeignKey } from "../../schema-builder/table/TableForeignKey";
-import { View } from "../../schema-builder/view/View";
-import { Driver } from "../Driver";
-import { ColumnType } from "../types/ColumnTypes";
-import { CteCapabilities } from "../types/CteCapabilities";
-import { DataTypeDefaults } from "../types/DataTypeDefaults";
-import { MappedColumnTypes } from "../types/MappedColumnTypes";
-import { ReplicationMode } from "../types/ReplicationMode";
-import { UpsertType } from "../types/UpsertType";
-import { CockroachConnectionCredentialsOptions } from "./CockroachConnectionCredentialsOptions";
-import { CockroachConnectionOptions } from "./CockroachConnectionOptions";
+import type { Table } from "../../schema-builder/table/Table";
+import type { TableColumn } from "../../schema-builder/table/TableColumn";
+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 type { CockroachConnectionCredentialsOptions } from "./CockroachConnectionCredentialsOptions";
+import type { CockroachDataSourceOptions } from "./CockroachDataSourceOptions";
 import { CockroachQueryRunner } from "./CockroachQueryRunner";
 /**
  * Organizes communication with Cockroach DBMS.
  */
 export declare class CockroachDriver implements Driver {
     /**
-     * Connection used by driver.
+     * DataSource used by the driver.
      */
-    connection: DataSource;
+    readonly dataSource: DataSource;
+    /**
+     * DataSource used by the driver.
+     * @deprecated since 1.0.0. Use {@link dataSource} instance instead.
+     */
+    get connection(): DataSource;
     /**
      * Cockroach underlying library.
      */
@@ -44,9 +50,9 @@ export declare class CockroachDriver implements Driver {
      */
     connectedQueryRunners: QueryRunner[];
     /**
-     * Connection options.
+     * DataSource options.
      */
-    options: CockroachConnectionOptions;
+    options: CockroachDataSourceOptions;
     /**
      * Database name used to perform all write queries.
      */
@@ -78,7 +84,6 @@ export declare class CockroachDriver implements Driver {
     transactionSupport: "nested";
     /**
      * Gets list of supported column data types by a driver.
-     *
      * @see https://www.cockroachlabs.com/docs/stable/data-types.html
      */
     supportedDataTypes: ColumnType[];
@@ -122,7 +127,7 @@ export declare class CockroachDriver implements Driver {
      */
     maxAliasLength?: number;
     cteCapabilities: CteCapabilities;
-    constructor(connection: DataSource);
+    constructor(dataSource: DataSource);
     /**
      * Performs connection to the database.
      * Based on pooling options, it can either create connection immediately,
@@ -143,32 +148,43 @@ export declare class CockroachDriver implements Driver {
     createSchemaBuilder(): RdbmsSchemaBuilder;
     /**
      * Creates a query runner used to execute database queries.
+     * @param mode
      */
     createQueryRunner(mode: ReplicationMode): CockroachQueryRunner;
     /**
      * 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;
     /**
      * 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 schema name and table name.
      * E.g. myDB.mySchema.myTable
+     * @param tableName
+     * @param schema
      */
     buildTableName(tableName: string, schema?: 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;
@@ -177,6 +193,14 @@ export declare class CockroachDriver implements Driver {
     };
     /**
      * Creates a database type from a given column metadata.
+     * @param column
+     * @param column.type
+     * @param column.length
+     * @param column.precision
+     * @param column.scale
+     * @param column.isArray
+     * @param column.isGenerated
+     * @param column.generationStrategy
      */
     normalizeType(column: {
         type?: ColumnType;
@@ -189,18 +213,34 @@ export declare class CockroachDriver implements Driver {
     }): string;
     /**
      * Normalizes "default" value of the column.
+     * @param columnMetadata
      */
     normalizeDefault(columnMetadata: ColumnMetadata): string | undefined;
+    /**
+     * Compares "default" value of the column.
+     * @param columnMetadata
+     * @param tableColumn
+     */
+    private defaultEqual;
+    /**
+     * Compares json/jsonb default values of the column.
+     * @param columnMetadata
+     * @param tableColumn
+     */
+    private compareJsonDefaults;
     /**
      * 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): string;
     /**
      * Creates column type definition including length, precision and scale
+     * @param column
      */
     createFullType(column: TableColumn): string;
     /**
@@ -219,18 +259,23 @@ export declare class CockroachDriver implements Driver {
      * Creates generated map of values generated or returned by database after INSERT query.
      *
      * todo: slow. optimize Object.keys(), OrmUtils.mergeDeep and column.createValueMap parts
+     * @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[];
     private lowerDefaultValueIfNecessary;
     /**
      * 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.
      */
@@ -241,6 +286,8 @@ export declare class CockroachDriver implements Driver {
     isFullTextColumnTypeSupported(): boolean;
     /**
      * Creates an escaped parameter.
+     * @param parameterName
+     * @param index
      */
     createParameter(parameterName: string, index: number): string;
     /**
@@ -253,18 +300,23 @@ export declare class CockroachDriver implements Driver {
     protected loadDependencies(): void;
     /**
      * Creates a new connection pool for a given database credentials.
+     * @param options
+     * @param credentials
      */
-    protected createPool(options: CockroachConnectionOptions, credentials: CockroachConnectionCredentialsOptions): Promise<any>;
+    protected createPool(options: CockroachDataSourceOptions, credentials: CockroachConnectionCredentialsOptions): Promise<any>;
     /**
      * Closes connection pool.
+     * @param pool
      */
     protected closePool(pool: any): Promise<void>;
     /**
      * Escapes a given comment.
+     * @param comment
      */
     protected escapeComment(comment?: string): string | undefined;
     /**
      * Builds ENUM type name from given table and column.
+     * @param column
      */
     protected buildEnumName(column: ColumnMetadata): string;
 }

package/driver/cockroachdb/CockroachDriver.js

@@ -17,10 +17,17 @@ const CockroachQueryRunner_1 = require("./CockroachQueryRunner");
  * Organizes communication with Cockroach DBMS.
  */
 class CockroachDriver {
+    /**
+     * 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.
@@ -44,7 +51,6 @@ class CockroachDriver {
         this.transactionSupport = "nested";
         /**
          * Gets list of supported column data types by a driver.
-         *
          * @see https://www.cockroachlabs.com/docs/stable/data-types.html
          */
         this.supportedDataTypes = [
@@ -169,8 +175,8 @@ class CockroachDriver {
             materializedHint: true,
             requiresRecursiveHint: true,
         };
-        this.connection = connection;
-        this.options = connection.options;
+        this.dataSource = dataSource;
+        this.options = dataSource.options;
         this.isReplicated = this.options.replication ? true : false;
         // load postgres package
         this.loadDependencies();
@@ -226,10 +232,10 @@ class CockroachDriver {
     async afterConnect() {
         // enable time travel queries
         if (this.options.timeTravelQueries) {
-            await this.connection.query(`SET default_transaction_use_follower_reads = 'on';`);
+            await this.dataSource.query(`SET default_transaction_use_follower_reads = 'on';`);
         }
         // enable experimental alter column type support (we need it to alter enum types)
-        await this.connection.query("SET enable_experimental_alter_column_type_general = true");
+        await this.dataSource.query("SET enable_experimental_alter_column_type_general = true");
         return Promise.resolve();
     }
     /**
@@ -248,16 +254,19 @@ class CockroachDriver {
      * 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 CockroachQueryRunner_1.CockroachQueryRunner(this, mode);
     }
     /**
      * 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)
@@ -296,6 +305,8 @@ class CockroachDriver {
     }
     /**
      * 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)
@@ -375,9 +386,11 @@ class CockroachDriver {
     /**
      * 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();
@@ -408,13 +421,16 @@ class CockroachDriver {
     }
     /**
      * Escapes a column name.
+     * @param columnName
      */
     escape(columnName) {
-        return '"' + columnName + '"';
+        return `"${columnName.replaceAll('"', '""')}"`;
     }
     /**
      * Build full table name with schema name and table name.
      * E.g. myDB.mySchema.myTable
+     * @param tableName
+     * @param schema
      */
     buildTableName(tableName, schema) {
         const tablePath = [tableName];
@@ -425,6 +441,7 @@ class CockroachDriver {
     }
     /**
      * Parse a target table name or other types and return a normalized table definition.
+     * @param target
      */
     parseTableName(target) {
         const driverDatabase = this.database;
@@ -466,6 +483,14 @@ class CockroachDriver {
     }
     /**
      * Creates a database type from a given column metadata.
+     * @param column
+     * @param column.type
+     * @param column.length
+     * @param column.precision
+     * @param column.scale
+     * @param column.isArray
+     * @param column.isGenerated
+     * @param column.generationStrategy
      */
     normalizeType(column) {
         if (column.type === Number ||
@@ -529,6 +554,7 @@ class CockroachDriver {
     }
     /**
      * Normalizes "default" value of the column.
+     * @param columnMetadata
      */
     normalizeDefault(columnMetadata) {
         const defaultValue = columnMetadata.default;
@@ -583,24 +609,80 @@ class CockroachDriver {
             return `'${defaultValue}'${arrayCast}`;
         }
         if (ObjectUtils_1.ObjectUtils.isObject(defaultValue) && defaultValue !== null) {
-            return `'${JSON.stringify(defaultValue)}'`;
+            return `'${JSON.stringify(defaultValue).replaceAll("'", "''")}'`;
         }
         return `${defaultValue}`;
     }
+    /**
+     * Compares "default" value of the column.
+     * @param columnMetadata
+     * @param tableColumn
+     */
+    defaultEqual(columnMetadata, tableColumn) {
+        // defaults are equal if both are undefined or null
+        if ((columnMetadata.default === null ||
+            columnMetadata.default === undefined) &&
+            (tableColumn.default === null || tableColumn.default === undefined))
+            return true;
+        if (["json", "jsonb"].includes(columnMetadata.type) &&
+            !["function", "undefined"].includes(typeof columnMetadata.default)) {
+            return this.compareJsonDefaults(columnMetadata, tableColumn);
+        }
+        const columnDefault = this.lowerDefaultValueIfNecessary(this.normalizeDefault(columnMetadata));
+        return columnDefault === tableColumn.default;
+    }
+    /**
+     * Compares json/jsonb default values of the column.
+     * @param columnMetadata
+     * @param tableColumn
+     */
+    compareJsonDefaults(columnMetadata, tableColumn) {
+        let jsonString = tableColumn.default;
+        if (typeof jsonString === "string") {
+            jsonString = jsonString.trim();
+            if (jsonString.startsWith("e'") && // CockroachDB might escape JSON/JSONB default values with e'...'
+                jsonString.endsWith("'")) {
+                jsonString = jsonString
+                    .slice(2, -1)
+                    .replaceAll(String.raw `\'`, "'");
+            }
+            else if (jsonString.startsWith("'") && jsonString.endsWith("'")) {
+                jsonString = jsonString.slice(1, -1).replaceAll("''", "'");
+            }
+        }
+        if (typeof jsonString === "string") {
+            try {
+                const tableColumnDefaultParsed = JSON.parse(jsonString);
+                return OrmUtils_1.OrmUtils.deepCompare(columnMetadata.default, tableColumnDefaultParsed);
+            }
+            catch (err) {
+                if (!(err instanceof SyntaxError)) {
+                    throw new error_1.TypeORMError(`Failed to compare default values of ${columnMetadata.propertyName} column`);
+                }
+            }
+        }
+        else {
+            return OrmUtils_1.OrmUtils.deepCompare(columnMetadata.default, jsonString);
+        }
+        return false;
+    }
     /**
      * 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) {
         return column.length ? column.length.toString() : "";
     }
     /**
      * Creates column type definition including length, precision and scale
+     * @param column
      */
     createFullType(column) {
         let type = column.type;
@@ -643,7 +725,12 @@ class CockroachDriver {
         }
         return new Promise((ok, fail) => {
             this.master.connect((err, connection, release) => {
-                err ? fail(err) : ok([connection, release]);
+                if (err) {
+                    fail(err);
+                }
+                else {
+                    ok([connection, release]);
+                }
             });
         });
     }
@@ -658,7 +745,12 @@ class CockroachDriver {
         const random = Math.floor(Math.random() * this.slaves.length);
         return new Promise((ok, fail) => {
             this.slaves[random].connect((err, connection, release) => {
-                err ? fail(err) : ok([connection, release]);
+                if (err) {
+                    fail(err);
+                }
+                else {
+                    ok([connection, release]);
+                }
             });
         });
     }
@@ -666,6 +758,8 @@ class CockroachDriver {
      * Creates generated map of values generated or returned by database after INSERT query.
      *
      * todo: slow. optimize Object.keys(), OrmUtils.mergeDeep and column.createValueMap parts
+     * @param metadata
+     * @param insertResult
      */
     createGeneratedMap(metadata, insertResult) {
         if (!insertResult)
@@ -681,39 +775,14 @@ class CockroachDriver {
     /**
      * 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) => {
             const tableColumn = tableColumns.find((c) => c.name === columnMetadata.databaseName);
             if (!tableColumn)
                 return false; // we don't need new columns, we only need exist and changed
-            // console.log("table:", columnMetadata.entityMetadata.tableName)
-            // console.log("name:", {
-            //     tableColumn: tableColumn.name,
-            //     columnMetadata: columnMetadata.databaseName,
-            // })
-            // console.log("type:", {
-            //     tableColumn: tableColumn.type,
-            //     columnMetadata: this.normalizeType(columnMetadata),
-            // })
-            // console.log("length:", {
-            //     tableColumn: tableColumn.length,
-            //     columnMetadata: columnMetadata.length,
-            // })
-            // console.log("width:", tableColumn.width, columnMetadata.width);
-            // console.log("precision:", tableColumn.precision, columnMetadata.precision);
-            // console.log("scale:", tableColumn.scale, columnMetadata.scale);
-            // console.log("comment:", tableColumn.comment, this.escapeComment(columnMetadata.comment));
-            // console.log("default:", tableColumn.default, columnMetadata.default);
-            // console.log("default changed:", !this.compareDefaultValues(this.normalizeDefault(columnMetadata), tableColumn.default));
-            // console.log("isPrimary:", tableColumn.isPrimary, columnMetadata.isPrimary);
-            // console.log("isNullable:", tableColumn.isNullable, columnMetadata.isNullable);
-            // console.log("isUnique:", tableColumn.isUnique, this.normalizeIsUnique(columnMetadata));
-            // console.log("asExpression:", {
-            //     tableColumn: (tableColumn.asExpression || "").trim(),
-            //     columnMetadata: (columnMetadata.asExpression || "").trim(),
-            // })
-            // console.log("==========================================");
             return (tableColumn.name !== columnMetadata.databaseName ||
                 tableColumn.type !== this.normalizeType(columnMetadata) ||
                 tableColumn.length !== columnMetadata.length ||
@@ -724,7 +793,7 @@ class CockroachDriver {
                 tableColumn.comment !==
                     this.escapeComment(columnMetadata.comment) ||
                 (!tableColumn.isGenerated &&
-                    this.lowerDefaultValueIfNecessary(this.normalizeDefault(columnMetadata)) !== tableColumn.default) || // we included check for generated here, because generated columns already can have default values
+                    !this.defaultEqual(columnMetadata, tableColumn)) || // we included check for generated here, because generated columns already can have default values
                 tableColumn.isPrimary !== columnMetadata.isPrimary ||
                 tableColumn.isNullable !== columnMetadata.isNullable ||
                 tableColumn.isUnique !==
@@ -755,8 +824,9 @@ class CockroachDriver {
     }
     /**
      * Returns true if driver supports RETURNING / OUTPUT statement.
+     * @param _returningType
      */
-    isReturningSqlSupported() {
+    isReturningSqlSupported(_returningType) {
         return true;
     }
     /**
@@ -773,6 +843,8 @@ class CockroachDriver {
     }
     /**
      * Creates an escaped parameter.
+     * @param parameterName
+     * @param index
      */
     createParameter(parameterName, index) {
         return this.parametersPrefix + (index + 1);
@@ -816,6 +888,8 @@ class CockroachDriver {
     }
     /**
      * Creates a new connection pool for a given database credentials.
+     * @param options
+     * @param credentials
      */
     async createPool(options, credentials) {
         credentials = Object.assign({}, credentials, DriverUtils_1.DriverUtils.buildDriverOptions(credentials)); // todo: do it better way
@@ -832,7 +906,7 @@ class CockroachDriver {
         }, options.extra || {});
         // create a connection pool
         const pool = new this.postgres.Pool(connectionOptions);
-        const { logger } = this.connection;
+        const { logger } = this.dataSource;
         const poolErrorHandler = options.poolErrorHandler ||
             ((error) => logger.log("warn", `Postgres pool raised an error. ${error}`));
         /*
@@ -851,6 +925,7 @@ class CockroachDriver {
     }
     /**
      * Closes connection pool.
+     * @param pool
      */
     async closePool(pool) {
         await Promise.all(this.connectedQueryRunners.map((queryRunner) => queryRunner.release()));
@@ -860,6 +935,7 @@ class CockroachDriver {
     }
     /**
      * Escapes a given comment.
+     * @param comment
      */
     escapeComment(comment) {
         if (!comment)
@@ -869,6 +945,7 @@ class CockroachDriver {
     }
     /**
      * Builds ENUM type name from given table and column.
+     * @param column
      */
     buildEnumName(column) {
         const { schema, tableName } = this.parseTableName(column.entityMetadata);
@@ -886,5 +963,4 @@ class CockroachDriver {
     }
 }
 exports.CockroachDriver = CockroachDriver;
-
-//# sourceMappingURL=CockroachDriver.js.map
+//# sourceMappingURL=CockroachDriver.js.map