Skip to main content

Version: Next

SqliteSchemaHelper

Hierarchy

SchemaHelper
- SqliteSchemaHelper

Index

Constructors

constructor

Accessors

options

Methods

Constructors

constructor

new SqliteSchemaHelper(platform): SqliteSchemaHelper

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

Accessors

inheritedoptions

get options(): { createForeignKeyConstraints?: boolean; defaultDeleteRule?: cascade | no action | set null | set default | restrict; defaultUpdateRule?: cascade | no action | set null | set default | restrict; disableForeignKeys?: boolean; ignoreSchema?: string[]; managementDbName?: string; skipColumns?: Dictionary<(string | RegExp)[]>; skipTables?: (string | RegExp)[]; skipViews?: (string | RegExp)[] }

Inherited from SchemaHelper.options
Returns { createForeignKeyConstraints?: boolean; defaultDeleteRule?: cascade | no action | set null | set default | restrict; defaultUpdateRule?: cascade | no action | set null | set default | restrict; disableForeignKeys?: boolean; ignoreSchema?: string[]; managementDbName?: string; skipColumns?: Dictionary<(string | RegExp)[]>; skipTables?: (string | RegExp)[]; skipViews?: (string | RegExp)[] }
- optionalcreateForeignKeyConstraints?: boolean
  Generate foreign key constraints.
- optionaldefaultDeleteRule?: cascade | no action | set null | set default | restrict
  Default ON DELETE rule for foreign keys. When not set, no rule is emitted and the database uses its native default (NO ACTION/RESTRICT).
- optionaldefaultUpdateRule?: cascade | no action | set null | set default | restrict
  Default ON UPDATE rule for foreign keys. When not set, no rule is emitted and the database uses its native default (NO ACTION/RESTRICT).
- optionaldisableForeignKeys?: boolean
  Try to disable foreign key checks during schema operations.
- optionalignoreSchema?: string[]
  Schema names to ignore when comparing schemas.
- optionalmanagementDbName?: string
  Database name to use for management operations (e.g., creating/dropping databases).
- optionalskipColumns?: Dictionary<(string | RegExp)[]>
  Column names or patterns to skip during schema generation, keyed by table name.
- optionalskipTables?: (string | RegExp)[]
  Table names or patterns to skip during schema generation.
- optionalskipViews?: (string | RegExp)[]
  View names or patterns to skip during schema generation (e.g. PostGIS system views).

Methods

alterTable

alterTable(diff, safe): string[]

Overrides SchemaHelper.alterTable
Parameters
- diff: TableDifference
- optionalsafe: boolean
Returns string[]

inheritedalterTableColumn

alterTableColumn(column, table, changedProperties): string[]

Inherited from SchemaHelper.alterTableColumn
Parameters
- column: Column
- table: DatabaseTable
- changedProperties: Set<string>
Returns string[]

inheritedalterTableComment

alterTableComment(table, comment): string

Inherited from SchemaHelper.alterTableComment
Parameters
- table: DatabaseTable
- optionalcomment: string
Returns string

inheritedappend

append(array, sql, pad): void

Inherited from SchemaHelper.append
Parameters
- array: string[]
- sql: string | string[]
- pad: boolean = false
Returns void

inheritedappendComments

appendComments(table): string[]

Inherited from SchemaHelper.appendComments
Parameters
- table: DatabaseTable
Returns string[]

inheritedcastColumn

castColumn(name, type): string

Inherited from SchemaHelper.castColumn
Parameters
- name: string
- type: string
Returns string

inheritedcreateCheck

createCheck(table, check): string

Inherited from SchemaHelper.createCheck
Parameters
- table: DatabaseTable
- check: CheckDef<unknown>
Returns string

inheritedcreateForeignKey

createForeignKey(table, foreignKey, alterTable, inline): string

Inherited from SchemaHelper.createForeignKey
Parameters
- table: DatabaseTable
- foreignKey: ForeignKey
- alterTable: boolean = true
- inline: boolean = false
Returns string

inheritedcreateIndex

createIndex(index, table, createPrimary): string

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

inheritedcreateMaterializedView

createMaterializedView(name, schema, definition, withData): string

