typeorm / typeorm / 19549987525

import { Driver } from "../Driver"

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

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

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

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

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

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

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

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

import { QueryRunner } from "../../query-runner/QueryRunner"

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

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

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

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

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

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

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

import { DriverUtils } from "../DriverUtils"

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

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

import { View } from "../../schema-builder/view/View"

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

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

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

type DatabasesMap = Record<

    string,

    {

        attachFilepathAbsolute: string

        attachFilepathRelative: string

        attachHandle: string

    }

>

/**

 * Organizes communication with sqlite DBMS.

 */

export abstract class AbstractSqliteDriver implements Driver {

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

    // Public Properties

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

    /**

     * Connection used by driver.

     */

    connection: DataSource

    /**

     * Sqlite has a single QueryRunner because it works on a single database connection.

     */

    queryRunner?: QueryRunner

    /**

     * Real database connection with sqlite database.

     */

    databaseConnection: any

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

    // Public Implemented Properties

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

    /**

     * Connection options.

     */

    options: BaseDataSourceOptions

    /**

     * Master database used to perform all write queries.

     */

    database?: string

    /**

     * Indicates if replication is enabled.

     */

    isReplicated: boolean = false

    /**

     * SQLite underlying library.

     */

    sqlite: any

    /**

     * Indicates if tree tables are supported by this driver.

     */

    treeSupport = true

    /**

     * Represent transaction support by this driver

     */

    transactionSupport: "simple" | "nested" | "none" = "nested"

    /**

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

     *

     * @see https://www.tutorialspoint.com/sqlite/sqlite_data_types.htm

     * @see https://sqlite.org/datatype3.html

     */

    supportedDataTypes: ColumnType[] = [

        "int",

        "integer",

        "tinyint",

        "smallint",

        "mediumint",

        "bigint",

        "unsigned big int",

        "int2",

        "int8",

        "integer",

        "character",

        "varchar",

        "varying character",

        "nchar",

        "native character",

        "nvarchar",

        "text",

        "clob",

        "text",

        "blob",

        "real",

        "double",

        "double precision",

        "float",

        "real",

        "numeric",

        "decimal",

        "boolean",

        "date",

        "time",

        "datetime",

        "json",

    ]

    /**

     * Returns type of upsert supported by driver if any

     */

    supportedUpsertTypes: UpsertType[] = ["on-conflict-do-update"]

    /**

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

     */

    withLengthColumnTypes: ColumnType[] = [

        "character",

        "varchar",

        "varying character",

        "nchar",

        "native character",

        "nvarchar",

        "text",

        "blob",

        "clob",

    ]

    /**

     * Gets list of spatial column data types.

     */

    spatialTypes: ColumnType[] = []

    /**

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

     */

    withPrecisionColumnTypes: ColumnType[] = [

        "real",

        "double",

        "double precision",

        "float",

        "real",

        "numeric",

        "decimal",

        "date",

        "time",

        "datetime",

    ]

    /**

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

     */

    withScaleColumnTypes: ColumnType[] = [

        "real",

        "double",

        "double precision",

        "float",

        "real",

        "numeric",

        "decimal",

    ]

    /**

     * 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: "datetime",

        createDateDefault: "datetime('now')",

        updateDate: "datetime",

        updateDateDefault: "datetime('now')",

        deleteDate: "datetime",

        deleteDateNullable: true,

        version: "integer",

        treeLevel: "integer",

        migrationId: "integer",

        migrationName: "varchar",

        migrationTimestamp: "bigint",

        cacheId: "int",

        cacheIdentifier: "varchar",

        cacheTime: "bigint",

        cacheDuration: "int",

        cacheQuery: "text",

        cacheResult: "text",

        metadataType: "varchar",

        metadataDatabase: "varchar",

        metadataSchema: "varchar",

        metadataTable: "varchar",

        metadataName: "varchar",

        metadataValue: "text",

    }

    /**

     * 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

    /**

     * No documentation specifying a maximum length for identifiers could be found

     * for SQLite.

     */

    maxAliasLength?: number

    cteCapabilities: CteCapabilities = {

        enabled: true,

        requiresRecursiveHint: true,

    }

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

    // Protected Properties

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

    /**

     * Any attached databases (excepting default 'main')

     */

    attachedDatabases: DatabasesMap = {}

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

    // Constructor

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

