typeorm / typeorm / 20030970342

import { Driver } from "../Driver"

import { ConnectionIsNotSetError } from "../../error/ConnectionIsNotSetError"

import { DriverPackageNotInstalledError } from "../../error/DriverPackageNotInstalledError"

import { CteCapabilities } from "../types/CteCapabilities"

import { OracleQueryRunner } from "./OracleQueryRunner"

import { ObjectLiteral } from "../../common/ObjectLiteral"

import { ColumnMetadata } from "../../metadata/ColumnMetadata"

import { DateUtils } from "../../util/DateUtils"

import { PlatformTools } from "../../platform/PlatformTools"

import { DataSource } from "../../data-source/DataSource"

import { RdbmsSchemaBuilder } from "../../schema-builder/RdbmsSchemaBuilder"

import { OracleConnectionOptions } from "./OracleConnectionOptions"

import { MappedColumnTypes } from "../types/MappedColumnTypes"

import { ColumnType } from "../types/ColumnTypes"

import { DataTypeDefaults } from "../types/DataTypeDefaults"

import { TableColumn } from "../../schema-builder/table/TableColumn"

import { OracleConnectionCredentialsOptions } from "./OracleConnectionCredentialsOptions"

import { DriverUtils } from "../DriverUtils"

import { EntityMetadata } from "../../metadata/EntityMetadata"

import { OrmUtils } from "../../util/OrmUtils"

import { ApplyValueTransformers } from "../../util/ApplyValueTransformers"

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 { TypeORMError } from "../../error"

import { InstanceChecker } from "../../util/InstanceChecker"

import { UpsertType } from "../types/UpsertType"

import { OnDeleteType } from "../../metadata/types/OnDeleteType"

import { OnUpdateType } from "../../metadata/types/OnUpdateType"

/**

 * Organizes communication with Oracle RDBMS.

 */

export class OracleDriver implements Driver {

    // -------------------------------------------------------------------------

    // Public Properties

    // -------------------------------------------------------------------------

    /**

     * Connection used by driver.

     */

    connection: DataSource

    /**

     * Underlying oracle library.

     */

    oracle: any

    /**

     * Pool for master database.

     */

    master: any

    /**

     * Pool for slave databases.

     * Used in replication.

     */

    slaves: any[] = []

    // -------------------------------------------------------------------------

    // Public Implemented Properties

    // -------------------------------------------------------------------------

    /**

     * Connection options.

     */

    options: OracleConnectionOptions

    /**

     * Database name used to perform all write queries.

     */

    database?: string

    /**

     * Schema name used to perform all write queries.

     */

    schema?: string

    /**

     * Indicates if replication is enabled.

     */

    isReplicated: boolean = false

    /**

     * Indicates if tree tables are supported by this driver.

     */

    treeSupport = true

    /**

     * Represent transaction support by this driver

     */

    transactionSupport = "nested" as const

    /**

     * Gets list of supported column data types by a driver.

     *

     * @see https://www.techonthenet.com/oracle/datatypes.php

     * @see https://docs.oracle.com/cd/B28359_01/server.111/b28318/datatype.htm#CNCPT012

     */

    supportedDataTypes: ColumnType[] = [

        "char",

        "nchar",

        "nvarchar2",

        "varchar2",

        "long",

        "raw",

        "long raw",

        "number",

        "numeric",

        "float",

        "dec",

        "decimal",

        "integer",

        "int",

        "smallint",

        "real",

        "double precision",

        "date",

        "timestamp",

        "timestamp with time zone",

        "timestamp with local time zone",

        "interval year to month",

        "interval day to second",

        "bfile",

        "blob",

        "clob",

        "nclob",

        "rowid",

        "urowid",

        "simple-json",

        "json",

    ]

    /**

     * Returns type of upsert supported by driver if any

     */

    supportedUpsertTypes: UpsertType[] = ["merge-into"]

