Class: SchemaHelper#
knex.SchemaHelper
Hierarchy#
- SchemaHelper
Constructors#
constructor#
+ new SchemaHelper(): SchemaHelper
Returns: SchemaHelper
Methods#
databaseExists#
â–¸ databaseExists(connection: Connection, name: string): Promise<boolean>
Parameters:#
| Name | Type |
|---|---|
connection | Connection |
name | string |
Returns: Promise<boolean>
Defined in: packages/knex/src/schema/SchemaHelper.ts:182
finalizeTable#
â–¸ finalizeTable(table: TableBuilder, charset: string, collate?: string): void
Parameters:#
| Name | Type |
|---|---|
table | TableBuilder |
charset | string |
collate? | string |
Returns: void
Defined in: packages/knex/src/schema/SchemaHelper.ts:16
getColumns#
â–¸ getColumns(connection: AbstractSqlConnection, tableName: string, schemaName?: string): Promise<any[]>
Parameters:#
| Name | Type |
|---|---|
connection | AbstractSqlConnection |
tableName | string |
schemaName? | string |
Returns: Promise<any[]>
Defined in: packages/knex/src/schema/SchemaHelper.ts:93
getCreateDatabaseSQL#
â–¸ getCreateDatabaseSQL(name: string): string
Parameters:#
| Name | Type |
|---|---|
name | string |
Returns: string
Defined in: packages/knex/src/schema/SchemaHelper.ts:158
getDatabaseExistsSQL#
â–¸ getDatabaseExistsSQL(name: string): string
Parameters:#
| Name | Type |
|---|---|
name | string |
Returns: string
Defined in: packages/knex/src/schema/SchemaHelper.ts:166
getDatabaseNotExistsError#
â–¸ getDatabaseNotExistsError(dbName: string): string
Parameters:#
| Name | Type |
|---|---|
dbName | string |
Returns: string
Defined in: packages/knex/src/schema/SchemaHelper.ts:170
getDefaultEmptyString#
â–¸ getDefaultEmptyString(): string
Returns: string
Defined in: packages/knex/src/schema/SchemaHelper.ts:178
getDropDatabaseSQL#
â–¸ getDropDatabaseSQL(name: string): string
Parameters:#
| Name | Type |
|---|---|
name | string |
Returns: string
Defined in: packages/knex/src/schema/SchemaHelper.ts:162
getEnumDefinitions#
â–¸ getEnumDefinitions(connection: AbstractSqlConnection, tableName: string, schemaName?: string): Promise<Dictionary<any>>
Parameters:#
| Name | Type |
|---|---|
connection | AbstractSqlConnection |
tableName | string |
schemaName? | string |
Returns: Promise<Dictionary<any>>
Defined in: packages/knex/src/schema/SchemaHelper.ts:81
getForeignKeys#
â–¸ getForeignKeys(connection: AbstractSqlConnection, tableName: string, schemaName?: string): Promise<Dictionary<any>>
Parameters:#
| Name | Type |
|---|---|
connection | AbstractSqlConnection |
tableName | string |
schemaName? | string |
Returns: Promise<Dictionary<any>>
Defined in: packages/knex/src/schema/SchemaHelper.ts:76
getForeignKeysSQL#
â–¸ getForeignKeysSQL(tableName: string, schemaName?: string): string
Parameters:#
| Name | Type |
|---|---|
tableName | string |
schemaName? | string |
Returns: string
Defined in: packages/knex/src/schema/SchemaHelper.ts:101
getIndexName#
â–¸ getIndexName(tableName: string, columns: string[], type: index | unique | foreign): string
Returns the default name of index for the given columns
Parameters:#
| Name | Type |
|---|---|
tableName | string |
columns | string[] |
type | index | unique | foreign |
Returns: string
Defined in: packages/knex/src/schema/SchemaHelper.ts:108
getIndexes#
â–¸ getIndexes(connection: AbstractSqlConnection, tableName: string, schemaName?: string): Promise<Index[]>
Parameters:#
| Name | Type |
|---|---|
connection | AbstractSqlConnection |
tableName | string |
schemaName? | string |
Returns: Promise<Index[]>
Defined in: packages/knex/src/schema/SchemaHelper.ts:97
getListTablesSQL#
â–¸ getListTablesSQL(): string
Returns: string
Defined in: packages/knex/src/schema/SchemaHelper.ts:85
getManagementDbName#
â–¸ getManagementDbName(): string
Returns: string
Defined in: packages/knex/src/schema/SchemaHelper.ts:174
getPrimaryKeys#
â–¸ getPrimaryKeys(connection: AbstractSqlConnection, indexes: Index[], tableName: string, schemaName?: string): Promise<string[]>
Parameters:#
| Name | Type |
|---|---|
connection | AbstractSqlConnection |
indexes | Index[] |
tableName | string |
schemaName? | string |
Returns: Promise<string[]>
Defined in: packages/knex/src/schema/SchemaHelper.ts:72
getRenameColumnSQL#
â–¸ getRenameColumnSQL(tableName: string, from: Column, to: EntityProperty<any>, idx?: number, quote?: string): string
Parameters:#
| Name | Type | Default value |
|---|---|---|
tableName | string | - |
from | Column | - |
to | EntityProperty<any> | - |
idx | number | 0 |
quote | string | '"' |
Returns: string
Defined in: packages/knex/src/schema/SchemaHelper.ts:89
getSchemaBeginning#
â–¸ getSchemaBeginning(charset: string): string
Parameters:#
| Name | Type |
|---|---|
charset | string |
Returns: string
Defined in: packages/knex/src/schema/SchemaHelper.ts:8
getSchemaEnd#
â–¸ getSchemaEnd(): string
Returns: string
Defined in: packages/knex/src/schema/SchemaHelper.ts:12
getTypeDefinition#
â–¸ getTypeDefinition(prop: EntityProperty<any>, types?: Dictionary<string[]>, lengths?: Dictionary<number>, allowZero?: boolean): string
Parameters:#
| Name | Type | Default value |
|---|---|---|
prop | EntityProperty<any> | - |
types | Dictionary<string[]> | ... |
lengths | Dictionary<number> | ... |
allowZero | boolean | false |
Returns: string
Defined in: packages/knex/src/schema/SchemaHelper.ts:20
getTypeFromDefinition#
â–¸ getTypeFromDefinition(type: string, defaultType: string, types?: Dictionary<string[]>): string
Parameters:#
| Name | Type |
|---|---|
type | string |
defaultType | string |
types? | Dictionary<string[]> |
Returns: string
Defined in: packages/knex/src/schema/SchemaHelper.ts:62
hasSameDefaultValue#
â–¸ PrivatehasSameDefaultValue(info: Column, prop: EntityProperty<any>, defaultValues: Dictionary<string[]>): boolean
Parameters:#
| Name | Type |
|---|---|
info | Column |
prop | EntityProperty<any> |
defaultValues | Dictionary<string[]> |
Returns: boolean
Defined in: packages/knex/src/schema/SchemaHelper.ts:214
hasSameEnumDefinition#
â–¸ PrivatehasSameEnumDefinition(prop: EntityProperty<any>, column: Column): boolean
Parameters:#
| Name | Type |
|---|---|
prop | EntityProperty<any> |
column | Column |
Returns: boolean
Defined in: packages/knex/src/schema/SchemaHelper.ts:251
hasSameIndex#
â–¸ PrivatehasSameIndex(prop: EntityProperty<any>, column: Column): boolean
Parameters:#
| Name | Type |
|---|---|
prop | EntityProperty<any> |
column | Column |
Returns: boolean
Defined in: packages/knex/src/schema/SchemaHelper.ts:241
hasSameType#
â–¸ PrivatehasSameType(columnType: string, infoType: string, types: Dictionary<string[]>): boolean
Parameters:#
| Name | Type |
|---|---|
columnType | string |
infoType | string |
types | Dictionary<string[]> |
Returns: boolean
Defined in: packages/knex/src/schema/SchemaHelper.ts:195
indexForeignKeys#
â–¸ indexForeignKeys(): boolean
Returns: boolean
Defined in: packages/knex/src/schema/SchemaHelper.ts:51
isImplicitIndex#
â–¸ isImplicitIndex(name: string): boolean
Implicit indexes will be ignored when diffing
Parameters:#
| Name | Type |
|---|---|
name | string |
Returns: boolean
Defined in: packages/knex/src/schema/SchemaHelper.ts:58
isSame#
â–¸ isSame(prop: EntityProperty<any>, column: Column, idx?: number, types?: Dictionary<string[]>, defaultValues?: Dictionary<string[]>): IsSame
Parameters:#
| Name | Type | Default value |
|---|---|---|
prop | EntityProperty<any> | - |
column | Column | - |
idx | number | 0 |
types | Dictionary<string[]> | ... |
defaultValues | Dictionary<string[]> | ... |
Returns: IsSame
Defined in: packages/knex/src/schema/SchemaHelper.ts:36
mapForeignKeys#
â–¸ mapForeignKeys(fks: any[]): Dictionary<any>
Parameters:#
| Name | Type |
|---|---|
fks | any[] |
Returns: Dictionary<any>
Defined in: packages/knex/src/schema/SchemaHelper.ts:116
normalizeDefaultValue#
â–¸ normalizeDefaultValue(defaultValue: string, length: number, defaultValues?: Dictionary<string[]>): string | number
Parameters:#
| Name | Type | Default value |
|---|---|---|
defaultValue | string | - |
length | number | - |
defaultValues | Dictionary<string[]> | ... |
Returns: string | number
Defined in: packages/knex/src/schema/SchemaHelper.ts:147
processTypeWildCard#
â–¸ PrivateprocessTypeWildCard(prop: EntityProperty<any>, lengths: Dictionary<number>, propType: string, allowZero: boolean, type: string): string
Parameters:#
| Name | Type |
|---|---|
prop | EntityProperty<any> |
lengths | Dictionary<number> |
propType | string |
allowZero | boolean |
type | string |
Returns: string
Defined in: packages/knex/src/schema/SchemaHelper.ts:131
supportsColumnAlter#
â–¸ supportsColumnAlter(): boolean
Returns: boolean
Defined in: packages/knex/src/schema/SchemaHelper.ts:143
supportsSchemaConstraints#
â–¸ supportsSchemaConstraints(): boolean
Returns: boolean
Defined in: packages/knex/src/schema/SchemaHelper.ts:47