Skip to main content
Version: Next

SqliteSchemaHelper

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Accessors

inheritedknex

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

  • Returns Knex<any, any[]>

inheritedoptions

  • get options(): { createForeignKeyConstraints?: boolean; disableForeignKeys?: boolean; ignoreSchema?: string[]; managementDbName?: string; skipColumns?: Dictionary<(string | RegExp)[]>; skipTables?: (string | RegExp)[] }

  • Returns { createForeignKeyConstraints?: boolean; disableForeignKeys?: boolean; ignoreSchema?: string[]; managementDbName?: string; skipColumns?: Dictionary<(string | RegExp)[]>; skipTables?: (string | RegExp)[] }

    • optionalcreateForeignKeyConstraints?: boolean
    • optionaldisableForeignKeys?: boolean
    • optionalignoreSchema?: string[]
    • optionalmanagementDbName?: string
    • optionalskipColumns?: Dictionary<(string | RegExp)[]>
    • optionalskipTables?: (string | RegExp)[]

Methods

inheritedconfigureColumn

  • configureColumn(column, col, knex, changedProperties): ColumnBuilder

  • Parameters

    • column: Column
    • col: ColumnBuilder
    • knex: Knex<any, any[]>
    • optionalchangedProperties: Set<string>

    Returns ColumnBuilder

inheritedconfigureColumnDefault

  • configureColumnDefault(column, col, knex, changedProperties): ColumnBuilder

  • Parameters

    • column: Column
    • col: ColumnBuilder
    • knex: Knex<any, any[]>
    • optionalchangedProperties: Set<string>

    Returns ColumnBuilder

inheritedcreateCheck

  • createCheck(table, check): void

  • Parameters

    • table: CreateTableBuilder
    • check: CheckDef<unknown>

    Returns void

inheritedcreateForeignKey

  • createForeignKey(table, foreignKey, schema): void

  • Parameters

    • table: CreateTableBuilder
    • foreignKey: ForeignKey
    • optionalschema: string

    Returns void

inheritedcreateIndex

  • createIndex(table, index, tableDef, createPrimary): void

  • Parameters

    • table: CreateTableBuilder
    • index: IndexDef
    • tableDef: DatabaseTable
    • createPrimary: boolean = false

    Returns void

inheritedcreateSchemaBuilder

  • createSchemaBuilder(schema): SchemaBuilder

  • Parameters

    • optionalschema: string

    Returns SchemaBuilder

inheritedcreateTable

  • createTable(tableDef, alter): SchemaBuilder

  • Parameters

    • tableDef: DatabaseTable
    • optionalalter: boolean

    Returns SchemaBuilder

inheritedcreateTableColumn

  • createTableColumn(table, column, fromTable, changedProperties, alter): undefined | ColumnBuilder

  • Parameters

    • table: TableBuilder
    • column: Column
    • fromTable: DatabaseTable
    • optionalchangedProperties: Set<string>
    • optionalalter: boolean

    Returns undefined | ColumnBuilder

inheriteddatabaseExists

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

  • Parameters

    Returns Promise<boolean>

inheriteddisableForeignKeysSQL

  • disableForeignKeysSQL(): string

  • Returns string

inheriteddump

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

  • Parameters

    • builder: string | SchemaBuilder
    • append: string

    Returns Promise<string>

inheritedenableForeignKeysSQL

  • enableForeignKeysSQL(): string

  • Returns string

inheritedfinalizeTable

  • finalizeTable(table, charset, collate): void

  • Parameters

    • table: TableBuilder
    • charset: string
    • optionalcollate: string

    Returns void

inheritedgetAlterColumnAutoincrement

  • getAlterColumnAutoincrement(tableName, column, schemaName): string

  • Parameters

    • tableName: string
    • column: Column
    • optionalschemaName: string

    Returns string

inheritedgetAlterNativeEnumSQL

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

  • Parameters

    • name: string
    • optionalschema: string
    • optionalvalue: string
    • optionalitems: string[]
    • optionaloldItems: string[]

    Returns string

inheritedgetAlterTable

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

  • Parameters

    Returns Promise<string>

inheritedgetChangeColumnCommentSQL

  • getChangeColumnCommentSQL(tableName, to, schemaName): string

  • Parameters

    • tableName: string
    • to: Column
    • optionalschemaName: string

    Returns string

inheritedgetChecks

  • getChecks(connection, tableName, schemaName): Promise<CheckDef<unknown>[]>

  • Parameters

    Returns Promise<CheckDef<unknown>[]>

inheritedgetColumns

  • getColumns(connection, tableName, schemaName): Promise<any[]>

  • Parameters

    Returns Promise<any[]>

inheritedgetCreateDatabaseSQL

  • getCreateDatabaseSQL(name): string

  • Parameters

    • name: string

    Returns string