    /**

     * Returns list of supported onDelete types by driver.

     * https://docs.oracle.com/en/database/oracle/oracle-database/21/sqlrf/sql-language-reference.pdf

     * Oracle does not support NO ACTION, but NO ACTION is set by default in EntityMetadata

     */

    supportedOnDeleteTypes: OnDeleteType[] = [

        "CASCADE",

        "SET NULL",

        "NO ACTION",

    ]

    /**

     * Returns list of supported onUpdate types by driver.

     * Oracle does not have onUpdate option, but we allow NO ACTION since it is set by default in EntityMetadata

     */

    supportedOnUpdateTypes: OnUpdateType[] = ["NO ACTION"]

    /**

     * Gets list of spatial column data types.

     */

    spatialTypes: ColumnType[] = []

    /**

     * Gets list of column data types that support length by a driver.

     */

    withLengthColumnTypes: ColumnType[] = [

        "char",

        "nchar",

        "nvarchar2",

        "varchar2",

        "varchar",

        "raw",

    ]

    /**

     * Gets list of column data types that support precision by a driver.

     */

    withPrecisionColumnTypes: ColumnType[] = [

        "number",

        "float",

        "timestamp",

        "timestamp with time zone",

        "timestamp with local time zone",

    ]

    /**

     * Gets list of column data types that support scale by a driver.

     */

    withScaleColumnTypes: ColumnType[] = ["number"]

    /**

     * Orm has special columns and we need to know what database column types should be for those types.

     * Column types are driver dependant.

     */

    mappedDataTypes: MappedColumnTypes = {

        createDate: "timestamp",

        createDateDefault: "CURRENT_TIMESTAMP",

        updateDate: "timestamp",

        updateDateDefault: "CURRENT_TIMESTAMP",

        deleteDate: "timestamp",

        deleteDateNullable: true,

        version: "number",

        treeLevel: "number",

        migrationId: "number",

        migrationName: "varchar2",

        migrationTimestamp: "number",

        cacheId: "number",

        cacheIdentifier: "varchar2",

        cacheTime: "number",

        cacheDuration: "number",

        cacheQuery: "clob",

        cacheResult: "clob",

        metadataType: "varchar2",

        metadataDatabase: "varchar2",

        metadataSchema: "varchar2",

        metadataTable: "varchar2",

        metadataName: "varchar2",

        metadataValue: "clob",

    }

    /**

     * The prefix used for the parameters

     */

    parametersPrefix: string = ":"

    /**

     * 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.

     */

    dataTypeDefaults: DataTypeDefaults = {

        char: { length: 1 },

        nchar: { length: 1 },

        varchar: { length: 255 },

        varchar2: { length: 255 },

        nvarchar2: { length: 255 },

        raw: { length: 2000 },

        float: { precision: 126 },

        timestamp: { precision: 6 },

        "timestamp with time zone": { precision: 6 },

        "timestamp with local time zone": { precision: 6 },

    }

    /**

     * Max length allowed by Oracle for aliases.

     * @see https://docs.oracle.com/database/121/SQLRF/sql_elements008.htm#SQLRF51129

     * > The following list of rules applies to both quoted and nonquoted identifiers unless otherwise indicated

     * > Names must be from 1 to 30 bytes long with these exceptions:

     * > [...]

     *

     * Since Oracle 12.2 (with a compatible driver/client), the limit has been set to 128.

     * @see https://docs.oracle.com/en/database/oracle/oracle-database/12.2/sqlrf/Database-Object-Names-and-Qualifiers.html

     *

     * > If COMPATIBLE is set to a value of 12.2 or higher, then names must be from 1 to 128 bytes long with these exceptions

     */

    maxAliasLength = 29

    cteCapabilities: CteCapabilities = {

        enabled: true,

    }

    dummyTableName = "DUAL"

    // -------------------------------------------------------------------------

    // Constructor

    // -------------------------------------------------------------------------

