db-modeling-markdown 1.0.5 → 2.0.0

package/dist/models/dbColumn.d.ts

@@ -0,0 +1,43 @@
+/**
+ * Describe a table column
+ */
+export interface DbColumn {
+    /**
+     * The column name before the column (used in upgrading cases)
+     */
+    afterColumn?: string;
+    /**
+     * The character set of the text column
+     */
+    characterSet?: string;
+    /**
+     * the collation of the text column
+     */
+    collation?: string;
+    /**
+     * The column comment
+     */
+    comment?: string;
+    /**
+     * The table default value.
+     * <empty> is no default value.
+     * Value `''` for default value empty
+     */
+    default?: string;
+    /**
+     * The column label
+     */
+    label?: string;
+    /**
+     * The column name
+     */
+    name: string;
+    /**
+     * If the column nullable
+     */
+    nullable?: boolean;
+    /**
+     * The column data type
+     */
+    type: string;
+}

package/dist/models/dbColumn.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=dbColumn.js.map

package/dist/models/dbColumn.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dbColumn.js","sourceRoot":"","sources":["../../src/models/dbColumn.ts"],"names":[],"mappings":""}

package/dist/models/dbDiffModel.d.ts

@@ -0,0 +1,43 @@
+import { DbColumn } from './dbColumn';
+import { DbForeignKey } from './dbForeignKey';
+import { DbIndex } from './dbIndex';
+import { DbPrimaryKey } from './dbPrimaryKey';
+import { DbTable } from './dbTable';
+/**
+ * Describe a database model
+ */
+export interface DbDiffModel {
+    /**
+     * The model tables
+     */
+    diffTables: DbDiffTable[];
+    /**
+     * new tables
+     */
+    newTables: DbTable[];
+}
+/**
+ * Describe a database diffrent model
+ */
+export interface DbDiffTable {
+    /**
+     * The table name
+     */
+    name: string;
+    /**
+     * new columns
+     */
+    newColumns: DbColumn[];
+    /**
+     * new foreign keys
+     */
+    newForeignKeys: DbForeignKey[];
+    /**
+     * new Index
+     */
+    newIndexes: DbIndex[];
+    /**
+     * new primary key
+     */
+    newPrimaryKeys?: DbPrimaryKey;
+}

package/dist/models/dbDiffModel.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=dbDiffModel.js.map

package/dist/models/dbDiffModel.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dbDiffModel.js","sourceRoot":"","sources":["../../src/models/dbDiffModel.ts"],"names":[],"mappings":""}

package/dist/models/dbForeignKey.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Describe the table foreign key
+ */
+export interface DbForeignKey {
+    /**
+     * The foreign key columns.
+     *
+     * Use comma `,` to split multiple columns.
+     * E.g. `column, column2`
+     */
+    columns: string;
+    /**
+     * The name of the foreign key
+     */
+    name?: string;
+    /**
+     * The foreign key options
+     *
+     * E.g. `ON DELETE CASCADE`
+     */
+    options?: string;
+    /**
+     * The reference columns of the foreign key columns.
+     *
+     * Use comma `,` to split multiple columns.
+     * E.g. `column, column2`
+     */
+    refColumns: string;
+    /**
+     * The reference table of the foreign key
+     */
+    refTable: string;
+}

package/dist/models/dbForeignKey.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=dbForeignKey.js.map

package/dist/models/dbForeignKey.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dbForeignKey.js","sourceRoot":"","sources":["../../src/models/dbForeignKey.ts"],"names":[],"mappings":""}

package/dist/models/dbIndex.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Describe the table index
+ */
+export interface DbIndex {
+    /**
+     * If the index is clusterred
+     */
+    cluster?: boolean;
+    /**
+     * The index columns.
+     *
+     * Use comma `,` to split multiple columns.
+     * E.g. `column, column2`
+     */
+    columns: string;
+    /**
+     * The name of the index
+     */
+    name?: string;
+    /**
+     * the index type
+     */
+    type?: string;
+    /**
+     * If the index is unique
+     */
+    unique?: boolean;
+}

package/dist/models/dbIndex.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=dbIndex.js.map

package/dist/models/dbIndex.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dbIndex.js","sourceRoot":"","sources":["../../src/models/dbIndex.ts"],"names":[],"mappings":""}

package/dist/models/dbIndexType.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Describe the table index type
+ */
+export declare enum DbIndexType {
+    FullText = "FullText",
+    Index = "Index",
+    PrimaryKey = "Primary Key"
+}