inheritedgetCreateIndexSQL

  • getCreateIndexSQL(tableName, index, partialExpression): string

  • Parameters

    • tableName: string
    • index: IndexDef
    • partialExpression: boolean = false

    Returns string

inheritedgetCreateNamespaceSQL

  • getCreateNamespaceSQL(name): string

  • Parameters

    • name: string

    Returns string

inheritedgetCreateNativeEnumSQL

  • getCreateNativeEnumSQL(name, values, schema): string

  • Parameters

    • name: string
    • values: unknown[]
    • optionalschema: string

    Returns string

inheritedgetDatabaseExistsSQL

  • getDatabaseExistsSQL(name): string

  • Parameters

    • name: string

    Returns string

inheritedgetDatabaseNotExistsError

  • getDatabaseNotExistsError(dbName): string

  • Parameters

    • dbName: string

    Returns string

inheritedgetDefaultEmptyString

  • getDefaultEmptyString(): string

  • Returns string

inheritedgetDropColumnsSQL

  • getDropColumnsSQL(tableName, columns, schemaName): string

  • Parameters

    • tableName: string
    • columns: Column[]
    • optionalschemaName: string

    Returns string

inheritedgetDropDatabaseSQL

  • getDropDatabaseSQL(name): string

  • Parameters

    • name: string

    Returns string

inheritedgetDropIndexSQL

  • getDropIndexSQL(tableName, index): string

  • Parameters

    Returns string

inheritedgetDropNamespaceSQL

  • getDropNamespaceSQL(name): string

  • Parameters

    • name: string

    Returns string

inheritedgetDropNativeEnumSQL

  • getDropNativeEnumSQL(name, schema): string

  • Parameters

    • name: string
    • optionalschema: string

    Returns string

inheritedgetEnumDefinitions

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

  • Parameters

    Returns Promise<Dictionary<string[]>>

inheritedgetForeignKeys

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

  • Parameters

    Returns Promise<Dictionary>

inheritedgetForeignKeysSQL

  • getForeignKeysSQL(tableName): string

  • Parameters

    • tableName: string

    Returns string

inheritedgetIndexes

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

  • Parameters

    Returns Promise<IndexDef[]>

inheritedgetListTablesSQL

  • getListTablesSQL(): string

  • Returns string

inheritedgetManagementDbName

  • getManagementDbName(): string

  • Returns string

inheritedgetNamespaces

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

  • Parameters

    Returns Promise<string[]>

inheritedgetPostAlterTable

  • getPostAlterTable(tableDiff, safe): string

  • Parameters

    Returns string

inheritedgetPreAlterTable

  • getPreAlterTable(tableDiff, safe): string

  • Parameters

    Returns string

inheritedgetPrimaryKeys

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

  • Parameters

    Returns Promise<string[]>

inheritedgetReferencedTableName

  • getReferencedTableName(referencedTableName, schema): string

  • Parameters

    • referencedTableName: string
    • optionalschema: string

    Returns string

inheritedgetRenameColumnSQL

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

  • Parameters

    • tableName: string
    • oldColumnName: string
    • to: Column
    • optionalschemaName: string

    Returns string

inheritedgetRenameIndexSQL

  • getRenameIndexSQL(tableName, index, oldIndexName): string

  • Parameters

    • tableName: string
    • index: IndexDef
    • oldIndexName: string

    Returns string

inheritedgetSchemaBeginning

  • getSchemaBeginning(charset, disableForeignKeys): string

  • Parameters

    • charset: string
    • optionaldisableForeignKeys: boolean

    Returns string

inheritedgetSchemaEnd

  • getSchemaEnd(disableForeignKeys): string

  • Parameters

    • optionaldisableForeignKeys: boolean

    Returns string

inheritedgetTablesGroupedBySchemas

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

  • Parameters

    Returns Map<undefined | string, Table[]>

inheritedhasNonDefaultPrimaryKeyName

  • hasNonDefaultPrimaryKeyName(table): boolean

  • Parameters

    • table: DatabaseTable

    Returns boolean

inheritedinferLengthFromColumnType

  • inferLengthFromColumnType(type): undefined | number

  • Parameters

    • type: string

    Returns undefined | number

inheritedisImplicitIndex

  • isImplicitIndex(name): boolean

  • Implicit indexes will be ignored when diffing

    Parameters

    • name: string

    Returns boolean

inheritedloadInformationSchema

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

  • Parameters

    Returns Promise<void>

inheritedmapForeignKeys

  • Parameters

    • fks: any[]
    • tableName: string

    Returns Dictionary

inheritednormalizeDefaultValue

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

  • Parameters

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

    Returns string | number

inheritedpushTableQuery

  • pushTableQuery(table, expression, grouping): 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

inheritedsplitTableName

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

  • Parameters

    • name: string

    Returns [undefined | string, string]

inheritedsupportsSchemaConstraints

  • supportsSchemaConstraints(): boolean

  • Returns boolean

Page Options