@lakutata/orm 3.0.0 → 3.1.0

package/dist/vendor/typeorm/driver/spanner/SpannerDriver.js

@@ -0,0 +1,673 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SpannerDriver = void 0;
+const DriverPackageNotInstalledError_1 = require("../../error/DriverPackageNotInstalledError");
+const EntityMetadata_1 = require("../../metadata/EntityMetadata");
+const PlatformTools_1 = require("../../platform/PlatformTools");
+const RdbmsSchemaBuilder_1 = require("../../schema-builder/RdbmsSchemaBuilder");
+const Table_1 = require("../../schema-builder/table/Table");
+const TableForeignKey_1 = require("../../schema-builder/table/TableForeignKey");
+const View_1 = require("../../schema-builder/view/View");
+const ApplyValueTransformers_1 = require("../../util/ApplyValueTransformers");
+const DateUtils_1 = require("../../util/DateUtils");
+const OrmUtils_1 = require("../../util/OrmUtils");
+const SpannerQueryRunner_1 = require("./SpannerQueryRunner");
+/**
+ * Organizes communication with Spanner DBMS.
+ */
+class SpannerDriver {
+    // -------------------------------------------------------------------------
+    // Static Properties
+    // -------------------------------------------------------------------------
+    /**
+     * Transaction isolation levels supported by this driver.
+     *
+     * @see https://cloud.google.com/spanner/docs/isolation-levels
+     */
+    static { this.supportedIsolationLevels = [
+        "REPEATABLE READ",
+        "SERIALIZABLE",
+    ]; }
+    /**
+     * DataSource used by the driver.
+     *
+     * @deprecated since 1.0.0. Use {@link dataSource} instance instead.
+     */
+    get connection() {
+        return this.dataSource;
+    }
+    // -------------------------------------------------------------------------
+    // Constructor
+    // -------------------------------------------------------------------------
+    constructor(dataSource) {
+        /**
+         * Isolation levels supported by this driver.
+         */
+        this.supportedIsolationLevels = SpannerDriver.supportedIsolationLevels;
+        /**
+         * Indicates if replication is enabled.
+         */
+        this.isReplicated = false;
+        /**
+         * Indicates if tree tables are supported by this driver.
+         */
+        this.treeSupport = true;
+        /**
+         * Represent transaction support by this driver
+         */
+        this.transactionSupport = "none";
+        /**
+         * Gets list of supported column data types by a driver.
+         *
+         * @see https://cloud.google.com/spanner/docs/reference/standard-sql/data-types
+         */
+        this.supportedDataTypes = [
+            "bool",
+            "int64",
+            "float64",
+            "numeric",
+            "string",
+            "json",
+            "bytes",
+            "date",
+            "timestamp",
+            "array",
+        ];
+        /**
+         * Returns type of upsert supported by driver if any
+         */
+        this.supportedUpsertTypes = [];
+        /**
+         * Gets list of spatial column data types.
+         */
+        this.spatialTypes = [];
+        /**
+         * Gets list of column data types that support length by a driver.
+         */
+        this.withLengthColumnTypes = ["string", "bytes"];
+        /**
+         * Gets list of column data types that support precision by a driver.
+         */
+        this.withPrecisionColumnTypes = [];
+        /**
+         * Gets list of column data types that supports scale by a driver.
+         */
+        this.withScaleColumnTypes = [];
+        /**
+         * ORM has special columns and we need to know what database column types should be for those columns.
+         * Column types are driver dependant.
+         */
+        this.mappedDataTypes = {
+            createDate: "timestamp",
+            createDateDefault: "",
+            updateDate: "timestamp",
+            updateDateDefault: "",
+            deleteDate: "timestamp",
+            deleteDateNullable: true,
+            version: "int64",
+            treeLevel: "int64",
+            migrationId: "int64",
+            migrationName: "string",
+            migrationTimestamp: "int64",
+            cacheId: "string",
+            cacheIdentifier: "string",
+            cacheTime: "int64",
+            cacheDuration: "int64",
+            cacheQuery: "string",
+            cacheResult: "string",
+            metadataType: "string",
+            metadataDatabase: "string",
+            metadataSchema: "string",
+            metadataTable: "string",
+            metadataName: "string",
+            metadataValue: "string",
+        };
+        /**
+         * The prefix used for the parameters
+         */
+        this.parametersPrefix = "@param";
+        /**
+         * Default values of length, precision and scale depends on column data type.
+         * Used in the cases when length/precision/scale is not specified by user.
+         */
+        this.dataTypeDefaults = {};
+        /**
+         * Max length allowed by MySQL for aliases.
+         *
+         * @see https://dev.mysql.com/doc/refman/5.5/en/identifiers.html
+         */
+        this.maxAliasLength = 63;
+        this.cteCapabilities = {
+            enabled: true,
+        };
+        this.dataSource = dataSource;
+        this.options = dataSource.options;
+        this.isReplicated = this.options.replication ? true : false;
+        // load mysql package
+        this.loadDependencies();
+    }
+    // -------------------------------------------------------------------------
+    // Public Methods
+    // -------------------------------------------------------------------------
+    /**
+     * Performs connection to the database.
+     */
+    async connect() {
+        this.instance = this.spanner.instance(this.options.instanceId);
+        this.instanceDatabase = this.instance.database(this.options.databaseId);
+    }
+    /**
+     * Makes any action after connection (e.g. create extensions in Postgres driver).
+     */
+    afterConnect() {
+        return Promise.resolve();
+    }
+    /**
+     * Closes connection with the database.
+     */
+    async disconnect() {
+        this.instanceDatabase.close();
+    }
+    /**
+     * Creates a schema builder used to build and sync a schema.
+     */
+    createSchemaBuilder() {
+        return new RdbmsSchemaBuilder_1.RdbmsSchemaBuilder(this.dataSource);
+    }
+    /**
+     * Creates a query runner used to execute database queries.
+     *
+     * @param mode
+     */
+    createQueryRunner(mode) {
+        return new SpannerQueryRunner_1.SpannerQueryRunner(this, mode);
+    }
+    /**
+     * 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) {
+        const escapedParameters = [];
+        if (!parameters || !Object.keys(parameters).length)
+            return [sql, escapedParameters];
+        const parameterIndexMap = new Map();
+        sql = sql.replaceAll(/:(\.\.\.)?([A-Za-z0-9_.]+)/g, (full, isArray, key) => {
+            if (!parameters.hasOwnProperty(key)) {
+                return full;
+            }
+            if (parameterIndexMap.has(key)) {
+                return this.parametersPrefix + parameterIndexMap.get(key);
+            }
+            const value = parameters[key];
+            if (value === null) {
+                return full;
+            }
+            if (isArray) {
+                return value
+                    .map((v) => {
+                    escapedParameters.push(v);
+                    return this.createParameter(key, escapedParameters.length - 1);
+                })
+                    .join(", ");
+            }
+            if (value instanceof Function) {
+                return value();
+            }
+            escapedParameters.push(value);
+            parameterIndexMap.set(key, escapedParameters.length - 1);
+            return this.createParameter(key, escapedParameters.length - 1);
+        }); // todo: make replace only in value statements, otherwise problems
+        sql = sql.replaceAll(/([ ]+)?=([ ]+)?:(\.\.\.)?([A-Za-z0-9_.]+)/g, (full, emptySpaceBefore, emptySpaceAfter, isArray, key) => {
+            if (!parameters.hasOwnProperty(key)) {
+                return full;
+            }
+            const value = parameters[key];
+            if (value === null) {
+                return " IS NULL";
+            }
+            return full;
+        });
+        return [sql, escapedParameters];
+    }
+    /**
+     * Escapes a column name.
+     *
+     * @param columnName
+     */
+    escape(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];
+        if (database) {
+            tablePath.unshift(database);
+        }
+        return tablePath.join(".");
+    }
+    /**
+     * Parse a target table name or other types and return a normalized table definition.
+     *
+     * @param target
+     */
+    parseTableName(target) {
+        const driverDatabase = this.database;
+        const driverSchema = undefined;
+        if (target instanceof Table_1.Table || target instanceof View_1.View) {
+            const parsed = this.parseTableName(target.name);
+            return {
+                database: target.database ?? parsed.database ?? driverDatabase,
+                schema: target.schema ?? parsed.schema ?? driverSchema,
+                tableName: parsed.tableName,
+            };
+        }
+        if (target instanceof TableForeignKey_1.TableForeignKey) {
+            const parsed = this.parseTableName(target.referencedTableName);
+            return {
+                database: target.referencedDatabase ??
+                    parsed.database ??
+                    driverDatabase,
+                schema: target.referencedSchema ?? parsed.schema ?? driverSchema,
+                tableName: parsed.tableName,
+            };
+        }
+        if (target instanceof EntityMetadata_1.EntityMetadata) {
+            // EntityMetadata tableName is never a path
+            return {
+                database: target.database ?? driverDatabase,
+                schema: target.schema ?? driverSchema,
+                tableName: target.tableName,
+            };
+        }
+        const parts = target.split(".");
+        return {
+            database: (parts.length > 1 ? parts[0] : undefined) ?? driverDatabase,
+            schema: driverSchema,
+            tableName: parts.length > 1 ? parts[1] : parts[0],
+        };
+    }
+    /**
+     * 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)
+            value = ApplyValueTransformers_1.ApplyValueTransformers.transformTo(columnMetadata.transformer, value);
+        if (value === null || value === undefined)
+            return value;
+        if (columnMetadata.type === "numeric") {
+            const lib = this.options.driver ??
+                PlatformTools_1.PlatformTools.load("@google-cloud/spanner");
+            return lib.Spanner.numeric(value.toString());
+        }
+        else if (columnMetadata.type === "date") {
+            return DateUtils_1.DateUtils.mixedDateToDateString(value, {
+                utc: columnMetadata.utc,
+            });
+        }
+        else if (columnMetadata.type === "json") {
+            return value;
+        }
+        else if (columnMetadata.type === "timestamp" ||
+            columnMetadata.type === Date) {
+            return DateUtils_1.DateUtils.mixedDateToDate(value);
+        }
+        return value;
+    }
+    /**
+     * 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)
+            return columnMetadata.transformer
+                ? ApplyValueTransformers_1.ApplyValueTransformers.transformFrom(columnMetadata.transformer, value)
+                : value;
+        if (columnMetadata.type === Boolean || columnMetadata.type === "bool") {
+            value = value ? true : false;
+        }
+        else if (columnMetadata.type === "timestamp" ||
+            columnMetadata.type === Date) {
+            value = new Date(value);
+        }
+        else if (columnMetadata.type === "numeric") {
+            value = value.value;
+        }
+        else if (columnMetadata.type === "date") {
+            value = DateUtils_1.DateUtils.mixedDateToDateString(value, {
+                utc: columnMetadata.utc,
+            });
+        }
+        else if (columnMetadata.type === "json") {
+            value = typeof value === "string" ? JSON.parse(value) : value;
+        }
+        else if (columnMetadata.type === Number) {
+            // convert to number if number
+            value = !isNaN(+value) ? parseInt(value) : value;
+        }
+        if (columnMetadata.transformer)
+            value = ApplyValueTransformers_1.ApplyValueTransformers.transformFrom(columnMetadata.transformer, value);
+        return value;
+    }
+    /**
+     * 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) {
+            return "int64";
+        }
+        else if (column.type === String || column.type === "uuid") {
+            return "string";
+        }
+        else if (column.type === Date) {
+            return "timestamp";
+        }
+        else if (typeof column.type === "function" &&
+            column.type.prototype instanceof Uint8Array) {
+            return "bytes";
+        }
+        else if (column.type === Boolean) {
+            return "bool";
+        }
+        else {
+            return column.type || "";
+        }
+    }
+    /**
+     * Normalizes "default" value of the column.
+     *
+     * Spanner does not support default values.
+     *
+     * @param columnMetadata
+     */
+    normalizeDefault(columnMetadata) {
+        return columnMetadata.default === ""
+            ? `"${columnMetadata.default}"`
+            : `${columnMetadata.default}`;
+    }
+    /**
+     * Normalizes "isUnique" value of the column.
+     *
+     * @param column
+     */
+    normalizeIsUnique(column) {
+        return column.entityMetadata.indices.some((idx) => idx.isUnique &&
+            idx.columns.length === 1 &&
+            idx.columns[0] === column);
+    }
+    /**
+     * Returns default column lengths, which is required on column creation.
+     *
+     * @param column
+     */
+    getColumnLength(column) {
+        if (column.length)
+            return column.length.toString();
+        if (column.generationStrategy === "uuid")
+            return "36";
+        switch (column.type) {
+            case String:
+            case "string":
+            case "bytes":
+                return "max";
+            default:
+                return "";
+        }
+    }
+    /**
+     * Creates column type definition including length, precision and scale
+     *
+     * @param column
+     */
+    createFullType(column) {
+        let type = column.type;
+        // used 'getColumnLength()' method, because Spanner requires column length for `string` and `bytes` data types
+        if (this.getColumnLength(column)) {
+            type += `(${this.getColumnLength(column)})`;
+        }
+        else if (column.precision !== null &&
+            column.precision !== undefined &&
+            column.scale !== null &&
+            column.scale !== undefined) {
+            type += `(${column.precision},${column.scale})`;
+        }
+        else if (column.precision !== null &&
+            column.precision !== undefined) {
+            type += `(${column.precision})`;
+        }
+        if (column.isArray)
+            type = `array<${type}>`;
+        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() {
+        return this.instanceDatabase;
+    }
+    /**
+     * 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.instanceDatabase;
+    }
+    /**
+     * Creates generated map of values generated or returned by database after INSERT query.
+     *
+     * @param metadata
+     * @param insertResult
+     * @param entityIndex
+     */
+    createGeneratedMap(metadata, insertResult, entityIndex) {
+        if (!insertResult) {
+            return undefined;
+        }
+        if (insertResult.insertId === undefined) {
+            return Object.keys(insertResult).reduce((map, key) => {
+                const column = metadata.findColumnWithDatabaseName(key);
+                if (column) {
+                    OrmUtils_1.OrmUtils.mergeDeep(map, column.createValueMap(insertResult[key]));
+                    // OrmUtils.mergeDeep(map, column.createValueMap(this.prepareHydratedValue(insertResult[key], column))); // TODO: probably should be like there, but fails on enums, fix later
+                }
+                return map;
+            }, {});
+        }
+        const generatedMap = metadata.generatedColumns.reduce((map, generatedColumn) => {
+            let value;
+            if (generatedColumn.generationStrategy === "increment" &&
+                insertResult.insertId) {
+                // NOTE: When multiple rows is inserted by a single INSERT statement,
+                // `insertId` is the value generated for the first inserted row only.
+                value = insertResult.insertId + entityIndex;
+                // } else if (generatedColumn.generationStrategy === "uuid") {
+                //     console.log("getting db value:", generatedColumn.databaseName);
+                //     value = generatedColumn.getEntityValue(uuidMap);
+            }
+            return OrmUtils_1.OrmUtils.mergeDeep(map, generatedColumn.createValueMap(value));
+        }, {});
+        return Object.keys(generatedMap).length > 0 ? generatedMap : undefined;
+    }
+    /**
+     * 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
+            const isColumnChanged = tableColumn.name !== columnMetadata.databaseName ||
+                tableColumn.type !== this.normalizeType(columnMetadata) ||
+                tableColumn.length !== this.getColumnLength(columnMetadata) ||
+                tableColumn.asExpression !== columnMetadata.asExpression ||
+                tableColumn.generatedType !== columnMetadata.generatedType ||
+                tableColumn.isPrimary !== columnMetadata.isPrimary ||
+                !this.compareNullableValues(columnMetadata, tableColumn) ||
+                tableColumn.isUnique !== this.normalizeIsUnique(columnMetadata);
+            // DEBUG SECTION
+            // if (isColumnChanged) {
+            //     console.log("table:", columnMetadata.entityMetadata.tableName)
+            //     console.log(
+            //         "name:",
+            //         tableColumn.name,
+            //         columnMetadata.databaseName,
+            //     )
+            //     console.log(
+            //         "type:",
+            //         tableColumn.type,
+            //         this.normalizeType(columnMetadata),
+            //     )
+            //     console.log(
+            //         "length:",
+            //         tableColumn.length,
+            //         this.getColumnLength(columnMetadata),
+            //     )
+            //     console.log(
+            //         "asExpression:",
+            //         tableColumn.asExpression,
+            //         columnMetadata.asExpression,
+            //     )
+            //     console.log(
+            //         "generatedType:",
+            //         tableColumn.generatedType,
+            //         columnMetadata.generatedType,
+            //     )
+            //     console.log(
+            //         "isPrimary:",
+            //         tableColumn.isPrimary,
+            //         columnMetadata.isPrimary,
+            //     )
+            //     console.log(
+            //         "isNullable:",
+            //         tableColumn.isNullable,
+            //         columnMetadata.isNullable,
+            //     )
+            //     console.log(
+            //         "isUnique:",
+            //         tableColumn.isUnique,
+            //         this.normalizeIsUnique(columnMetadata),
+            //     )
+            //     console.log("==========================================")
+            // }
+            return isColumnChanged;
+        });
+    }
+    /**
+     * Returns true if driver supports RETURNING / OUTPUT statement.
+     *
+     * @param _returningType
+     */
+    isReturningSqlSupported(_returningType) {
+        return true;
+    }
+    /**
+     * Returns true if driver supports uuid values generation on its own.
+     */
+    isUUIDGenerationSupported() {
+        return true;
+    }
+    /**
+     * Returns true if driver supports fulltext indices.
+     */
+    isFullTextColumnTypeSupported() {
+        return false;
+    }
+    /**
+     * Creates an escaped parameter.
+     *
+     * @param parameterName
+     * @param index
+     */
+    createParameter(parameterName, index) {
+        return this.parametersPrefix + index;
+    }
+    // -------------------------------------------------------------------------
+    // Protected Methods
+    // -------------------------------------------------------------------------
+    /**
+     * Loads all driver dependencies.
+     */
+    loadDependencies() {
+        try {
+            const lib = this.options.driver ??
+                PlatformTools_1.PlatformTools.load("@google-cloud/spanner");
+            if (this.options.credentials) {
+                this.spanner = new lib.Spanner({
+                    projectId: this.options.projectId,
+                    credentials: this.options.credentials,
+                });
+                return;
+            }
+            this.spanner = new lib.Spanner({
+                projectId: this.options.projectId,
+            });
+        }
+        catch (e) {
+            console.error(e);
+            throw new DriverPackageNotInstalledError_1.DriverPackageNotInstalledError("Spanner", "@google-cloud/spanner");
+        }
+    }
+    compareNullableValues(columnMetadata, tableColumn) {
+        // Spanner does not support NULL/NOT NULL expressions for generated columns
+        if (columnMetadata.generatedType) {
+            return true;
+        }
+        return columnMetadata.isNullable === tableColumn.isNullable;
+    }
+    /**
+     * Checks if "DEFAULT" values in the column metadata and in the database are equal.
+     *
+     * @param columnMetadataValue
+     * @param databaseValue
+     */
+    compareDefaultValues(columnMetadataValue, databaseValue) {
+        if (typeof columnMetadataValue === "string" &&
+            typeof databaseValue === "string") {
+            // we need to cut out "'" because in mysql we can understand returned value is a string or a function
+            // as result compare cannot understand if default is really changed or not
+            columnMetadataValue = columnMetadataValue.replaceAll(/^'+|'+$/g, "");
+            databaseValue = databaseValue.replaceAll(/^'+|'+$/g, "");
+        }
+        return columnMetadataValue === databaseValue;
+    }
+    /**
+     * Escapes a given comment.
+     *
+     * @param comment
+     */
+    escapeComment(comment) {
+        if (!comment)
+            return comment;
+        comment = comment.replaceAll("\u0000", ""); // Null bytes aren't allowed in comments
+        return comment;
+    }
+}
+exports.SpannerDriver = SpannerDriver;
+//# sourceMappingURL=SpannerDriver.js.map