    constructor(connection: DataSource) {

        this.connection = connection

        this.options = connection.options as BaseDataSourceOptions

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

    }

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

    // Public Abstract

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

    /**

     * Creates a query runner used to execute database queries.

     */

    abstract createQueryRunner(mode: ReplicationMode): QueryRunner

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

    // Public Methods

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

    /**

     * Performs connection to the database.

     */

    async connect(): Promise<void> {

        this.databaseConnection = await this.createDatabaseConnection()

    }

    /**

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

     */

    afterConnect(): Promise<void> {

        return Promise.resolve()

    }

    /**

     * Closes connection with database.

     */

    async disconnect(): Promise<void> {

    hasAttachedDatabases(): boolean {

    getAttachedDatabaseHandleByRelativePath(path: string): string | undefined {

        return this.attachedDatabases?.[path]?.attachHandle

    }

    getAttachedDatabasePathRelativeByHandle(

        handle: string,

    ): string | undefined {

        return Object.values(this.attachedDatabases).find(

            ({ attachHandle }) => handle === attachHandle,

        )?.attachFilepathRelative

    }

    /**

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

     */

    createSchemaBuilder() {

        return new RdbmsSchemaBuilder(this.connection)

    }

    /**

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

            columnMetadata.type === "boolean"

        ) {

            return value === true ? 1 : 0

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

            return DateUtils.mixedDateToDateString(value)

            return DateUtils.mixedDateToTimeString(value)

        } else if (

            columnMetadata.type === "datetime" ||

            columnMetadata.type === Date

        ) {

            // to string conversation needs because SQLite stores date as integer number, when date came as Object

            // TODO: think about `toUTC` conversion

            return DateUtils.mixedDateToUtcDatetimeString(value)

        } else if (

            columnMetadata.type === "json" ||

            columnMetadata.type === "simple-json"

        ) {

            return DateUtils.simpleJsonToString(value)

            return DateUtils.simpleArrayToString(value)

            return DateUtils.simpleEnumToString(value)

        }

        return value

    }

    /**

     * Prepares given value to a value to be hydrated, 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 ||

            columnMetadata.type === "boolean"

        ) {

            value = value ? true : false

        } else if (

            columnMetadata.type === "datetime" ||

            columnMetadata.type === Date

        ) {

            /**

             * Fix date conversion issue

             *

             * If the format of the date string is "2018-03-14 02:33:33.906", Safari (and iOS WKWebView) will convert it to an invalid date object.

             * We need to modify the date string to "2018-03-14T02:33:33.906Z" and Safari will convert it correctly.

             *

             * ISO 8601

             * https://www.w3.org/TR/NOTE-datetime

             */

            if (value && typeof value === "string") {

                // There are various valid time string formats a sqlite time string might have:

                // https://www.sqlite.org/lang_datefunc.html

                // There are two separate fixes we may need to do:

                //   1) Add 'T' separator if space is used instead

                //   2) Add 'Z' UTC suffix if no timezone or offset specified

                if (/^\d\d\d\d-\d\d-\d\d \d\d:\d\d/.test(value)) {

                    value = value.replace(" ", "T")

                }

                if (

                    /^\d\d\d\d-\d\d-\d\dT\d\d:\d\d(:\d\d(\.\d\d\d)?)?$/.test(

                        value,

                    )

                ) {

                    value += "Z"

                }

            }

            value = DateUtils.normalizeHydratedDate(value)

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

            value = DateUtils.mixedDateToDateString(value)

            value = DateUtils.mixedTimeToString(value)

        } else if (

            columnMetadata.type === "json" ||

            columnMetadata.type === "simple-json"

        ) {

            value = DateUtils.stringToSimpleJson(value)

            value = DateUtils.stringToSimpleArray(value)

            value = DateUtils.stringToSimpleEnum(value, columnMetadata)

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

            // convert to number if number

        }

        if (columnMetadata.transformer)

            value = ApplyValueTransformers.transformFrom(

                columnMetadata.transformer,

                value,

            )

        return value

    }

