Skip to main content

Version: Next

MySqlSchemaHelper

Hierarchy

SchemaHelper
- MySqlSchemaHelper
  - MariaDbSchemaHelper

Index

Constructors

constructor

Properties

DEFAULT_VALUES

Accessors

knex
options

Methods

Constructors

constructor

new MySqlSchemaHelper(platform: AbstractSqlPlatform): MySqlSchemaHelper

Inherited from SchemaHelper.constructor
Parameters
- platform: AbstractSqlPlatform
Returns MySqlSchemaHelper

Properties

staticreadonlyDEFAULT_VALUES

DEFAULT_VALUES: { 0: string[]; current_timestamp(?): string[]; now(): string[] } = ...

Type declaration

0: string[]
current_timestamp(?): string[]
now(): string[]

Accessors

knex

get knex(): Knex<any, any[]>

Inherited from SchemaHelper.knex
Returns Knex<any, any[]>

options

get options(): { createForeignKeyConstraints?: boolean; disableForeignKeys?: boolean; ignoreSchema?: string[]; managementDbName?: string }

Inherited from SchemaHelper.options
Returns { createForeignKeyConstraints?: boolean; disableForeignKeys?: boolean; ignoreSchema?: string[]; managementDbName?: string }
- optionalcreateForeignKeyConstraints?: boolean
- optionaldisableForeignKeys?: boolean
- optionalignoreSchema?: string[]
- optionalmanagementDbName?: string

Methods

configureColumn

configureColumn(column: Column, col: ColumnBuilder, knex: Knex<any, any[]>, changedProperties?: Set<string>): ColumnBuilder

Inherited from SchemaHelper.configureColumn
Parameters
- column: Column
- col: ColumnBuilder
- knex: Knex<any, any[]>
- optionalchangedProperties: Set<string>
Returns ColumnBuilder

configureColumnDefault

configureColumnDefault(column: Column, col: ColumnBuilder, knex: Knex<any, any[]>, changedProperties?: Set<string>): ColumnBuilder

Overrides SchemaHelper.configureColumnDefault
Parameters
- column: Column
- col: ColumnBuilder
- knex: Knex<any, any[]>
- optionalchangedProperties: Set<string>
Returns ColumnBuilder

createCheck

createCheck(table: CreateTableBuilder, check: CheckDef<unknown>): void

Inherited from SchemaHelper.createCheck
Parameters
- table: CreateTableBuilder
- check: CheckDef<unknown>
Returns void

createForeignKey

createForeignKey(table: CreateTableBuilder, foreignKey: ForeignKey, schema?: string): void

Inherited from SchemaHelper.createForeignKey
Parameters
- table: CreateTableBuilder
- foreignKey: ForeignKey
- optionalschema: string
Returns void

createIndex

createIndex(table: CreateTableBuilder, index: IndexDef, tableDef: DatabaseTable, createPrimary?: boolean): void

Inherited from SchemaHelper.createIndex
Parameters
- table: CreateTableBuilder
- index: IndexDef
- tableDef: DatabaseTable
- createPrimary: boolean = false
Returns void

createSchemaBuilder

createSchemaBuilder(schema?: string): SchemaBuilder

Inherited from SchemaHelper.createSchemaBuilder
Parameters
- optionalschema: string
Returns SchemaBuilder

createTable

createTable(tableDef: DatabaseTable, alter?: boolean): SchemaBuilder

Inherited from SchemaHelper.createTable
Parameters
- tableDef: DatabaseTable
- optionalalter: boolean
Returns SchemaBuilder

createTableColumn

createTableColumn(table: MySqlTableBuilder, column: Column, fromTable: DatabaseTable, changedProperties?: Set<string>, alter?: boolean): undefined | ColumnBuilder

Overrides SchemaHelper.createTableColumn
Parameters
- table: MySqlTableBuilder
- column: Column
- fromTable: DatabaseTable
- optionalchangedProperties: Set<string>
- optionalalter: boolean
Returns undefined | ColumnBuilder

databaseExists

databaseExists(connection: Connection, name: string): Promise<boolean>

Inherited from SchemaHelper.databaseExists
Parameters
- connection: Connection
- name: string
Returns Promise<boolean>

