MysqlDriver | typeorm

Organizes communication with MySQL DBMS.

Hierarchy

MysqlDriver

Implements

Driver

Index

Constructors

constructor

Properties

Object literals

Constructors

constructor

new MysqlDriver(connection: Connection): MysqlDriver

- Defined in driver/mysql/MysqlDriver.ts:234
Parameters
- connection: Connection
Returns MysqlDriver

Properties

connection

connection: Connection

Connection used by driver.

Optional database

database: undefined | string

Master database used to perform all write queries.

isReplicated

isReplicated: boolean = false

Indicates if replication is enabled.

mysql

mysql: any

Mysql underlying library.

options

options: MysqlConnectionOptions

Connection options.

pool

pool: any

Connection pool. Used in non-replication mode.

poolCluster

poolCluster: any

Pool cluster used in replication mode.

spatialTypes

spatialTypes: ColumnType[] = ["geometry","point","linestring","polygon","multipoint","multilinestring","multipolygon","geometrycollection"]

Gets list of spatial column data types.

supportedDataTypes

supportedDataTypes: ColumnType[] = ["int","tinyint","smallint","mediumint","bigint","float","double","dec","decimal","numeric","date","datetime","timestamp","time","year","char","varchar","nvarchar","blob","text","tinyblob","tinytext","mediumblob","mediumtext","longblob","longtext","enum","json","binary","varbinary","geometry","point","linestring","polygon","multipoint","multilinestring","multipolygon","geometrycollection"]

Gets list of supported column data types by a driver.

see: https://www.tutorialspoint.com/mysql/mysql-data-types.htm
see: https://dev.mysql.com/doc/refman/5.7/en/data-types.html

treeSupport

treeSupport: boolean = true

Indicates if tree tables are supported by this driver.

unsignedAndZerofillTypes

unsignedAndZerofillTypes: ColumnType[] = ["int","smallint","tinyint","mediumint","bigint","decimal","float","double"]

Gets list of column data types that supports UNSIGNED and ZEROFILL attributes.

withLengthColumnTypes

withLengthColumnTypes: ColumnType[] = ["char","varchar","nvarchar","binary","varbinary"]

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

withPrecisionColumnTypes

withPrecisionColumnTypes: ColumnType[] = ["decimal","float","double","time","datetime","timestamp"]

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

withScaleColumnTypes

withScaleColumnTypes: ColumnType[] = ["decimal","float","double",]

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

withWidthColumnTypes

withWidthColumnTypes: ColumnType[] = ["tinyint","smallint","mediumint","int","bigint"]

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

Methods

afterConnect

afterConnect(): Promise<void>

Implementation of Driver.afterConnect
- Defined in driver/mysql/MysqlDriver.ts:286
Makes any action after connection (e.g. create extensions in Postgres driver).

Returns Promise<void>

buildTableName

buildTableName(tableName: string, schema?: undefined | string, database?: undefined | string): string

Implementation of Driver.buildTableName
- Defined in driver/mysql/MysqlDriver.ts:368
Build full table name with database name, schema name and table name. E.g. "myDB"."mySchema"."myTable"

Parameters
- tableName: string
- Optional schema: undefined | string
- Optional database: undefined | string
Returns string

Protected compareDefaultValues

compareDefaultValues(columnMetadataValue: string, databaseValue: string): boolean

- Defined in driver/mysql/MysqlDriver.ts:781
Checks if "DEFAULT" values in the column metadata and in the database are equal.

Parameters
- columnMetadataValue: string
- databaseValue: string
Returns boolean

connect

connect(): Promise<void>

Implementation of Driver.connect
- Defined in driver/mysql/MysqlDriver.ts:269
Performs connection to the database.

Returns Promise<void>

Protected createConnectionOptions

createConnectionOptions(options: MysqlConnectionOptions, credentials: MysqlConnectionCredentialsOptions): Promise<any>

- Defined in driver/mysql/MysqlDriver.ts:714
Creates a new connection pool for a given database credentials.

Parameters
- options: MysqlConnectionOptions
- credentials: MysqlConnectionCredentialsOptions
Returns Promise<any>

createFullType

createFullType(column: TableColumn): string

Implementation of Driver.createFullType
- Defined in driver/mysql/MysqlDriver.ts:529
Creates column type definition including length, precision and scale

Parameters
- column: TableColumn
Returns string

createGeneratedMap

createGeneratedMap(metadata: EntityMetadata, insertResult: any): any

Implementation of Driver.createGeneratedMap
- Defined in driver/mysql/MysqlDriver.ts:593
Creates generated map of values generated or returned by database after INSERT query.

