abstractSchemaHelper

Hierarchy

• SchemaHelper
  • MySqlSchemaHelper
  • BaseSqliteSchemaHelper
  • PostgreSqlSchemaHelper
  • MsSqlSchemaHelper

Index

Constructors

• constructor

Accessors

• knex
• options

Methods

• configureColumn
• configureColumnDefault
• createCheck
• createForeignKey
• createIndex
• createSchemaBuilder
• createTable
• createTableColumn
• databaseExists
• disableForeignKeysSQL
• dump
• enableForeignKeysSQL
• finalizeTable
• getAlterColumnAutoincrement
• getAlterNativeEnumSQL
• getAlterTable
• getChangeColumnCommentSQL
• getChecks
• getColumns
• getCreateDatabaseSQL
• getCreateIndexSQL
• getCreateNamespaceSQL
• getCreateNativeEnumSQL
• getDatabaseExistsSQL
• getDatabaseNotExistsError
• getDefaultEmptyString
• getDropColumnsSQL
• getDropDatabaseSQL
• getDropIndexSQL
• getDropNamespaceSQL
• getDropNativeEnumSQL
• getEnumDefinitions
• getForeignKeys
• getForeignKeysSQL
• getIndexes
• getListTablesSQL
• getManagementDbName
• getNamespaces
• getPostAlterTable
• getPreAlterTable
• getPrimaryKeys
• getReferencedTableName
• getRenameColumnSQL
• getRenameIndexSQL
• getSchemaBeginning
• getSchemaEnd
• getTablesGroupedBySchemas
• hasNonDefaultPrimaryKeyName
• inferLengthFromColumnType
• loadInformationSchema
• mapForeignKeys
• normalizeDefaultValue
• pushTableQuery
• splitTableName
• supportsSchemaConstraints

Constructors

constructor

• new SchemaHelper(platform: AbstractSqlPlatform): SchemaHelper

• Parameters

  • platform: AbstractSqlPlatform

  Returns SchemaHelper

Accessors

knex

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

• Returns Knex<any, any[]>

options

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

• 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

• 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

• Parameters

  • column: Column

  • col: ColumnBuilder

  • knex: Knex<any, any[]>

  • optionalchangedProperties: Set<string>

  Returns ColumnBuilder

createCheck

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

• Parameters

  • table: CreateTableBuilder

  • check: CheckDef<unknown>

  Returns void

createForeignKey

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

• Parameters

  • table: CreateTableBuilder

  • foreignKey: ForeignKey

  • optionalschema: string

  Returns void

createIndex

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

• Parameters

  • table: CreateTableBuilder

  • index: IndexDef

  • tableDef: DatabaseTable

  • createPrimary: boolean = false

  Returns void

createSchemaBuilder

• createSchemaBuilder(schema?: string): SchemaBuilder

• Parameters

  • optionalschema: string

  Returns SchemaBuilder

createTable

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

• Parameters

  • tableDef: DatabaseTable

  • optionalalter: boolean

  Returns SchemaBuilder

createTableColumn

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

• Parameters

  • table: TableBuilder

  • column: Column

  • fromTable: DatabaseTable

  • optionalchangedProperties: Set<string>

  • optionalalter: boolean

  Returns undefined | ColumnBuilder

databaseExists

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

• Parameters

  • connection: Connection

  • name: string

  Returns Promise<boolean>

disableForeignKeysSQL

• disableForeignKeysSQL(): string

• Returns string

dump

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

• Parameters

  • builder: string | SchemaBuilder

  • append: string

  Returns Promise<string>

enableForeignKeysSQL

• enableForeignKeysSQL(): string

• Returns string

finalizeTable

• finalizeTable(table: TableBuilder, charset: string, collate?: string): void

• Parameters

  • table: TableBuilder

  • charset: string

  • optionalcollate: string

  Returns void

getAlterColumnAutoincrement

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

• Parameters

  • tableName: string

  • column: Column

  • optionalschemaName: string

  Returns string

getAlterNativeEnumSQL

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

• Parameters

  • name: string

  • optionalschema: string

  • optionalvalue: string

  • optionalitems: string[]

  • optionaloldItems: string[]

  Returns string

optionalgetAlterTable

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

• Parameters

  • changedTable: TableDifference

  • optionalwrap: boolean

  Returns Promise<string>

getChangeColumnCommentSQL

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

• Parameters

  • tableName: string

  • to: Column

  • optionalschemaName: string

  Returns string

getChecks

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

• Parameters

  • connection: AbstractSqlConnection

  • tableName: string

  • optionalschemaName: string

  • optionalcolumns: Column[]

  Returns Promise<CheckDef<unknown>[]>

getColumns

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

• Parameters

  • connection: AbstractSqlConnection

  • tableName: string

  • optionalschemaName: string

  Returns Promise<Column[]>

getCreateDatabaseSQL

• getCreateDatabaseSQL(name: string): string

