Class PostgreSQLMigrationContext

A PostgreSQL migration context.

Index

Constructors

Properties

debug noTransactions options

Methods

createContext down getMigrations runMigrations up

Constructors

constructor

new PostgreSQLMigrationContext(options): PostgreSQLMigrationContext
Initializes a new instance of that class.
Parameters
- options: IPostgreSQLMigrationContextOptions
  The options.
Returns PostgreSQLMigrationContext
- Defined in src/classes/PostgreSQLMigrationContext.ts:119

Properties

`Private` `Readonly` debug

debug: DebugActionWithoutSource

`Private` `Readonly` noTransactions

noTransactions: boolean

`Readonly` options

options: IPostgreSQLMigrationContextOptions

The options.

Methods

`Private` createContext

createContext(): Promise<{
adapter: PostgreSQLDataAdapter;
context: IDataContext;
}>
Returns Promise<{
adapter: PostgreSQLDataAdapter;
context: IDataContext;
}>
- Defined in src/classes/PostgreSQLMigrationContext.ts:128

down

down(options?): Promise<void>
Downgrades the database.
Parameters
- Optional options: Nilable<IDownOptions>
  The custom options.
Returns Promise<void>
- Defined in src/classes/PostgreSQLMigrationContext.ts:165

`Private` getMigrations

getMigrations(): Promise<IPostgreSQLMigration[]>
Returns Promise<IPostgreSQLMigration[]>
- Defined in src/classes/PostgreSQLMigrationContext.ts:230

`Private` runMigrations

runMigrations(__namedParameters): Promise<void>
Parameters
- __namedParameters: IRunMigrationsOptions
Returns Promise<void>
- Defined in src/classes/PostgreSQLMigrationContext.ts:296

up

up(options?): Promise<void>
Upgrades the database.
Parameters
- Optional options: Nilable<IUpOptions>
  The custom options.
Returns Promise<void>
- Defined in src/classes/PostgreSQLMigrationContext.ts:352

Generated using TypeDoc