disableForeignKeysSQL

disableForeignKeysSQL(): string

Overrides SchemaHelper.disableForeignKeysSQL
Returns string

dump

dump(builder: string | SchemaBuilder, append: string): Promise<string>

Inherited from SchemaHelper.dump
Parameters
- builder: string | SchemaBuilder
- append: string
Returns Promise<string>

enableForeignKeysSQL

enableForeignKeysSQL(): string

Overrides SchemaHelper.enableForeignKeysSQL
Returns string

finalizeTable

finalizeTable(table: CreateTableBuilder, charset: string, collate?: string): void

Overrides SchemaHelper.finalizeTable
Parameters
- table: CreateTableBuilder
- charset: string
- optionalcollate: string
Returns void

getAllChecks

getAllChecks(connection: AbstractSqlConnection, tables: Table[]): Promise<Dictionary<CheckDef<unknown>[]>>

Parameters
- connection: AbstractSqlConnection
- tables: Table[]
Returns Promise<Dictionary<CheckDef<unknown>[]>>

getAllColumns

getAllColumns(connection: AbstractSqlConnection, tables: Table[]): Promise<Dictionary<Column[]>>

Parameters
- connection: AbstractSqlConnection
- tables: Table[]
Returns Promise<Dictionary<Column[]>>

getAllEnumDefinitions

getAllEnumDefinitions(connection: AbstractSqlConnection, tables: Table[]): Promise<Dictionary<Dictionary<string[]>>>

Parameters
- connection: AbstractSqlConnection
- tables: Table[]
Returns Promise<Dictionary<Dictionary<string[]>>>

getAllForeignKeys

getAllForeignKeys(connection: AbstractSqlConnection, tables: Table[]): Promise<Dictionary<Dictionary<ForeignKey>>>

Parameters
- connection: AbstractSqlConnection
- tables: Table[]
Returns Promise<Dictionary<Dictionary<ForeignKey>>>

getAllIndexes

getAllIndexes(connection: AbstractSqlConnection, tables: Table[]): Promise<Dictionary<IndexDef[]>>

Parameters
- connection: AbstractSqlConnection
- tables: Table[]
Returns Promise<Dictionary<IndexDef[]>>

getAlterColumnAutoincrement

getAlterColumnAutoincrement(tableName: string, column: Column, schemaName?: string): string

Inherited from SchemaHelper.getAlterColumnAutoincrement
Parameters
- tableName: string
- column: Column
- optionalschemaName: string
Returns string

getAlterNativeEnumSQL

getAlterNativeEnumSQL(name: string, schema?: string, value?: string, items?: string[], oldItems?: string[]): string

Inherited from SchemaHelper.getAlterNativeEnumSQL
Parameters
- name: string
- optionalschema: string
- optionalvalue: string
- optionalitems: string[]
- optionaloldItems: string[]
Returns string

optionalgetAlterTable

getAlterTable(changedTable: TableDifference, wrap?: boolean): Promise<string>

Inherited from SchemaHelper.getAlterTable
Parameters
- changedTable: TableDifference
- optionalwrap: boolean
Returns Promise<string>

getChangeColumnCommentSQL

getChangeColumnCommentSQL(tableName: string, to: Column, schemaName?: string): string

Overrides SchemaHelper.getChangeColumnCommentSQL
Parameters
- tableName: string
- to: Column
- optionalschemaName: string
Returns string

getChecks

getChecks(connection: AbstractSqlConnection, tableName: string, schemaName: string, columns?: Column[]): Promise<CheckDef<unknown>[]>

Overrides SchemaHelper.getChecks
Parameters
- connection: AbstractSqlConnection
- tableName: string
- schemaName: string
- optionalcolumns: Column[]
Returns Promise<CheckDef<unknown>[]>

getColumns

getColumns(connection: AbstractSqlConnection, tableName: string, schemaName?: string): Promise<Column[]>

Overrides SchemaHelper.getColumns
Parameters
- connection: AbstractSqlConnection
- tableName: string
- optionalschemaName: string
Returns Promise<Column[]>

getCreateDatabaseSQL

getCreateDatabaseSQL(name: string): string

Inherited from SchemaHelper.getCreateDatabaseSQL
Parameters
- name: string
Returns string