• Parameters

  • name: string

  Returns string

getCreateIndexSQL

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

• Parameters

  • tableName: string

  • index: IndexDef

  • partialExpression: boolean = false

  Returns string

getCreateNamespaceSQL

• getCreateNamespaceSQL(name: string): string

• Parameters

  • name: string

  Returns string

getCreateNativeEnumSQL

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

• Parameters

  • name: string

  • values: unknown[]

  • optionalschema: string

  Returns string

getDatabaseExistsSQL

• getDatabaseExistsSQL(name: string): string

• Parameters

  • name: string

  Returns string

getDatabaseNotExistsError

• getDatabaseNotExistsError(dbName: string): string

• Parameters

  • dbName: string

  Returns string

getDefaultEmptyString

• getDefaultEmptyString(): string

• Returns string

getDropColumnsSQL

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

• Parameters

  • tableName: string

  • columns: Column[]

  • optionalschemaName: string

  Returns string

getDropDatabaseSQL

• getDropDatabaseSQL(name: string): string

• Parameters

  • name: string

  Returns string

getDropIndexSQL

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

• Parameters

  • tableName: string

  • index: IndexDef

  Returns string

getDropNamespaceSQL

• getDropNamespaceSQL(name: string): string

• Parameters

  • name: string

  Returns string

getDropNativeEnumSQL

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

• Parameters

  • name: string

  • optionalschema: string

  Returns string

getEnumDefinitions

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

• Parameters

  • connection: AbstractSqlConnection

  • checks: CheckDef<unknown>[]

  • tableName: string

  • optionalschemaName: string

  Returns Promise<Dictionary<string[]>>

getForeignKeys

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

• Parameters

  • connection: AbstractSqlConnection

  • tableName: string

  • optionalschemaName: string

  Returns Promise<Dictionary>

getForeignKeysSQL

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

• Parameters

  • tableName: string

  • optionalschemaName: string

  Returns string

getIndexes

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

• Parameters

  • connection: AbstractSqlConnection

  • tableName: string

  • optionalschemaName: string

  Returns Promise<IndexDef[]>

getListTablesSQL

• getListTablesSQL(schemaName?: string): string

• Parameters

  • optionalschemaName: string

  Returns string

getManagementDbName

• getManagementDbName(): string

• Returns string

getNamespaces

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

• Parameters

  • connection: AbstractSqlConnection

  Returns Promise<string[]>

getPostAlterTable

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

• Parameters

  • tableDiff: TableDifference

  • safe: boolean

  Returns string

getPreAlterTable

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

• Parameters

  • tableDiff: TableDifference

  • safe: boolean

  Returns string

getPrimaryKeys

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

• Parameters

  • connection: AbstractSqlConnection

  • indexes: IndexDef[] = []

  • tableName: string

  • optionalschemaName: string

  Returns Promise<string[]>

getReferencedTableName

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

• Parameters

  • referencedTableName: string

  • optionalschema: string

  Returns string

getRenameColumnSQL

• getRenameColumnSQL(tableName: string, oldColumnName: string, to: Column, schemaName?: string): string

• Parameters

  • tableName: string

  • oldColumnName: string

  • to: Column

  • optionalschemaName: string

  Returns string

getRenameIndexSQL

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

• Parameters

  • tableName: string

  • index: IndexDef

  • oldIndexName: string

  Returns string

getSchemaBeginning

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

• Parameters

  • charset: string

  • optionaldisableForeignKeys: boolean

  Returns string

getSchemaEnd

• getSchemaEnd(disableForeignKeys?: boolean): string

• Parameters

  • optionaldisableForeignKeys: boolean

  Returns string

getTablesGroupedBySchemas

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

• Parameters

  • tables: Table[]

  Returns Map<undefined | string, Table[]>

hasNonDefaultPrimaryKeyName

• hasNonDefaultPrimaryKeyName(table: DatabaseTable): boolean

• Parameters

  • table: DatabaseTable

  Returns boolean

inferLengthFromColumnType

• inferLengthFromColumnType(type: string): undefined | number

• Parameters

  • type: string

  Returns undefined | number

loadInformationSchema

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

• Parameters

  • schema: DatabaseSchema

  • connection: AbstractSqlConnection

  • tables: Table[]

  • optionalschemas: string[]

  Returns Promise<void>

mapForeignKeys

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

• Parameters

  • fks: any[]

  • tableName: string

  • optionalschemaName: string

  Returns Dictionary

normalizeDefaultValue

• normalizeDefaultValue(defaultValue: string, length?: number, defaultValues?: Dictionary<string[]>): string | number

• Parameters

  • defaultValue: string

  • optionallength: number

  • defaultValues: Dictionary<string[]> = {}

  Returns string | number

pushTableQuery

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

• 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]

• Parameters

  • name: string

  Returns [undefined | string, string]

supportsSchemaConstraints

• supportsSchemaConstraints(): boolean

• Returns boolean