    constructor(connection: DataSource) {

        this.connection = connection

        this.options = connection.options as OracleConnectionOptions

        // load oracle package

        this.loadDependencies()

        this.database = DriverUtils.buildDriverOptions(

            this.options.replication

                : this.options,

        ).database

        this.schema = DriverUtils.buildDriverOptions(this.options).schema

        // Object.assign(connection.options, DriverUtils.buildDriverOptions(connection.options)); // todo: do it better way

        // validate options to make sure everything is set

        // if (!this.options.host)

        //     throw new DriverOptionNotSetError("host");

        // if (!this.options.username)

        //     throw new DriverOptionNotSetError("username");

        // if (!this.options.sid)

        //     throw new DriverOptionNotSetError("sid");

        //

    }

    // -------------------------------------------------------------------------

    // Public Methods

    // -------------------------------------------------------------------------

    /**

     * Performs connection to the database.

     * Based on pooling options, it can either create connection immediately,

     * either create a pool and create connection when needed.

     */

    async connect(): Promise<void> {

        this.oracle.fetchAsString = [this.oracle.DB_TYPE_CLOB]

        this.oracle.fetchAsBuffer = [this.oracle.DB_TYPE_BLOB]

        } else {

            this.master = await this.createPool(this.options, this.options)

        }

            const queryRunner = this.createQueryRunner("master")

            if (!this.database) {

                this.database = await queryRunner.getCurrentDatabase()

            }

            if (!this.schema) {

                this.schema = await queryRunner.getCurrentSchema()

            }