package/dist/models/dbIndexType.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DbIndexType = void 0;
+/**
+ * Describe the table index type
+ */
+var DbIndexType;
+(function (DbIndexType) {
+    DbIndexType["FullText"] = "FullText";
+    DbIndexType["Index"] = "Index";
+    DbIndexType["PrimaryKey"] = "Primary Key";
+})(DbIndexType = exports.DbIndexType || (exports.DbIndexType = {}));
+//# sourceMappingURL=dbIndexType.js.map

package/dist/models/dbIndexType.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dbIndexType.js","sourceRoot":"","sources":["../../src/models/dbIndexType.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACH,IAAY,WAIX;AAJD,WAAY,WAAW;IACtB,oCAAqB,CAAA;IACrB,8BAAe,CAAA;IACf,yCAA0B,CAAA;AAC3B,CAAC,EAJW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAItB"}

package/dist/models/dbModel.d.ts

@@ -0,0 +1,10 @@
+import { DbTable } from './dbTable';
+/**
+ * Describe a database model
+ */
+export interface DbModel {
+    /**
+     * The model tables
+     */
+    tables: DbTable[];
+}

package/dist/{services → models}/dbModel.js.map

@@ -1 +1 @@
-{"version":3,"file":"dbModel.js","sourceRoot":"","sources":["../../src/services/dbModel.ts"],"names":[],"mappings":""}
+{"version":3,"file":"dbModel.js","sourceRoot":"","sources":["../../src/models/dbModel.ts"],"names":[],"mappings":""}

package/dist/models/dbPrimaryKey.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Describe table primary key
+ */
+export interface DbPrimaryKey {
+    /**
+     * If the primary key is clusterred
+     */
+    cluster?: boolean;
+    /**
+     * The primary key columns.
+     *
+     * Use comma `,` to split multiple columns.
+     * E.g. `column, column2`
+     */
+    columns: string;
+}

package/dist/models/dbPrimaryKey.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=dbPrimaryKey.js.map

package/dist/models/dbPrimaryKey.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dbPrimaryKey.js","sourceRoot":"","sources":["../../src/models/dbPrimaryKey.ts"],"names":[],"mappings":""}

package/dist/models/dbTable.d.ts

@@ -0,0 +1,49 @@
+import { DbColumn } from './dbColumn';
+import { DbForeignKey } from './dbForeignKey';
+import { DbIndex } from './dbIndex';
+import { DbPrimaryKey } from './dbPrimaryKey';
+/**
+ * Describe a table
+ */
+export interface DbTable {
+    /**
+     * auto increment start
+     */
+    autoIncrement?: number;
+    /**
+     * The character set of the text column
+     */
+    characterSet?: string;
+    /**
+     * the collation of the text column
+     */
+    collation?: string;
+    /**
+     * The table columns
+     */
+    columns: DbColumn[];
+    /**
+     * The table comment
+     */
+    comment?: string;
+    /**
+     * DB Engin
+     */
+    engine?: string;
+    /**
+     * The table foreign keys
+     */
+    foreignKeys: DbForeignKey[];
+    /**
+     * The table indexes
+     */
+    indexes: DbIndex[];
+    /**
+     * The table name
+     */
+    name: string;
+    /**
+     * The table primary key
+     */
+    primaryKey?: DbPrimaryKey;
+}

package/dist/models/dbTable.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=dbTable.js.map

package/dist/models/dbTable.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dbTable.js","sourceRoot":"","sources":["../../src/models/dbTable.ts"],"names":[],"mappings":""}

package/dist/models/dbTableMarkdown.d.ts

@@ -0,0 +1,34 @@
+import { DbColumn } from './dbColumn';
+import { DbForeignKey } from './dbForeignKey';
+import { DbIndex } from './dbIndex';
+import { DbPrimaryKey } from './dbPrimaryKey';
+/**
+ * Describe a table
+ */
+export interface DbTableMarkdown {
+    /**
+     * The table columns
+     */
+    columns: DbColumn[];
+    /**
+     * The table foreign keys
+     */
+    foreignKeys: DbForeignKey[];
+    /**
+     * The table indexes
+     */
+    indexes: DbIndex[];
+    /**
+     * The table primary key
+     */
+    primaryKey?: DbPrimaryKey[];
+    /**
+     * The table header
+     */
+    table: {
+        characterSet?: string;
+        collation?: string;
+        comment?: string;
+        name: string;
+    }[];
+}