Inherited from SchemaHelper.createMaterializedView
Parameters
- name: string
- schema: undefined | string
- definition: string
- withData: boolean = true
Returns string

createTable

createTable(table, alter): string[]

Overrides SchemaHelper.createTable
Parameters
- table: DatabaseTable
- optionalalter: boolean
Returns string[]

createTableColumn

createTableColumn(column, table, _changedProperties): undefined | string

Overrides SchemaHelper.createTableColumn
Parameters
- column: Column
- table: DatabaseTable
- optional_changedProperties: Set<string>
Returns undefined | string

inheritedcreateView

createView(name, schema, definition): string

Inherited from SchemaHelper.createView
Parameters
- name: string
- schema: undefined | string
- definition: string
Returns string

databaseExists

databaseExists(connection, name): Promise<boolean>

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

disableForeignKeysSQL

disableForeignKeysSQL(): string

Overrides SchemaHelper.disableForeignKeysSQL
Returns string

inheriteddropConstraint

dropConstraint(table, name): string

Inherited from SchemaHelper.dropConstraint
Parameters
- table: string
- name: string
Returns string

dropForeignKey

dropForeignKey(tableName, constraintName): string

Overrides SchemaHelper.dropForeignKey
Parameters
- tableName: string
- constraintName: string
Returns string

dropIndex

dropIndex(table, index, oldIndexName): string

Overrides SchemaHelper.dropIndex
Parameters
- table: string
- index: IndexDef
- oldIndexName: string = index.keyName
Returns string

inheriteddropMaterializedViewIfExists

dropMaterializedViewIfExists(name, schema): string

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

inheriteddropTableIfExists

dropTableIfExists(name, schema): string

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

inheriteddropViewIfExists

dropViewIfExists(name, schema): string

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

enableForeignKeysSQL

enableForeignKeysSQL(): string

Overrides SchemaHelper.enableForeignKeysSQL
Returns string

inheritedfinalizeTable

finalizeTable(table, charset, collate): string

Inherited from SchemaHelper.finalizeTable
Parameters
- table: DatabaseTable
- charset: string
- optionalcollate: string
Returns string

getAddColumnsSQL

getAddColumnsSQL(table, columns, diff): string[]

Overrides SchemaHelper.getAddColumnsSQL
Parameters
- table: DatabaseTable
- columns: Column[]
- optionaldiff: TableDifference
Returns string[]

getAllTables

getAllTables(connection, schemas): Promise<Table[]>

Overrides SchemaHelper.getAllTables
Parameters
- connection: AbstractSqlConnection
- optionalschemas: string[]
Returns Promise<Table[]>

inheritedgetAlterNativeEnumSQL

getAlterNativeEnumSQL(name, schema, value, items, oldItems): string

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

inheritedgetChangeColumnCommentSQL

getChangeColumnCommentSQL(tableName, to, schemaName): string

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

getCreateDatabaseSQL

getCreateDatabaseSQL(name): string

Overrides SchemaHelper.getCreateDatabaseSQL
Parameters
- name: string
Returns string

getCreateIndexSQL

getCreateIndexSQL(tableName, index): string

Overrides SchemaHelper.getCreateIndexSQL
Parameters
- tableName: string
- index: IndexDef
Returns string

getCreateNamespaceSQL

getCreateNamespaceSQL(name): string

Overrides SchemaHelper.getCreateNamespaceSQL
Parameters
- name: string
Returns string

inheritedgetCreateNativeEnumSQL

getCreateNativeEnumSQL(name, values, schema): string

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

inheritedgetDatabaseExistsSQL

getDatabaseExistsSQL(name): string

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

inheritedgetDatabaseNotExistsError

getDatabaseNotExistsError(dbName): string

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

inheritedgetDefaultEmptyString

getDefaultEmptyString(): string

Inherited from SchemaHelper.getDefaultEmptyString
Returns string

getDropColumnsSQL

getDropColumnsSQL(tableName, columns, schemaName): string

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

getDropDatabaseSQL

getDropDatabaseSQL(name): string

Overrides SchemaHelper.getDropDatabaseSQL
Parameters
- name: string
Returns string

inheritedgetDropIndexSQL

getDropIndexSQL(tableName, index): string

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

getDropNamespaceSQL

