@types/db-migrate-pg

Installation

npm install --save @types/db-migrate-pg

Summary

This package contains type definitions for db-migrate-pg (https://github.com/db-migrate/pg).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/db-migrate-pg.

index.d.ts

import * as pg from "pg";
import DbMigrateBase = require("db-migrate-base");
import * as Promise from "bluebird";

// Yes, this is a dummy interface for now; the current implementation of the pg driver doesn't need any options.
export interface CreateDatabaseOptions {}

export interface DropDatabaseOptions {
    ifExists?: boolean | undefined;
}

export interface CreateSequenceOptions {
    temp?: boolean | undefined;
}

export interface SwitchDatabaseOptions {
    database?: string | undefined;
}

export interface DropSequenceOptions {
    ifExists?: boolean | undefined;
    cascade?: boolean | undefined;
    restrict?: boolean | undefined;
}

export interface ColumnConstraint {
    foreignKey: (callback: DbMigrateBase.CallbackFunction) => void;
    constraints: string;
}

export interface ColumnConstraintOptions {
    emitPrimaryKey?: boolean | undefined;
}

export class PgDriver extends DbMigrateBase {
    constructor(connection: pg.Client, schema: string, intern: DbMigrateBase.InternalOptions);
    createDatabase(
        dbName: string,
        optionsOrCb: CreateDatabaseOptions | DbMigrateBase.CallbackFunction,
        callback?: DbMigrateBase.CallbackFunction,
    ): void;
    dropDatabase(
        dbName: string,
        optionsOrCb: DropDatabaseOptions | DbMigrateBase.CallbackFunction,
        callback?: DbMigrateBase.CallbackFunction,
    ): void;
    createSequence(
        sqName: string,
        optionsOrCb: CreateSequenceOptions | DbMigrateBase.CallbackFunction,
        callback?: DbMigrateBase.CallbackFunction,
    ): void;
    switchDatabase(options: string | SwitchDatabaseOptions, callback: DbMigrateBase.CallbackFunction): void;
    dropSequence(
        dbName: string,
        optionsOrCb: DropSequenceOptions | DbMigrateBase.CallbackFunction,
        callback?: DbMigrateBase.CallbackFunction,
    ): void;
    createColumnConstraint(
        spec: DbMigrateBase.ColumnSpec,
        options: ColumnConstraintOptions,
        tableName: string,
        columnName: string,
    ): ColumnConstraint;

    createDatabaseAsync(dbName: string, options?: CreateDatabaseOptions): Promise<any>;
    dropDatabaseAsync(dbName: string, options?: DropDatabaseOptions): Promise<any>;
    createSequenceAsync(sqName: string, options?: CreateSequenceOptions): Promise<any>;
    switchDatabaseAsync(options: string | SwitchDatabaseOptions): Promise<any>;
    dropSequenceAsync(dbName: string, options?: DropSequenceOptions): Promise<any>;
}

Additional Details

• Last updated: Mon, 06 Nov 2023 22:41:05 GMT
• Dependencies: @types/bluebird, @types/db-migrate-base, @types/pg

Credits

These definitions were written by nickiannone.