package/dist/models/dbTableMarkdown.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=dbTableMarkdown.js.map

package/dist/models/dbTableMarkdown.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dbTableMarkdown.js","sourceRoot":"","sources":["../../src/models/dbTableMarkdown.ts"],"names":[],"mappings":""}

package/dist/services/dbOptions.d.ts

@@ -0,0 +1,35 @@
+import { DatabaseTypes } from '../models/databaseTypes';
+/**
+ * Options for database connection
+ */
+export declare class DbOptions {
+    /**
+     * The database type
+     * Default is `mariadb`
+     */
+    databaseType: DatabaseTypes;
+    /**
+ * The database url
+ */
+    databaseUrl?: string;
+    /**
+     * the user name to access database
+     */
+    user?: string;
+    /**
+     * The user password
+     */
+    password?: string;
+    /**
+     * The database port
+     */
+    port?: number;
+    /**
+     * The database host
+     */
+    host?: string;
+    /**
+     * The database name
+     */
+    database?: string;
+}

package/dist/services/dbOptions.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DbOptions = void 0;
+const databaseTypes_1 = require("../models/databaseTypes");
+/**
+ * Options for database connection
+ */
+class DbOptions {
+    constructor() {
+        /**
+         * The database type
+         * Default is `mariadb`
+         */
+        this.databaseType = databaseTypes_1.DatabaseTypes.mariadb;
+    }
+}
+exports.DbOptions = DbOptions;
+//# sourceMappingURL=dbOptions.js.map

package/dist/services/dbOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dbOptions.js","sourceRoot":"","sources":["../../src/services/dbOptions.ts"],"names":[],"mappings":";;;AAAA,2DAAuD;AAEvD;;GAEG;AACH,MAAa,SAAS;IAAtB;QACC;;;WAGG;QACH,iBAAY,GAAkB,6BAAa,CAAC,OAAO,CAAA;IA+BpD,CAAC;CAAA;AApCD,8BAoCC"}

package/dist/services/dbmOptions.d.ts

@@ -1,4 +1,4 @@
-import { DatabaseTypes } from './databaseTypes';
+import { DatabaseTypes } from '../models/databaseTypes';
 /**
  * Options for generation functions
  */

package/dist/services/dbmOptions.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DefaultOptions = exports.DbmOptions = void 0;
-const databaseTypes_1 = require("./databaseTypes");
+const databaseTypes_1 = require("../models/databaseTypes");
 /**
  * Options for generation functions
  */

package/dist/services/dbmOptions.js.map

@@ -1 +1 @@
-{"version":3,"file":"dbmOptions.js","sourceRoot":"","sources":["../../src/services/dbmOptions.ts"],"names":[],"mappings":";;;AAAA,mDAAgD;AAEhD;;GAEG;AACH,MAAa,UAAU;IAAvB;QACC;;WAEG;QACH,aAAQ,GAAkB,6BAAa,CAAC,KAAK,CAAC;QAE9C;;;WAGG;QACH,oBAAe,GAAW,QAAQ,CAAC;QAEnC;;WAEG;QACH,iBAAY,GAAW,EAAE,CAAC;QAE1B;;WAEG;QACH,eAAU,GAAW,EAAE,CAAC;IACzB,CAAC;CAAA;AArBD,gCAqBC;AAEY,QAAA,cAAc,GAAG,IAAI,UAAU,EAAE,CAAC"}
+{"version":3,"file":"dbmOptions.js","sourceRoot":"","sources":["../../src/services/dbmOptions.ts"],"names":[],"mappings":";;;AAAA,2DAAuD;AAEvD;;GAEG;AACH,MAAa,UAAU;IAAvB;QACC;;WAEG;QACH,aAAQ,GAAkB,6BAAa,CAAC,KAAK,CAAA;QAE7C;;;WAGG;QACH,oBAAe,GAAW,QAAQ,CAAA;QAElC;;WAEG;QACH,iBAAY,GAAW,EAAE,CAAA;QAEzB;;WAEG;QACH,eAAU,GAAW,EAAE,CAAA;IACxB,CAAC;CAAA;AArBD,gCAqBC;AAEY,QAAA,cAAc,GAAG,IAAI,UAAU,EAAE,CAAA"}

package/dist/services/dbmService.d.ts

@@ -1,5 +1,6 @@
-import { DbModel } from './dbModel';
+import { DbModel } from '../models/dbModel';
 import { DbmOptions } from './dbmOptions';
