@an5/orm 1.0.8 → 1.0.9

package/dist/migration-core.d.ts

@@ -0,0 +1,87 @@
+export interface SchemaField {
+    name: string;
+    sqlType: string;
+    isOptional: boolean;
+    isId: boolean;
+    isUnique: boolean;
+    uniqueName?: string | undefined;
+    defaultValue?: string | undefined;
+}
+export interface SchemaIndexDefinition {
+    fields: string[];
+    name?: string;
+    includeFields?: string[];
+    filter?: string;
+    options?: string;
+}
+export interface SchemaModel {
+    name: string;
+    tableName: string;
+    fields: SchemaField[];
+    compoundUniques: Array<string[] | SchemaIndexDefinition>;
+    indexes: Array<string[] | SchemaIndexDefinition>;
+}
+export interface DbColumn {
+    columnName: string;
+    dataType: string;
+    maxLength?: number;
+    precision?: number;
+    scale?: number;
+    isNullable: boolean;
+    isPrimaryKey: boolean;
+    isIdentity: boolean;
+    defaultValue?: string;
+}
+export interface MigrationOp {
+    type: 'CREATE_TABLE' | 'ADD_COLUMN' | 'DROP_COLUMN' | 'ALTER_COLUMN' | 'ADD_INDEX' | 'ADD_UNIQUE' | 'DROP_INDEX' | 'DROP_UNIQUE' | 'DROP_TABLE';
+    table: string;
+    column?: string;
+    details?: string;
+    sql?: string;
+    previousSqlType?: string;
+    previousNullable?: boolean;
+    riskWarnings?: string[];
+    preflightSql?: string[];
+}
+export interface TableArtifacts {
+    indexes?: string[];
+    uniqueConstraints?: string[];
+}
+export interface MigrationSections {
+    preflight: string;
+    up: string;
+    down: string;
+    hasDown: boolean;
+}
+export interface AppliedMigrationRef {
+    id: string;
+}
+export interface MigrationCommandOptions {
+    dryRun: boolean;
+    rest: string[];
+}
+export declare function parseSqlType(raw: string): string;
+export declare function formatDbColumnSqlType(column: DbColumn): string;
+export declare function mapDefault(val: string): string;
+export declare function safeIdentifierName(raw: string): string;
+export declare function quoteTableName(raw: string): string;
+export declare function tableIdentityName(raw: string): string;
+export declare function buildAlterColumnWarnings(previousSqlType: string, nextSqlType: string, previousNullable: boolean, nextNullable: boolean): string[];
+export declare function buildAlterColumnPreflightSql(tableName: string, columnName: string, previousSqlType: string, nextSqlType: string, previousNullable: boolean, nextNullable: boolean): string[];
+export declare function buildAddColumnPreflightSql(tableName: string, field: SchemaField): string[];
+export declare function buildUniqueConstraintPreflightSql(tableName: string, fields: string[]): string[];
+export declare function parseSchemaText(text: string): SchemaModel[];
+export declare function buildCreateTableSql(model: SchemaModel): string;
+export declare function buildIndexDiff(model: SchemaModel, artifacts: TableArtifacts, ops: MigrationOp[]): void;
+export declare function generateColumnDiff(model: SchemaModel, dbColumns: DbColumn[], ops: MigrationOp[]): void;
+export declare function generateDiff(schemaModels: SchemaModel[], dbTables: string[], introspectTable: (tableName: string) => Promise<DbColumn[]>, introspectArtifacts?: (tableName: string) => Promise<TableArtifacts>): Promise<MigrationOp[]>;
+export declare function buildMigrationFile(timestamp: string, ops: MigrationOp[]): string;
+export declare function buildDownMigrationSql(ops: MigrationOp[]): string;
+export declare function parseMigrationSections(sql: string): MigrationSections;
+export declare function splitSqlBatches(sql: string): string[];
+export declare function parseRollbackSelection(args: string[], applied: AppliedMigrationRef[]): {
+    count: number;
+    label: string;
+};
+export declare function parseMigrationCommandOptions(args: string[]): MigrationCommandOptions;
+//# sourceMappingURL=migration-core.d.ts.map