getDropNamespaceSQL(name): string

Overrides SchemaHelper.getDropNamespaceSQL
Parameters
- name: string
Returns string

inheritedgetDropNativeEnumSQL

getDropNativeEnumSQL(name, schema): string

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

inheritedgetListMaterializedViewsSQL

getListMaterializedViewsSQL(): string

Inherited from SchemaHelper.getListMaterializedViewsSQL
Returns string

getListTablesSQL

getListTablesSQL(): string

Overrides SchemaHelper.getListTablesSQL
Returns string

getListViewsSQL

getListViewsSQL(): string

Overrides SchemaHelper.getListViewsSQL
Returns string

getManagementDbName

getManagementDbName(): string

Overrides SchemaHelper.getManagementDbName
Returns string

getNamespaces

getNamespaces(connection): Promise<string[]>

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

inheritedgetPostAlterTable

getPostAlterTable(tableDiff, safe): string[]

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

inheritedgetPreAlterTable

getPreAlterTable(tableDiff, safe): string[]

Inherited from SchemaHelper.getPreAlterTable
Parameters
- tableDiff: TableDifference
- safe: boolean
Returns string[]

getPrimaryKeys

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

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

getReferencedTableName

getReferencedTableName(referencedTableName, schema): string

Overrides SchemaHelper.getReferencedTableName
SQLite does not support schema-qualified table names in REFERENCES clauses. Foreign key references can only point to tables in the same database.
Parameters
- referencedTableName: string
- optionalschema: string
Returns string

inheritedgetRenameColumnSQL

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

Inherited from SchemaHelper.getRenameColumnSQL
Parameters
- tableName: string
- oldColumnName: string
- to: Column
- optionalschemaName: string
Returns string

inheritedgetRenameIndexSQL

getRenameIndexSQL(tableName, index, oldIndexName): string[]

Inherited from SchemaHelper.getRenameIndexSQL
Parameters
- tableName: string
- index: IndexDef
- oldIndexName: string
Returns string[]

inheritedgetSchemaBeginning

getSchemaBeginning(_charset, disableForeignKeys): string

Inherited from SchemaHelper.getSchemaBeginning
Parameters
- _charset: string
- optionaldisableForeignKeys: boolean
Returns string

inheritedgetSchemaEnd

getSchemaEnd(disableForeignKeys): string

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

inheritedgetTablesGroupedBySchemas

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

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

inheritedhasNonDefaultPrimaryKeyName

hasNonDefaultPrimaryKeyName(table): boolean

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

inheritedinferLengthFromColumnType

inferLengthFromColumnType(type): undefined | number

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

isImplicitIndex

isImplicitIndex(name): boolean

Implicit indexes will be ignored when diffing
Parameters
- name: string
Returns boolean

loadInformationSchema

loadInformationSchema(schema, connection, tables, schemas): Promise<void>

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

inheritedloadMaterializedViews

loadMaterializedViews(schema, connection, schemaName): Promise<void>

Inherited from SchemaHelper.loadMaterializedViews
Parameters
- schema: DatabaseSchema
- connection: AbstractSqlConnection
- optionalschemaName: string
Returns Promise<void>

loadViews

loadViews(schema, connection, schemaName): Promise<void>

Overrides SchemaHelper.loadViews
Parameters
- schema: DatabaseSchema
- connection: AbstractSqlConnection
- optionalschemaName: string
Returns Promise<void>

inheritedmapForeignKeys

mapForeignKeys(fks, tableName, schemaName): Dictionary

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

inheritednormalizeDefaultValue

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

Inherited from SchemaHelper.normalizeDefaultValue
Parameters
- defaultValue: string | RawQueryFragment<string>
- optionallength: number
- defaultValues: Dictionary<string[]> = {}
Returns string | number

inheritedrefreshMaterializedView

refreshMaterializedView(name, schema, concurrently): string

Inherited from SchemaHelper.refreshMaterializedView
Parameters
- name: string
- optionalschema: string
- concurrently: boolean = false
Returns string

inheritedsplitTableName

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

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

supportsSchemaConstraints

supportsSchemaConstraints(): boolean

Overrides SchemaHelper.supportsSchemaConstraints
Returns boolean

Page Options

Hide Inherited