+import { DbOptions } from './dbOptions';
 /**
  * The database modeling markdown service.
  */
@@ -31,11 +32,30 @@ export declare class DbmService {
      * @param options the options, required: `database`, `sourceFolder`, `targetPath`.
      */
     static toDropThenCreateTableSql(options: DbmOptions): string;
+    /**
+     * Generate a SQL file with upgrade scripts.
+     * support:
+     * - new tables,
+     * - new columns,
+     * - new primary keys
+     * - new indexes
+     * - new foreign keys
+     * @param options the options, required: `database`, `sourceFolder`, `targetPath`.
+     */
+    static toUpgradeSql(fromOptions: DbmOptions, options: DbmOptions): string;
     /**
      * Generate a JSON file.
      * @param options the options, required: `database`, `sourceFolder`, `targetPath`.
      */
     static toJson(options: DbmOptions): string;
+    /**
+     * Generate markdown files from a json file
+     * @param jsonFile the json file path
+     * @param markdownFolder the folder to which we will write
+     * @param force If true, delete all files whose extension matched, default: `false`.
+     * @param fileExtension generated file extension, default: `.db.md`.
+     */
+    static fromJsonFile(jsonFile: string, markdownFolder: string, force?: boolean, fileExtension?: string): void;
     /**
      * Generate markdown files from a model
      * @param model the model object with
@@ -44,9 +64,24 @@ export declare class DbmService {
      * @param fileExtension generated file extension, default: `.db.md`.
      */
     static toMarkdown(model: DbModel, markdownFolder: string, force?: boolean, fileExtension?: string): void;
+    /**
+     * Generate a index file for a model
+     * @param model the model object with
+     * @param markdownFolder the folder to which we will write
+     * @param filename generated file name, default: `index.md`.
+     */
+    static genIndexFile(model: DbModel, markdownFolder: string, filename?: string): void;
     /**
      * Get a model object.
      * @param options the options, required: `database`, `sourceFolder`.
      */
     static toModel(options: DbmOptions): DbModel;
+    /**
+     * Generate markdown files from a database
+     * @param dbOptions the datbase connection configure
+     * @param markdownFolder the folder to which we will write
+     * @param force If true, delete all files whose extension matched, default: `false`.
+     * @param fileExtension generated file extension, default: `.db.md`.
+     */
+    static fromDatabase(dbOptions: DbOptions, markdownFolder: string, force?: boolean, fileExtension?: string): Promise<void>;
 }

package/dist/services/dbmService.js

@@ -3,10 +3,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.DbmService = void 0;
 const fs = require("fs");
 const path = require("path");
-const fileHelper_1 = require("../lib/utils/fileHelper");
+const providerFactory_1 = require("../dialects/core/providerFactory");
 const markdownReader_1 = require("../lib/markdown-object/markdownReader");
 const markdownWriter_1 = require("../lib/markdown-object/markdownWriter");
-const providerFactory_1 = require("../dialects/core/providerFactory");
+const fileHelper_1 = require("../lib/utils/fileHelper");
+const databaseTypes_1 = require("../models/databaseTypes");
 /**
  * The database modeling markdown service.
  */
@@ -64,9 +65,8 @@ class DbmService {
             ],
         };
         const table = model.tables[0];
