Class PGUpdate`Abstract`

Hierarchy

default<PGCon>
- PGUpdate

Index

Constructors

Properties

srcVersion tarVersion

Methods

alterTableAddColumn alterTableDeleteColumn find getDb getSource initNewTable performe setNext update updateNext

Constructors

`Protected`constructor

new PGUpdate(srcVersion: string, tarVersion: string, db: PGCon): PGUpdate
Parameters
- srcVersion: string
- tarVersion: string
- db: PGCon
Returns PGUpdate
Inherited from CoreDBUpdate<PGCon>.constructor
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreDBUpdate.d.ts:9

Properties

srcVersion

srcVersion: string

tarVersion

tarVersion: string

Methods

`Protected`alterTableAddColumn

alterTableAddColumn(
    className: string,
    columName: string,
    type: string,
    notNull: boolean,
    defaultValue?: string,
    deleteDefault?: boolean,
): Promise<boolean>
Protected
Alter a table to add a new column.
Parameters
- className: string
- columName: string
- type: string
- notNull: boolean
- OptionaldefaultValue: string
- OptionaldeleteDefault: boolean
Returns Promise<boolean>
- Defined in src/class/PGUpdate.ts:24

`Protected`alterTableDeleteColumn

alterTableDeleteColumn(className: string, columName: string): Promise<boolean>
Protected
Alter a table to delete a column. This method is used to remove a column from an existing table in the database.
Parameters
- className: string
- columName: string
Returns Promise<boolean>
- Defined in src/class/PGUpdate.ts:69

find

find(
    version: string,
):
    | null
    | CoreDBUpdate<PGCon<ICoreKernel<any, ICoreAnyModule>, any, any, any, any>>
Parameters
- version: string
Returns null | CoreDBUpdate<PGCon<ICoreKernel<any, ICoreAnyModule>, any, any, any, any>>
Inherited from CoreDBUpdate.find
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreDBUpdate.d.ts:14

getDb

getDb(): PGCon
Returns PGCon
Inherited from CoreDBUpdate.getDb
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreDBUpdate.d.ts:15

getSource

getSource(): string
Returns string
Inherited from CoreDBUpdate.getSource
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreDBUpdate.d.ts:16

`Protected`initNewTable

initNewTable(className: string): Promise<boolean>
Initialize a new table in the database. This method is used to create a new table in the database.
Parameters
- className: string
Returns Promise<boolean>
- Defined in src/class/PGUpdate.ts:10

`Abstract`performe

performe(): Promise<boolean>
Returns Promise<boolean>
Inherited from CoreDBUpdate.performe
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreDBUpdate.d.ts:11

setNext

setNext(
    db: CoreDBUpdate<
        PGCon<ICoreKernel<any, ICoreAnyModule>, any, any, any, any>,
    >,
): void
Parameters
- db: CoreDBUpdate<PGCon<ICoreKernel<any, ICoreAnyModule>, any, any, any, any>>
Returns void
Inherited from CoreDBUpdate.setNext
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreDBUpdate.d.ts:13

update

update(): Promise<boolean>
Returns Promise<boolean>
Inherited from CoreDBUpdate.update
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreDBUpdate.d.ts:10

updateNext

updateNext(): Promise<boolean>
Returns Promise<boolean>
Inherited from CoreDBUpdate.updateNext
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreDBUpdate.d.ts:12