larvitdbmigration/dist/index.d.ts

node.js database migration tool

import { AxiosInstance } from 'axios';
import { LogInstance } from 'larvitutils';
import ElasticsearchDriver from './dbType/elasticsearch';
import MariaDbDriver from './dbType/mariadb';
export type DbMigrationOptions = {
    dbType: 'mariadb' | 'elasticsearch';
    dbDriver?: any;
    context?: object;
    tableName?: string;
    indexName?: string;
    migrationScriptPath?: string;
    log?: LogInstance;
    axios?: AxiosInstance;
    url?: string;
};
export declare class DbMigration {
    driver: MariaDbDriver | ElasticsearchDriver;
    options: DbMigrationOptions;
    /**
     * Module main constructor
     *
     * @param {object} options -
     * @param {String} options.dbType - "mariadb" or "elasticsearch"
     * @param {object} options.dbDriver - instance of your mariadb database driver. For example larvitdb.
     * @param {object} [options.context] - Context that can carry arbitrary information to the migrations (such as an instance of the lib that is doing the migrations)
     * @param {String} [options.tableName="db_version"] -
     * @param {String} [options.indexName="db_version"] -
     * @param {String} [options.url] - must be specified if dbType is "elasticsearch"
     * @param {String} [options.axios] - optional axios instance to be used if dbType is "elasticsearch"
     * @param {String} [options.migrationScriptPath="./dbmigration"] -
     * @param {object} [options.log=instance of lutils.Log()] -
     */
    constructor(options: DbMigrationOptions);
    run(): Promise<void>;
}
//# sourceMappingURL=index.d.ts.map