-        const content = markdownWriter_1.MarkdownWriter.renderTable(table, options.sourceFolder &&
+        return markdownWriter_1.MarkdownWriter.renderTable(table, options.sourceFolder &&
             path.join(options.sourceFolder, `${table.name}${options.mdFileExtension}`));
-        return content;
     }
     /**
      * Generate a SQL file with create-table-if-not-exists scripts.
@@ -120,6 +120,26 @@ class DbmService {
         }
         return sql;
     }
+    /**
+     * Generate a SQL file with upgrade scripts.
+     * support:
+     * - new tables,
+     * - new columns,
+     * - new primary keys
+     * - new indexes
+     * - new foreign keys
+     * @param options the options, required: `database`, `sourceFolder`, `targetPath`.
+     */
+    static toUpgradeSql(fromOptions, options) {
+        const fromModel = this.toModel(fromOptions);
+        const model = this.toModel(options);
+        const provider = providerFactory_1.ProviderFactory.getProvider(options.database);
+        const sql = provider.getUpgradeSql(fromModel, model, true);
+        if (options.targetPath) {
+            fileHelper_1.FileHelper.writeFileSync(options.targetPath, sql);
+        }
+        return sql;
+    }
     /**
      * Generate a JSON file.
      * @param options the options, required: `database`, `sourceFolder`, `targetPath`.
@@ -131,6 +151,17 @@ class DbmService {
         }
         return JSON.stringify(model, null, 2);
     }
+    /**
+     * Generate markdown files from a json file
+     * @param jsonFile the json file path
+     * @param markdownFolder the folder to which we will write
+     * @param force If true, delete all files whose extension matched, default: `false`.
+     * @param fileExtension generated file extension, default: `.db.md`.
+     */
+    static fromJsonFile(jsonFile, markdownFolder, force = false, fileExtension = '.db.md') {
+        const model = JSON.parse(fileHelper_1.FileHelper.readJsonFileSync(jsonFile));
+        this.toMarkdown(model, markdownFolder, force, fileExtension);
+    }
     /**
      * Generate markdown files from a model
      * @param model the model object with
@@ -139,20 +170,44 @@ class DbmService {
      * @param fileExtension generated file extension, default: `.db.md`.
      */
     static toMarkdown(model, markdownFolder, force = false, fileExtension = '.db.md') {
-        if (fs.existsSync(markdownFolder)) {
-            if (force) {
-                const files = fileHelper_1.FileHelper.readdirSync(markdownFolder);
-                files.forEach((file) => {
-                    if (file.name.endsWith(fileExtension)) {
-                        fs.unlinkSync(path.join(markdownFolder, file.name));
-                    }
-                });
-            }
+        if (force && fs.existsSync(markdownFolder)) {
+            fileHelper_1.FileHelper.removeAllFilesSync(markdownFolder, fileExtension);
+        }
+        if (!fs.existsSync(markdownFolder)) {
+            fileHelper_1.FileHelper.mkdirSync(markdownFolder);
         }
         model.tables.forEach((table) => {
             markdownWriter_1.MarkdownWriter.renderTable(table, path.join(markdownFolder, `${table.name}${fileExtension}`));
         });
     }
+    /**
+     * Generate a index file for a model
+     * @param model the model object with
+     * @param markdownFolder the folder to which we will write
+     * @param filename generated file name, default: `index.md`.
+     */
+    static genIndexFile(model, markdownFolder, filename = 'index.md') {
+        const file = path.join(markdownFolder, filename);
+        fileHelper_1.FileHelper.removeFileSync(file);
+        let data = '# Database Design\n\n';
+        data += '## Index\n\n';
+        const columnWidths = [5, 6];
+        model.tables.forEach((table) => {
+            if (table.name.length * 2 + 10 > columnWidths[0]) {
+                columnWidths[0] = table.name.length * 2 + 10;
+            }
+            if (table.comment && table.comment.length > columnWidths[1]) {
+                columnWidths[1] = table.comment.length;
+            }
+        });
+        data += `| ${'Table'.padEnd(columnWidths[0], ' ')} | ${'Comment'.padEnd(columnWidths[1], ' ')} |\n`;
+        data += `| ${''.padEnd(columnWidths[0], '-')} | ${''.padEnd(columnWidths[1], '-')} |\n`;
+        model.tables.forEach((table) => {
+            const name = `[${table.name}](${table.name}.db.md)`;
+            data += `| ${name.padEnd(columnWidths[0], ' ')} | ${table.comment?.padEnd(columnWidths[1], ' ')} |\n`;
+        });
+        fileHelper_1.FileHelper.writeFileSync(file, data);
+    }
     /**
      * Get a model object.
      * @param options the options, required: `database`, `sourceFolder`.
@@ -168,6 +223,18 @@ class DbmService {
         });
         return model;
     }
+    /**
+     * Generate markdown files from a database
+     * @param dbOptions the datbase connection configure
+     * @param markdownFolder the folder to which we will write
+     * @param force If true, delete all files whose extension matched, default: `false`.
+     * @param fileExtension generated file extension, default: `.db.md`.
+     */
+    static async fromDatabase(dbOptions, markdownFolder, force = false, fileExtension = '.db.md') {
+        const provider = providerFactory_1.ProviderFactory.getImportProvider(databaseTypes_1.DatabaseTypes.mariadb);
+        const model = await provider.getModel(dbOptions);
+        this.toMarkdown(model, markdownFolder, force, fileExtension);
+    }
 }
 exports.DbmService = DbmService;
 //# sourceMappingURL=dbmService.js.map