    /**

     * 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) => {

                // Mapping boolean values to their numeric representation

                if (typeof nativeParameters[key] === "boolean") {

                    return nativeParameters[key] === true ? 1 : 0

                }

            },

        )

        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(", ")

                }

                } else if (typeof value === "number") {

                    return String(value)

                }

                // Sqlite does not have a boolean data type so we have to transform

                // it to 1 or 0

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

                    escapedParameters.push(+value)

                    return this.createParameter(

                        key,

                        escapedParameters.length - 1,

                    )

                }

                    escapedParameters.push(

                        DateUtils.mixedDateToUtcDatetimeString(value),

                    )

                    return this.createParameter(

                        key,

                        escapedParameters.length - 1,

                    )

                }

                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.

     * E.g. myDB.mySchema.myTable

     *

     * Returns only simple table name because all inherited drivers does not supports schema and database.

     */

    buildTableName(

        tableName: string,

        schema?: string,

        database?: string,

    ): string {

        return tableName

    }

    /**

     * 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 = undefined

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

            const parsed = this.parseTableName(

                target.schema

                    : target.name,

            )

            return {

                schema: target.schema || parsed.schema || driverSchema,

                tableName: parsed.tableName,

            }

        }

        if (InstanceChecker.isTableForeignKey(target)) {

            const parsed = this.parseTableName(target.referencedTableName)

            return {

                database:

                    target.referencedDatabase ||

                    driverDatabase,

                schema:

                    target.referencedSchema || parsed.schema || driverSchema,

                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(".")

            const database =

            return {

                database: database,

                schema: parts[0],

                tableName: parts[1],

            }

        } else {

            return {

                database: driverDatabase,

                schema: driverSchema,

                tableName: target,

            }

        }

    }

    /**

     * Creates a database type from a given column metadata.

     */

    normalizeType(column: {

        type?: ColumnType

        length?: number | string

        precision?: number | null

        scale?: number

    }): string {

        if (column.type === Number || column.type === "int") {

            return "integer"

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

            return "varchar"

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

            return "datetime"

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

            return "boolean"

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

            return "varchar"

            return "text"

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

            return "text"

            return "varchar"

        } 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): string {

        return column.length ? column.length.toString() : ""

    }

    /**

     * Normalizes "default" value of the column.

     */

    createFullType(column: TableColumn): string {

        let type = column.type

            return "varchar"

        }

        if (column.length) {

            type += "(" + column.length + ")"

        } 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 + ")"

        }

        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> {

    /**

     * 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: any,

        entityIndex: number,

        entityNum: number,

    ) {

        const generatedMap = metadata.generatedColumns.reduce(

            (map, generatedColumn) => {

                let value: any

                if (

                    generatedColumn.generationStrategy === "increment" &&

                    insertResult

                ) {

                    // NOTE: When INSERT statement is successfully completed, the last inserted row ID is returned.

                    // see also: SqliteQueryRunner.query()

                    value = insertResult - entityNum + entityIndex + 1

                    // } else if (generatedColumn.generationStrategy === "uuid") {

                    //     value = insertValue[generatedColumn.databaseName];

                }

                if (!value) return map

                return OrmUtils.mergeDeep(

                    map,

                    generatedColumn.createValueMap(value),

                )

            },

            {} as ObjectLiteral,

        )

        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.

     */

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

                tableColumn.precision !== columnMetadata.precision ||

                tableColumn.scale !== columnMetadata.scale ||

                this.normalizeDefault(columnMetadata) !== tableColumn.default ||

                tableColumn.isPrimary !== columnMetadata.isPrimary ||

                tableColumn.isNullable !== columnMetadata.isNullable ||

                tableColumn.generatedType !== columnMetadata.generatedType ||

                tableColumn.asExpression !== columnMetadata.asExpression ||

                tableColumn.isUnique !==

                    this.normalizeIsUnique(columnMetadata) ||

                    !OrmUtils.isArraysEqual(

                        tableColumn.enum,

                        columnMetadata.enum.map((val) => val + ""),

                    )) ||

                (columnMetadata.generationStrategy !== "uuid" &&

                    tableColumn.isGenerated !== columnMetadata.isGenerated)

            // 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,

            //         columnMetadata.length,

            //     )

            //     console.log(

            //         "precision:",

            //         tableColumn.precision,

            //         columnMetadata.precision,

            //     )

            //     console.log("scale:", tableColumn.scale, columnMetadata.scale)

            //     console.log(

            //         "default:",

            //         this.normalizeDefault(columnMetadata),

            //         columnMetadata.default,

            //     )

            //     console.log(

            //         "isPrimary:",