getCreateIndexSQL

getCreateIndexSQL(tableName: string, index: IndexDef, partialExpression?: boolean): string

Inherited from SchemaHelper.getCreateIndexSQL
Parameters
- tableName: string
- index: IndexDef
- partialExpression: boolean = false
Returns string

getCreateNamespaceSQL

getCreateNamespaceSQL(name: string): string

Inherited from SchemaHelper.getCreateNamespaceSQL
Parameters
- name: string
Returns string

getCreateNativeEnumSQL

getCreateNativeEnumSQL(name: string, values: unknown[], schema?: string): string

Inherited from SchemaHelper.getCreateNativeEnumSQL
Parameters
- name: string
- values: unknown[]
- optionalschema: string
Returns string

getDatabaseExistsSQL

getDatabaseExistsSQL(name: string): string

Inherited from SchemaHelper.getDatabaseExistsSQL
Parameters
- name: string
Returns string

getDatabaseNotExistsError

getDatabaseNotExistsError(dbName: string): string

Inherited from SchemaHelper.getDatabaseNotExistsError
Parameters
- dbName: string
Returns string

getDefaultEmptyString

getDefaultEmptyString(): string

Inherited from SchemaHelper.getDefaultEmptyString
Returns string

getDropColumnsSQL

getDropColumnsSQL(tableName: string, columns: Column[], schemaName?: string): string

Inherited from SchemaHelper.getDropColumnsSQL
Parameters
- tableName: string
- columns: Column[]
- optionalschemaName: string
Returns string

getDropDatabaseSQL

getDropDatabaseSQL(name: string): string

Inherited from SchemaHelper.getDropDatabaseSQL
Parameters
- name: string
Returns string

getDropIndexSQL

getDropIndexSQL(tableName: string, index: IndexDef): string

Inherited from SchemaHelper.getDropIndexSQL
Parameters
- tableName: string
- index: IndexDef
Returns string

getDropNamespaceSQL

getDropNamespaceSQL(name: string): string

Inherited from SchemaHelper.getDropNamespaceSQL
Parameters
- name: string
Returns string

getDropNativeEnumSQL

getDropNativeEnumSQL(name: string, schema?: string): string

Inherited from SchemaHelper.getDropNativeEnumSQL
Parameters
- name: string
- optionalschema: string
Returns string

getEnumDefinitions

getEnumDefinitions(connection: AbstractSqlConnection, checks: CheckDef<unknown>[], tableName: string, schemaName?: string): Promise<Dictionary<string[]>>

Overrides SchemaHelper.getEnumDefinitions
Parameters
- connection: AbstractSqlConnection
- checks: CheckDef<unknown>[]
- tableName: string
- optionalschemaName: string
Returns Promise<Dictionary<string[]>>

getForeignKeys

getForeignKeys(connection: AbstractSqlConnection, tableName: string, schemaName?: string): Promise<Dictionary>

Inherited from SchemaHelper.getForeignKeys
Parameters
- connection: AbstractSqlConnection
- tableName: string
- optionalschemaName: string
Returns Promise<Dictionary>

getForeignKeysSQL

getForeignKeysSQL(tableName: string, schemaName?: string): string

Overrides SchemaHelper.getForeignKeysSQL
Parameters
- tableName: string
- optionalschemaName: string
Returns string

getIndexes

getIndexes(connection: AbstractSqlConnection, tableName: string, schemaName?: string): Promise<IndexDef[]>

Overrides SchemaHelper.getIndexes
Parameters
- connection: AbstractSqlConnection
- tableName: string
- optionalschemaName: string
Returns Promise<IndexDef[]>

getListTablesSQL

getListTablesSQL(): string

Overrides SchemaHelper.getListTablesSQL
Returns string

getManagementDbName

getManagementDbName(): string

Inherited from SchemaHelper.getManagementDbName
Returns string

getNamespaces

getNamespaces(connection: AbstractSqlConnection): Promise<string[]>

Inherited from SchemaHelper.getNamespaces
Parameters
- connection: AbstractSqlConnection
Returns Promise<string[]>

getPostAlterTable

getPostAlterTable(tableDiff: TableDifference, safe: boolean): string

