PostgreSqlSchemaHelper

Hierarchy

• SchemaHelper
  • PostgreSqlSchemaHelper

Index

Constructors

• constructor

Properties

• DEFAULT_VALUES

Methods

• configureColumn
• configureColumnDefault
• createTableColumn
• databaseExists
• disableForeignKeysSQL
• enableForeignKeysSQL
• finalizeTable
• getAllChecks
• getAllColumns
• getAllForeignKeys
• getAllIndexes
• getAlterColumnAutoincrement
• getAlterNativeEnumSQL
• getChangeColumnCommentSQL
• getChecks
• getColumns
• getCreateDatabaseSQL
• getCreateIndexSQL
• getCreateNamespaceSQL
• getCreateNativeEnumSQL
• getDatabaseExistsSQL
• getDatabaseNotExistsError
• getDefaultEmptyString
• getDropColumnsSQL
• getDropDatabaseSQL
• getDropIndexSQL
• getDropNamespaceSQL
• getDropNativeEnumSQL
• getEnumDefinitions
• getForeignKeys
• getForeignKeysSQL
• getIndexes
• getListTablesSQL
• getManagementDbName
• getNamespaces
• getNativeEnumDefinitions
• getPostAlterTable
• getPreAlterTable
• getPrimaryKeys
• getRenameColumnSQL
• getRenameIndexSQL
• getSchemaBeginning
• getSchemaEnd
• hasNonDefaultPrimaryKeyName
• inferLengthFromColumnType
• loadInformationSchema
• mapForeignKeys
• normalizeDefaultValue
• pushTableQuery
• supportsSchemaConstraints

Constructors

constructor

• new PostgreSqlSchemaHelper(platform: AbstractSqlPlatform): PostgreSqlSchemaHelper

• Inherited from SchemaHelper.constructor

  Parameters

  • platform: AbstractSqlPlatform

  Returns PostgreSqlSchemaHelper

Properties

staticreadonlyDEFAULT_VALUES

DEFAULT_VALUES: { ('now'::text)::timestamp(?) with time zone: string[]; ('now'::text)::timestamp(?) without time zone: string[]; current_timestamp(?): string[]; now(): string[]; null::character varying: string[]; null::timestamp with time zone: string[]; null::timestamp without time zone: string[] } = ...

Type declaration

• ('now'::text)::timestamp(?) with time zone: string[]

• ('now'::text)::timestamp(?) without time zone: string[]

• current_timestamp(?): string[]

• now(): string[]

• null::character varying: string[]

• null::timestamp with time zone: string[]

• null::timestamp without time zone: string[]

Methods

configureColumn

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

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

• Inherited from SchemaHelper.configureColumnDefault

  Parameters

  • column: Column

  • col: ColumnBuilder

  • knex: Knex<any, any[]>

  • optionalchangedProperties: Set<string>

  Returns ColumnBuilder

createTableColumn

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

• Overrides SchemaHelper.createTableColumn

  Parameters

  • table: TableBuilder

  • 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

enableForeignKeysSQL

• enableForeignKeysSQL(): string

• Overrides SchemaHelper.enableForeignKeysSQL

  Returns string

finalizeTable

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

• Inherited from SchemaHelper.finalizeTable

  Parameters

  • table: TableBuilder

  • 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[], nativeEnums?: Dictionary<{ items: string[]; name: string; schema?: string }>): Promise<Dictionary<Column[]>>

• Parameters

  • connection: AbstractSqlConnection

  • tables: Table[]

  • optionalnativeEnums: Dictionary<{ items: string[]; name: string; schema?: string }>

  Returns Promise<Dictionary<Column[]>>

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

• Overrides SchemaHelper.getAlterColumnAutoincrement

  Parameters

  • tableName: string

  • column: Column

  • optionalschemaName: string

  Returns string

getAlterNativeEnumSQL

• getAlterNativeEnumSQL(name: string, schema?: string, value?: string): string

• Overrides SchemaHelper.getAlterNativeEnumSQL

  Parameters

  • name: string

  • optionalschema: string

  • optionalvalue: string

  Returns 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

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

• Overrides SchemaHelper.getCreateNativeEnumSQL

  Parameters

  • name: string

  • values: unknown[]

  • optionalschema: string

  Returns string

getDatabaseExistsSQL

• getDatabaseExistsSQL(name: string): string

• Overrides SchemaHelper.getDatabaseExistsSQL

  Parameters

  • name: string

  Returns string

getDatabaseNotExistsError

• getDatabaseNotExistsError(dbName: string): string

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

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

  • optionaltableName: 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

• Inherited from 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

• Overrides SchemaHelper.getManagementDbName

  Returns string

getNamespaces

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

• Overrides SchemaHelper.getNamespaces

  Parameters

  • connection: AbstractSqlConnection

  Returns Promise<string[]>

getNativeEnumDefinitions

• getNativeEnumDefinitions(connection: AbstractSqlConnection, schemas: string[]): Promise<Dictionary<{ items: string[]; name: string; schema?: string }>>

• Parameters

  • connection: AbstractSqlConnection

  • schemas: string[]

  Returns Promise<Dictionary<{ items: string[]; name: string; schema?: string }>>

getPostAlterTable

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

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

getRenameColumnSQL

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

• Inherited from SchemaHelper.getRenameColumnSQL

  Parameters

  • tableName: string

  • oldColumnName: string

  • to: Column

  • optionalschemaName: string

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

• Overrides SchemaHelper.getSchemaBeginning

  Parameters

  • charset: string

  Returns string

getSchemaEnd

• getSchemaEnd(): string

• Inherited from SchemaHelper.getSchemaEnd

  Returns string

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[], schemas?: string[]): Promise<void>

• Overrides SchemaHelper.loadInformationSchema

  Parameters

  • schema: DatabaseSchema

  • connection: AbstractSqlConnection

  • tables: Table[]

  • optionalschemas: string[]

  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

supportsSchemaConstraints

• supportsSchemaConstraints(): boolean

• Inherited from SchemaHelper.supportsSchemaConstraints

  Returns boolean