Parameters
- metadata: EntityMetadata
- insertResult: any
Returns any

createParameter

createParameter(parameterName: string, index: number): string

Implementation of Driver.createParameter
- Defined in driver/mysql/MysqlDriver.ts:677
Creates an escaped parameter.

Parameters
- parameterName: string
- index: number
Returns string

Protected createPool

createPool(connectionOptions: any): Promise<any>

- Defined in driver/mysql/MysqlDriver.ts:744
Creates a new connection pool for a given database credentials.

Parameters
- connectionOptions: any
Returns Promise<any>

createQueryRunner

createQueryRunner(mode?: "master" | "slave"): MysqlQueryRunner

Implementation of Driver.createQueryRunner
- Defined in driver/mysql/MysqlDriver.ts:324
Creates a query runner used to execute database queries.

Parameters
- Default value mode: "master" | "slave" = "master"
Returns MysqlQueryRunner

createSchemaBuilder

createSchemaBuilder(): RdbmsSchemaBuilder

Implementation of Driver.createSchemaBuilder
- Defined in driver/mysql/MysqlDriver.ts:317
Creates a schema builder used to build and sync a schema.

Returns RdbmsSchemaBuilder

disconnect

disconnect(): Promise<void>

Implementation of Driver.disconnect
- Defined in driver/mysql/MysqlDriver.ts:293
Closes connection with the database.

Returns Promise<void>

escape

escape(columnName: string): string

Implementation of Driver.escape
- Defined in driver/mysql/MysqlDriver.ts:360
Escapes a column name.

Parameters
- columnName: string
Returns string

escapeQueryWithParameters

escapeQueryWithParameters(sql: string, parameters: ObjectLiteral, nativeParameters: ObjectLiteral): [string, any[]]

Implementation of Driver.escapeQueryWithParameters
- Defined in driver/mysql/MysqlDriver.ts:332
Replaces parameters in the given sql with special escaping character and an array of parameter names to be passed to a query.

Parameters
- sql: string
- parameters: ObjectLiteral
- nativeParameters: ObjectLiteral
Returns [string, any[]]

findChangedColumns

findChangedColumns(tableColumns: TableColumn[], columnMetadatas: ColumnMetadata[]): ColumnMetadata[]

Implementation of Driver.findChangedColumns
- Defined in driver/mysql/MysqlDriver.ts:613
Differentiate columns of this table and columns from the given column metadatas columns and returns only changed.

Parameters
- tableColumns: TableColumn[]
- columnMetadatas: ColumnMetadata[]
Returns ColumnMetadata[]

getColumnLength

getColumnLength(column: ColumnMetadata | TableColumn): string

- Defined in driver/mysql/MysqlDriver.ts:508
Returns default column lengths, which is required on column creation.

Parameters
- column: ColumnMetadata | TableColumn
Returns string

isReturningSqlSupported

isReturningSqlSupported(): boolean

Implementation of Driver.isReturningSqlSupported
- Defined in driver/mysql/MysqlDriver.ts:663
Returns true if driver supports RETURNING / OUTPUT statement.

Returns boolean

isUUIDGenerationSupported

isUUIDGenerationSupported(): boolean

Implementation of Driver.isUUIDGenerationSupported
- Defined in driver/mysql/MysqlDriver.ts:670
Returns true if driver supports uuid values generation on its own.

Returns boolean

Protected loadDependencies

loadDependencies(): void

- Defined in driver/mysql/MysqlDriver.ts:688
Loads all driver dependencies.

Returns void

normalizeDefault

normalizeDefault(columnMetadata: ColumnMetadata): string

Implementation of Driver.normalizeDefault
- Defined in driver/mysql/MysqlDriver.ts:478
Normalizes "default" value of the column.

Parameters
- columnMetadata: ColumnMetadata
Returns string

normalizeIsUnique

normalizeIsUnique(column: ColumnMetadata): boolean

Implementation of Driver.normalizeIsUnique
- Defined in driver/mysql/MysqlDriver.ts:501
Normalizes "isUnique" value of the column.

Parameters
- column: ColumnMetadata
Returns boolean

normalizeType

normalizeType(column: object): string

- Defined in driver/mysql/MysqlDriver.ts:445
Creates a database type from a given column metadata.

Parameters
- column: object
  - Optional length?: number | string
  - Optional precision?: number | null
  - Optional scale?: undefined | number
  - type: ColumnType
Returns string

obtainMasterConnection

obtainMasterConnection(): Promise<any>