            await queryRunner.release()

        }

    }

    /**

     * Makes any action after connection (e.g. create extensions in Postgres driver).

     */

    afterConnect(): Promise<void> {

        return Promise.resolve()

    }

    /**

     * Closes connection with the database.

     */

    async disconnect(): Promise<void> {

        await this.closePool(this.master)

        await Promise.all(this.slaves.map((slave) => this.closePool(slave)))

        this.master = undefined

        this.slaves = []

    }

    /**

     * Creates a schema builder used to build and sync a schema.

     */

    createSchemaBuilder() {

        return new RdbmsSchemaBuilder(this.connection)

    }

    /**

     * Creates a query runner used to execute database queries.

     */

    createQueryRunner(mode: ReplicationMode) {

        return new OracleQueryRunner(this, mode)

    }

    /**

     * Replaces parameters in the given sql with special escaping character

     * and an array of parameter names to be passed to a query.

     */

    escapeQueryWithParameters(

        sql: string,

        parameters: ObjectLiteral,

        nativeParameters: ObjectLiteral,

    ): [string, any[]] {

        const escapedParameters: any[] = Object.keys(nativeParameters).map(

            (key) => {

            },

        )

        if (!parameters || !Object.keys(parameters).length)

            return [sql, escapedParameters]

        sql = sql.replace(

            /:(\.\.\.)?([A-Za-z0-9_.]+)/g,

            (full, isArray: string, key: string): string => {

                const value: any = parameters[key]

                if (isArray) {

                    return value

                        .map((v: any) => {

                            escapedParameters.push(v)

                            return this.createParameter(

                                key,

                                escapedParameters.length - 1,

                            )

                        })

                        .join(", ")

                }

                if (typeof value === "boolean") {

                    return value ? "1" : "0"

                }

                escapedParameters.push(value)

                return this.createParameter(key, escapedParameters.length - 1)

            },

        ) // todo: make replace only in value statements, otherwise problems

        return [sql, escapedParameters]

    }

    /**

     * Escapes a column name.

     */

    escape(columnName: string): string {

        return `"${columnName}"`

    }

    /**

     * Build full table name with database name, schema name and table name.

     * Oracle does not support table schemas. One user can have only one schema.

     */

    buildTableName(

        tableName: string,

        schema?: string,

        database?: string,

    ): string {

        const tablePath = [tableName]

        if (schema) {

            tablePath.unshift(schema)

        }

        return tablePath.join(".")

    }

    /**

     * Parse a target table name or other types and return a normalized table definition.

     */

    parseTableName(

        target: EntityMetadata | Table | View | TableForeignKey | string,

    ): { database?: string; schema?: string; tableName: string } {

        const driverDatabase = this.database

        const driverSchema = this.schema

        if (InstanceChecker.isTable(target) || InstanceChecker.isView(target)) {

            const parsed = this.parseTableName(target.name)

            return {

                tableName: parsed.tableName,

            }

        }

        if (InstanceChecker.isTableForeignKey(target)) {

            const parsed = this.parseTableName(target.referencedTableName)

            return {

                database:

                    target.referencedDatabase ||

                    driverDatabase,

                schema:

                tableName: parsed.tableName,

            }

        }

        if (InstanceChecker.isEntityMetadata(target)) {

            // EntityMetadata tableName is never a path

            return {

                database: target.database || driverDatabase,

                schema: target.schema || driverSchema,

                tableName: target.tableName,

            }

        }

        const parts = target.split(".")

        } else if (parts.length === 2) {

            return {

                database: driverDatabase,

                tableName: parts[1],

            }

        } else {

            return {

                database: driverDatabase,

                schema: driverSchema,

                tableName: target,

            }

        }

    }

    /**

     * Prepares given value to a value to be persisted, based on its column type and metadata.

     */

    preparePersistentValue(value: any, columnMetadata: ColumnMetadata): any {

        if (columnMetadata.transformer)

            value = ApplyValueTransformers.transformTo(

                columnMetadata.transformer,

                value,

            )

        if (value === null || value === undefined) return value

        if (columnMetadata.type === Boolean) {

            return value ? 1 : 0

        } else if (columnMetadata.type === "date") {

            if (typeof value === "string") value = value.replace(/[^0-9-]/g, "")

            return () =>

                `TO_DATE('${DateUtils.mixedDateToDateString(value, {

                    utc: columnMetadata.utc,

                })}', 'YYYY-MM-DD')`

        } else if (

            columnMetadata.type === Date ||

            columnMetadata.type === "timestamp" ||

            columnMetadata.type === "timestamp with time zone" ||

            columnMetadata.type === "timestamp with local time zone"

        ) {

            return DateUtils.mixedDateToDate(value)

        } else if (columnMetadata.type === "simple-array") {

            return DateUtils.simpleArrayToString(value)

        } else if (columnMetadata.type === "simple-json") {

            return DateUtils.simpleJsonToString(value)

        } else if (columnMetadata.type === "json") {

            return DateUtils.simpleJsonToString(value)

        }

        return value

    }

    /**

     * Prepares given value to a value to be persisted, based on its column type or metadata.

     */

    prepareHydratedValue(value: any, columnMetadata: ColumnMetadata): any {

        if (value === null || value === undefined)

            return columnMetadata.transformer

                ? ApplyValueTransformers.transformFrom(

                      columnMetadata.transformer,

                      value,

                  )

                : value

        if (columnMetadata.type === Boolean) {

            value = !!value

        } else if (columnMetadata.type === "date") {

            value = DateUtils.mixedDateToDateString(value, {

                utc: columnMetadata.utc,

            })

        } else if (

            columnMetadata.type === Date ||

            columnMetadata.type === "timestamp" ||

            columnMetadata.type === "timestamp with time zone" ||

            columnMetadata.type === "timestamp with local time zone"

        ) {

            value = DateUtils.normalizeHydratedDate(value)

        } else if (columnMetadata.type === "simple-array") {

            value = DateUtils.stringToSimpleArray(value)

        } else if (columnMetadata.type === "simple-json") {

            value = DateUtils.stringToSimpleJson(value)

        } else if (columnMetadata.type === Number) {

            // convert to number if number

        }

        if (columnMetadata.transformer)

            value = ApplyValueTransformers.transformFrom(

                columnMetadata.transformer,

                value,

            )

        return value

    }

    /**

     * Creates a database type from a given column metadata.

     */

    normalizeType(column: {

        type?: ColumnType

        length?: number | string

        precision?: number | null

        scale?: number

        isArray?: boolean

    }): string {

        if (

            column.type === Number ||

            column.type === Boolean ||

            column.type === "numeric" ||

            column.type === "dec" ||

            column.type === "decimal" ||

            column.type === "int" ||

            column.type === "integer" ||

            column.type === "smallint"

        ) {

            return "number"

        } else if (

            column.type === "real" ||

            column.type === "double precision"

        ) {

            return "float"

        } else if (column.type === String || column.type === "varchar") {

            return "varchar2"

        } else if (column.type === Date) {

            return "timestamp"

        } else if ((column.type as any) === Buffer) {

            return "blob"

        } else if (column.type === "uuid") {

            return "varchar2"

        } else if (column.type === "simple-array") {

            return "clob"

        } else if (column.type === "simple-json") {

            return "clob"

        } else if (column.type === "json") {

            return "json"

        } else {

        }

    }

    /**

     * Normalizes "default" value of the column.

     */

    normalizeDefault(columnMetadata: ColumnMetadata): string | undefined {

        const defaultValue = columnMetadata.default

        if (typeof defaultValue === "number") {

            return "" + defaultValue

        }

        if (typeof defaultValue === "boolean") {

            return defaultValue ? "1" : "0"

        }

        if (typeof defaultValue === "function") {

            return defaultValue()

        }

        if (typeof defaultValue === "string") {

            return `'${defaultValue}'`

        }

        if (defaultValue === null || defaultValue === undefined) {

            return undefined

        }

    /**

     * Normalizes "isUnique" value of the column.

     */

    normalizeIsUnique(column: ColumnMetadata): boolean {

        return column.entityMetadata.uniques.some(

            (uq) => uq.columns.length === 1 && uq.columns[0] === column,

        )

    }

    /**

     * Calculates column length taking into account the default length values.

     */

    getColumnLength(column: ColumnMetadata | TableColumn): string {

        if (column.length) return column.length.toString()

        switch (column.type) {

            case String:

            case "varchar":

            case "varchar2":

            case "nvarchar2":

                return "255"

            case "raw":

                return "2000"

            case "uuid":

                return "36"

            default:

                return ""

        }

    }

    createFullType(column: TableColumn): string {

        let type = column.type

        // used 'getColumnLength()' method, because in Oracle column length is required for some 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.type === "timestamp with time zone") {

            type =

                "TIMESTAMP" +

                (column.precision !== null && column.precision !== undefined

                    ? "(" + column.precision + ")"

                    : "") +

                " WITH TIME ZONE"

        } else if (column.type === "timestamp with local time zone") {

            type =

                "TIMESTAMP" +

                (column.precision !== null && column.precision !== undefined

                    ? "(" + column.precision + ")"

                    : "") +

                " WITH LOCAL TIME ZONE"

        }

        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(): Promise<any> {

        return new Promise<any>((ok, fail) => {

            this.master.getConnection(

                (err: any, connection: any, release: Function) => {

                    ok(connection)

                },

            )

        })

    }

    /**

     * 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.

     */

    createGeneratedMap(metadata: EntityMetadata, insertResult: ObjectLiteral) {

        if (!insertResult) return undefined

        return Object.keys(insertResult).reduce((map, key) => {

            const column = metadata.findColumnWithDatabaseName(key)

            if (column) {

                OrmUtils.mergeDeep(

                    map,

                    column.createValueMap(

                        this.prepareHydratedValue(insertResult[key], column),

                    ),

                )

            }

            return map

        }, {} as ObjectLiteral)

    }

    /**

     * Differentiate columns of this table and columns from the given column metadatas columns

     * and returns only changed.

     */

    findChangedColumns(

        tableColumns: TableColumn[],

        columnMetadatas: ColumnMetadata[],

    ): ColumnMetadata[] {

        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.precision !== columnMetadata.precision ||

                tableColumn.scale !== columnMetadata.scale ||

                // || tableColumn.comment !== columnMetadata.comment