Inherited from SchemaHelper.getPostAlterTable
Parameters
- tableDiff: TableDifference
- safe: boolean
Returns string

getPreAlterTable

getPreAlterTable(tableDiff: TableDifference, safe: boolean): string

Overrides SchemaHelper.getPreAlterTable
Parameters
- tableDiff: TableDifference
- safe: boolean
Returns string

getPrimaryKeys

getPrimaryKeys(connection: AbstractSqlConnection, indexes?: IndexDef[], tableName: string, schemaName?: string): Promise<string[]>

Inherited from SchemaHelper.getPrimaryKeys
Parameters
- connection: AbstractSqlConnection
- indexes: IndexDef[] = []
- tableName: string
- optionalschemaName: string
Returns Promise<string[]>

getReferencedTableName

getReferencedTableName(referencedTableName: string, schema?: string): string

Inherited from SchemaHelper.getReferencedTableName
Parameters
- referencedTableName: string
- optionalschema: string
Returns string

getRenameColumnSQL

getRenameColumnSQL(tableName: string, oldColumnName: string, to: Column): string

Overrides SchemaHelper.getRenameColumnSQL
Parameters
- tableName: string
- oldColumnName: string
- to: Column
Returns string

getRenameIndexSQL

getRenameIndexSQL(tableName: string, index: IndexDef, oldIndexName: string): string

Overrides SchemaHelper.getRenameIndexSQL
Parameters
- tableName: string
- index: IndexDef
- oldIndexName: string
Returns string

getSchemaBeginning

getSchemaBeginning(charset: string, disableForeignKeys?: boolean): string

Overrides SchemaHelper.getSchemaBeginning
Parameters
- charset: string
- optionaldisableForeignKeys: boolean
Returns string

getSchemaEnd

getSchemaEnd(disableForeignKeys?: boolean): string

Inherited from SchemaHelper.getSchemaEnd
Parameters
- optionaldisableForeignKeys: boolean
Returns string

getTablesGroupedBySchemas

getTablesGroupedBySchemas(tables: Table[]): Map<undefined | string, Table[]>

Inherited from SchemaHelper.getTablesGroupedBySchemas
Parameters
- tables: Table[]
Returns Map<undefined | string, Table[]>

hasNonDefaultPrimaryKeyName

hasNonDefaultPrimaryKeyName(table: DatabaseTable): boolean

Inherited from SchemaHelper.hasNonDefaultPrimaryKeyName
Parameters
- table: DatabaseTable
Returns boolean

inferLengthFromColumnType

inferLengthFromColumnType(type: string): undefined | number

Inherited from SchemaHelper.inferLengthFromColumnType
Parameters
- type: string
Returns undefined | number

loadInformationSchema

loadInformationSchema(schema: DatabaseSchema, connection: AbstractSqlConnection, tables: Table[]): Promise<void>

Overrides SchemaHelper.loadInformationSchema
Parameters
- schema: DatabaseSchema
- connection: AbstractSqlConnection
- tables: Table[]
Returns Promise<void>

mapForeignKeys

mapForeignKeys(fks: any[], tableName: string, schemaName?: string): Dictionary

Inherited from SchemaHelper.mapForeignKeys
Parameters
- fks: any[]
- tableName: string
- optionalschemaName: string
Returns Dictionary

normalizeDefaultValue

normalizeDefaultValue(defaultValue: string, length: number): string | number

Overrides SchemaHelper.normalizeDefaultValue
Parameters
- defaultValue: string
- length: number
Returns string | number

pushTableQuery

pushTableQuery(table: TableBuilder, expression: string, grouping?: string): void

Inherited from SchemaHelper.pushTableQuery
Uses raw method injected in AbstractSqlConnection to allow adding custom queries inside alter statements.
Parameters
- table: TableBuilder
- expression: string
- grouping: string = 'alterTable'
Returns void

splitTableName

splitTableName(name: string): [undefined | string, string]

Inherited from SchemaHelper.splitTableName
Parameters
- name: string
Returns [undefined | string, string]

supportsSchemaConstraints

supportsSchemaConstraints(): boolean

Inherited from SchemaHelper.supportsSchemaConstraints
Returns boolean

Page Options

Hide Inherited