dynamit-cli
Version:
The DynamoDB migrations tool CLI
37 lines (36 loc) • 1.3 kB
TypeScript
import { DocumentClient } from 'aws-sdk/clients/dynamodb';
import Umzug from 'umzug';
import DynamoDBStorage from '../storages/dynamodb';
export { DynamoDBStorage };
export interface MigratorOptions {
region?: string;
accessKeyId?: string;
secretAccessKey?: string;
endpointUrl?: string;
dynamodb?: DocumentClient;
tableName?: string;
attributeName?: string;
migrationsPath?: string;
}
interface Generator {
generate(migrationName: string): Promise<void>;
}
export declare class Migrator extends Umzug implements Generator {
private generator;
private migrationsPath;
/**
* Migrator factory function, creates an umzug instance with dynamodb storage.
* @param options
* @param options.region - an AWS Region
* @param options.dynamodb - a DynamoDB document client instance
* @param options.endpointUrl - an optional endpoint URL for local DynamoDB instances
* @param options.tableName - a name of migration table in DynamoDB
* @param options.attributeName - name of the table primaryKey attribute in DynamoDB
*/
constructor(options?: MigratorOptions);
generate(migrationName: string): Promise<void>;
}
/**
* Migrator instance with options by default.
*/
export declare const defaultMigrator: Migrator;