Implementation of Driver.obtainMasterConnection
- Defined in driver/mysql/MysqlDriver.ts:557
Obtains a new database connection to a master server. Used for replication. If replication is not setup then returns default connection's database connection.

Returns Promise<any>

obtainSlaveConnection

obtainSlaveConnection(): Promise<any>

Implementation of Driver.obtainSlaveConnection
- Defined in driver/mysql/MysqlDriver.ts:579
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.

Returns Promise<any>

Private prepareDbConnection

prepareDbConnection(connection: any): any

- Defined in driver/mysql/MysqlDriver.ts:766
Attaches all required base handlers to a database connection, such as the unhandled error handler.

Parameters
- connection: any
Returns any

prepareHydratedValue

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

Implementation of Driver.prepareHydratedValue
- Defined in driver/mysql/MysqlDriver.ts:410
Prepares given value to a value to be persisted, based on its column type or metadata.

Parameters
- value: any
- columnMetadata: ColumnMetadata
Returns any

preparePersistentValue

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

Implementation of Driver.preparePersistentValue
- Defined in driver/mysql/MysqlDriver.ts:375
Prepares given value to a value to be persisted, based on its column type and metadata.

Parameters
- value: any
- columnMetadata: ColumnMetadata
Returns any

Object literals

dataTypeDefaults

dataTypeDefaults: object

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.

bigint

bigint: object

width

width: number = 20

binary

binary: object

length

length: number = 1

char

char: object

length

length: number = 1

decimal

decimal: object

precision

precision: number = 10

scale

scale: number = 0

double

double: object

precision

precision: number = 22

float

float: object

precision

precision: number = 12

int

int: object

width

width: number = 11

mediumint

mediumint: object

width

width: number = 9

smallint

smallint: object

width

width: number = 6

tinyint

tinyint: object

width

width: number = 4

varbinary

varbinary: object

length

length: number = 255

varchar

varchar: object

length

length: number = 255

mappedDataTypes

mappedDataTypes: object

ORM has special columns and we need to know what database column types should be for those columns. Column types are driver dependant.

cacheDuration

cacheDuration: "int" = "int"

cacheId

cacheId: "int" = "int"

cacheIdentifier

cacheIdentifier: "varchar" = "varchar"

cacheQuery

cacheQuery: "text" = "text"

cacheResult

cacheResult: "text" = "text"

cacheTime

cacheTime: "bigint" = "bigint"

createDate

createDate: "datetime" = "datetime"

createDateDefault

createDateDefault: string = "CURRENT_TIMESTAMP(6)"

createDatePrecision

createDatePrecision: number = 6

migrationId

migrationId: "int" = "int"

migrationName

migrationName: "varchar" = "varchar"

migrationTimestamp

migrationTimestamp: "bigint" = "bigint"

treeLevel

treeLevel: "int" = "int"

updateDate

updateDate: "datetime" = "datetime"

updateDateDefault

updateDateDefault: string = "CURRENT_TIMESTAMP(6)"

updateDatePrecision

updateDatePrecision: number = 6

version

version: "int" = "int"

Hierarchy

Implements

Index

Constructors

Properties

Methods

Object literals

Constructors

constructor

Parameters

connection: Connection

Returns MysqlDriver

Properties

connection

Optional database

isReplicated

mysql

options

pool

poolCluster

spatialTypes

supportedDataTypes

treeSupport

unsignedAndZerofillTypes

withLengthColumnTypes

withPrecisionColumnTypes

withScaleColumnTypes

withWidthColumnTypes

Methods

afterConnect

Returns Promise<void>

buildTableName

Parameters

tableName: string

Optional schema: undefined | string

Optional database: undefined | string

Returns string

Protected compareDefaultValues

Parameters

columnMetadataValue: string

databaseValue: string

Returns boolean

connect

Returns Promise<void>

Protected createConnectionOptions

Parameters

options: MysqlConnectionOptions

credentials: MysqlConnectionCredentialsOptions

Returns Promise<any>

createFullType

Parameters

column: TableColumn

Returns string

createGeneratedMap

Parameters

metadata: EntityMetadata

insertResult: any

Returns any

createParameter

Parameters

parameterName: string

index: number

Returns string

Protected createPool

Parameters

connectionOptions: any

Returns Promise<any>

createQueryRunner

Parameters

Default value mode: "master" | "slave" = "master"

Returns MysqlQueryRunner

createSchemaBuilder

Returns RdbmsSchemaBuilder

disconnect

Returns Promise<void>

escape

Parameters

columnName: string

Returns string

escapeQueryWithParameters