db-modeling-markdown 2.0.1 → 2.1.0

package/dist/lib/utils/textHelper.js

@@ -1,72 +1,76 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TextHelper = void 0;
-/**
- * markdown escaped characters
- */
-const markdownEncodeReg = /[\\`*{}[\]#+!|]/g;
-const markdownDecodeReg = /\\([\\`*{}[\]#+!|])/g;
-class TextHelper {
-    static splitToLines(str) {
-        return str.split(/\r\n|\n/);
-    }
-    static width(str) {
-        if (!str || str.length === 0) {
-            return 0;
-        }
-        let width = 0;
-        for (let i = 0; i < str.length; i += 1) {
-            width += str.charCodeAt(i) > 255 ? 2 : 1;
-        }
-        return width;
-    }
-    static padEnd(str, maxLen, fileString = ' ') {
-        const textWidth = TextHelper.width(str);
-        if (maxLen - textWidth > 0) {
-            return `${str}${''.padEnd(maxLen - textWidth, fileString)}`;
-        }
-        return str;
-    }
-    /**
-     * encode a text to a markdown text
-     * - end of line
-     * @param str text
-     * @returns the markdown text
-     */
-    static encodeMarkdown(str) {
-        if (!str) {
-            return '';
-        }
-        // escaped
-        let escaped = str.replace(markdownEncodeReg, TextHelper.encodeReplacer);
-        // escaped = escaped.replace(/&/g, '&amp;')
-        // escaped = escaped.replace(/</g, '&lt;')
-        escaped = escaped.replace(/(\r\n|\r|\n)/g, '<br>');
-        return escaped;
-    }
-    /**
-     * decode a text to a markdown text
-     * - end of line
-     * @param str the markdown text
-     * @returns the decoded text
-     */
-    static decodeMarkdown(str) {
-        if (!str) {
-            return '';
-        }
-        // escaped
-        let escaped = str.replace(/<br>/g, '\n');
-        // escaped = escaped.replace(/&lt;/g, '<')
-        // escaped = escaped.replace(/&amp;/g, '&')
-        escaped = escaped.replace(markdownDecodeReg, TextHelper.decodeReplacer);
-        return escaped;
-    }
-    static encodeReplacer(match) {
-        return `\\${match}`;
-    }
-    static decodeReplacer(_match, p1) {
-        return p1;
-    }
-}
-exports.TextHelper = TextHelper;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TextHelper = void 0;
+/**
+ * markdown escaped characters
+ */
+const markdownEncodeReg = /[\\`*{}[\]#+!|]/g;
+const markdownDecodeReg = /\\([\\`*{}[\]#+!|])/g;
+class TextHelper {
+    static splitToLines(str) {
+        return str.split(/\r\n|\n/);
+    }
+    static width(str) {
+        if (!str || str.length === 0) {
+            return 0;
+        }
+        let width = 0;
+        for (let i = 0; i < str.length; i += 1) {
+            width += str.charCodeAt(i) > 255 ? 2 : 1;
+        }
+        return width;
+    }
+    static padEnd(str, maxLen, fileString = ' ') {
+        const textWidth = TextHelper.width(str);
+        if (maxLen - textWidth > 0) {
+            return `${str}${''.padEnd(maxLen - textWidth, fileString)}`;
+        }
+        return str;
+    }
+    /**
+     * encode a text to a markdown text
+     * - end of line
+     * @param str text
+     * @returns the markdown text
+     */
+    static encodeMarkdown(str) {
+        if (!str) {
+            return '';
+        }
+        // escaped
+        let escaped = str.replace(markdownEncodeReg, TextHelper.encodeReplacer);
+        // escaped = escaped.replace(/&/g, '&amp;')
+        // escaped = escaped.replace(/</g, '&lt;')
+        escaped = escaped.replace(/(\r\n|\r|\n)/g, '<br>');
+        return escaped;
+    }
+    /**
+     * decode a text to a markdown text
+     * - end of line
+     * @param str the markdown text
+     * @returns the decoded text
+     */
+    static decodeMarkdown(str) {
+        if (!str) {
+            return '';
+        }
+        // fast path: nothing to decode (most table cells contain no escapes)
+        if (str.indexOf('<br>') === -1 && str.indexOf('\\') === -1) {
+            return str;
+        }
+        // escaped
+        let escaped = str.replace(/<br>/g, '\n');
+        // escaped = escaped.replace(/&lt;/g, '<')
+        // escaped = escaped.replace(/&amp;/g, '&')
+        escaped = escaped.replace(markdownDecodeReg, TextHelper.decodeReplacer);
+        return escaped;
+    }
+    static encodeReplacer(match) {
+        return `\\${match}`;
+    }
+    static decodeReplacer(_match, p1) {
+        return p1;
+    }
+}
+exports.TextHelper = TextHelper;
 //# sourceMappingURL=textHelper.js.map

package/dist/lib/utils/textHelper.js.map

@@ -1 +1 @@
-{"version":3,"file":"textHelper.js","sourceRoot":"","sources":["../../../src/lib/utils/textHelper.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACH,MAAM,iBAAiB,GAAG,kBAAkB,CAAA;AAC5C,MAAM,iBAAiB,GAAG,sBAAsB,CAAA;AAEhD,MAAa,UAAU;IACf,MAAM,CAAC,YAAY,CAAC,GAAW;QACrC,OAAO,GAAG,CAAC,KAAK,CAAC,SAAS,CAAC,CAAA;IAC5B,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,GAAW;QAC9B,IAAI,CAAC,GAAG,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC,EAAE;YAC7B,OAAO,CAAC,CAAA;SACR;QACD,IAAI,KAAK,GAAG,CAAC,CAAA;QACb,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE;YACvC,KAAK,IAAI,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;SACxC;QAED,OAAO,KAAK,CAAA;IACb,CAAC;IAEM,MAAM,CAAC,MAAM,CAAC,GAAW,EAAE,MAAc,EAAE,aAAqB,GAAG;QACzE,MAAM,SAAS,GAAG,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;QACvC,IAAI,MAAM,GAAG,SAAS,GAAG,CAAC,EAAE;YAC3B,OAAO,GAAG,GAAG,GAAG,EAAE,CAAC,MAAM,CAAC,MAAM,GAAG,SAAS,EAAE,UAAU,CAAC,EAAE,CAAA;SAC3D;QAED,OAAO,GAAG,CAAA;IACX,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,cAAc,CAAC,GAAW;QACvC,IAAI,CAAC,GAAG,EAAE;YACT,OAAO,EAAE,CAAA;SACT;QAED,UAAU;QACV,IAAI,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC,iBAAiB,EAAE,UAAU,CAAC,cAAc,CAAC,CAAA;QACvE,2CAA2C;QAC3C,0CAA0C;QAC1C,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,eAAe,EAAE,MAAM,CAAC,CAAA;QAClD,OAAO,OAAO,CAAA;IACf,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,cAAc,CAAC,GAAW;QACvC,IAAI,CAAC,GAAG,EAAE;YACT,OAAO,EAAE,CAAA;SACT;QAED,UAAU;QACV,IAAI,OAAO,GAAW,GAAG,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,CAAC,CAAA;QAChD,0CAA0C;QAC1C,2CAA2C;QAC3C,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,iBAAiB,EAAE,UAAU,CAAC,cAAc,CAAC,CAAA;QACvE,OAAO,OAAO,CAAA;IACf,CAAC;IAEO,MAAM,CAAC,cAAc,CAAC,KAAa;QAC1C,OAAO,KAAK,KAAK,EAAE,CAAA;IACpB,CAAC;IAEO,MAAM,CAAC,cAAc,CAAC,MAAc,EAAE,EAAU;QACvD,OAAO,EAAE,CAAA;IACV,CAAC;CACD;AAvED,gCAuEC"}
+{"version":3,"file":"textHelper.js","sourceRoot":"","sources":["../../../src/lib/utils/textHelper.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACH,MAAM,iBAAiB,GAAG,kBAAkB,CAAA;AAC5C,MAAM,iBAAiB,GAAG,sBAAsB,CAAA;AAEhD,MAAa,UAAU;IACf,MAAM,CAAC,YAAY,CAAC,GAAW;QACrC,OAAO,GAAG,CAAC,KAAK,CAAC,SAAS,CAAC,CAAA;IAC5B,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,GAAW;QAC9B,IAAI,CAAC,GAAG,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC9B,OAAO,CAAC,CAAA;QACT,CAAC;QACD,IAAI,KAAK,GAAG,CAAC,CAAA;QACb,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;YACxC,KAAK,IAAI,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;QACzC,CAAC;QAED,OAAO,KAAK,CAAA;IACb,CAAC;IAEM,MAAM,CAAC,MAAM,CAAC,GAAW,EAAE,MAAc,EAAE,aAAqB,GAAG;QACzE,MAAM,SAAS,GAAG,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;QACvC,IAAI,MAAM,GAAG,SAAS,GAAG,CAAC,EAAE,CAAC;YAC5B,OAAO,GAAG,GAAG,GAAG,EAAE,CAAC,MAAM,CAAC,MAAM,GAAG,SAAS,EAAE,UAAU,CAAC,EAAE,CAAA;QAC5D,CAAC;QAED,OAAO,GAAG,CAAA;IACX,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,cAAc,CAAC,GAAW;QACvC,IAAI,CAAC,GAAG,EAAE,CAAC;YACV,OAAO,EAAE,CAAA;QACV,CAAC;QAED,UAAU;QACV,IAAI,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC,iBAAiB,EAAE,UAAU,CAAC,cAAc,CAAC,CAAA;QACvE,2CAA2C;QAC3C,0CAA0C;QAC1C,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,eAAe,EAAE,MAAM,CAAC,CAAA;QAClD,OAAO,OAAO,CAAA;IACf,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,cAAc,CAAC,GAAW;QACvC,IAAI,CAAC,GAAG,EAAE,CAAC;YACV,OAAO,EAAE,CAAA;QACV,CAAC;QAED,qEAAqE;QACrE,IAAI,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;YAC5D,OAAO,GAAG,CAAA;QACX,CAAC;QAED,UAAU;QACV,IAAI,OAAO,GAAW,GAAG,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,CAAC,CAAA;QAChD,0CAA0C;QAC1C,2CAA2C;QAC3C,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,iBAAiB,EAAE,UAAU,CAAC,cAAc,CAAC,CAAA;QACvE,OAAO,OAAO,CAAA;IACf,CAAC;IAEO,MAAM,CAAC,cAAc,CAAC,KAAa;QAC1C,OAAO,KAAK,KAAK,EAAE,CAAA;IACpB,CAAC;IAEO,MAAM,CAAC,cAAc,CAAC,MAAc,EAAE,EAAU;QACvD,OAAO,EAAE,CAAA;IACV,CAAC;CACD;AA5ED,gCA4EC"}

package/dist/models/databaseTypes.d.ts

@@ -1,33 +1,33 @@
-/**
- * Supported Database Types
- */
-export declare enum DatabaseTypes {
-    /**
-     * DB2
-     */
-    db2 = "db2",
-    /**
-     * MariaDB
-     */
-    mariadb = "mariadb",
-    /**
-     * SQL Server
-     */
-    mssql = "mssql",
-    /**
-     * MySQL
-     */
-    mysql = "mysql",
-    /**
-     * Oracle Database
-     */
-    oracle = "oracle",
-    /**
-     * PostgreSQL
-     */
-    postgresql = "postgresql",
-    /**
-     * SQLite
-     */
-    sqlite = "sqlite"
-}
+/**
+ * Supported Database Types
+ */
+export declare enum DatabaseTypes {
+    /**
+     * DB2
+     */
+    db2 = "db2",
+    /**
+     * MariaDB
+     */
+    mariadb = "mariadb",
+    /**
+     * SQL Server
+     */
+    mssql = "mssql",
+    /**
+     * MySQL
+     */
+    mysql = "mysql",
+    /**
+     * Oracle Database
+     */
+    oracle = "oracle",
+    /**
+     * PostgreSQL
+     */
+    postgresql = "postgresql",
+    /**
+     * SQLite
+     */
+    sqlite = "sqlite"
+}

package/dist/models/databaseTypes.js

@@ -1,38 +1,38 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DatabaseTypes = void 0;
-/**
- * Supported Database Types
- */
-var DatabaseTypes;
-(function (DatabaseTypes) {
-    /**
-     * DB2
-     */
-    DatabaseTypes["db2"] = "db2";
-    /**
-     * MariaDB
-     */
-    DatabaseTypes["mariadb"] = "mariadb";
-    /**
-     * SQL Server
-     */
-    DatabaseTypes["mssql"] = "mssql";
-    /**
-     * MySQL
-     */
-    DatabaseTypes["mysql"] = "mysql";
-    /**
-     * Oracle Database
-     */
-    DatabaseTypes["oracle"] = "oracle";
-    /**
-     * PostgreSQL
-     */
-    DatabaseTypes["postgresql"] = "postgresql";
-    /**
-     * SQLite
-     */
-    DatabaseTypes["sqlite"] = "sqlite";
-})(DatabaseTypes = exports.DatabaseTypes || (exports.DatabaseTypes = {}));
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DatabaseTypes = void 0;
+/**
+ * Supported Database Types
+ */
+var DatabaseTypes;
+(function (DatabaseTypes) {
+    /**
+     * DB2
+     */
+    DatabaseTypes["db2"] = "db2";
+    /**
+     * MariaDB
+     */
+    DatabaseTypes["mariadb"] = "mariadb";
+    /**
+     * SQL Server
+     */
+    DatabaseTypes["mssql"] = "mssql";
+    /**
+     * MySQL
+     */
+    DatabaseTypes["mysql"] = "mysql";
+    /**
+     * Oracle Database
+     */
+    DatabaseTypes["oracle"] = "oracle";
+    /**
+     * PostgreSQL
+     */
+    DatabaseTypes["postgresql"] = "postgresql";
+    /**
+     * SQLite
+     */
+    DatabaseTypes["sqlite"] = "sqlite";
+})(DatabaseTypes || (exports.DatabaseTypes = DatabaseTypes = {}));
 //# sourceMappingURL=databaseTypes.js.map

package/dist/models/databaseTypes.js.map

@@ -1 +1 @@
-{"version":3,"file":"databaseTypes.js","sourceRoot":"","sources":["../../src/models/databaseTypes.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACH,IAAY,aAmCX;AAnCD,WAAY,aAAa;IACxB;;OAEG;IACH,4BAAW,CAAA;IAEX;;OAEG;IACH,oCAAmB,CAAA;IAEnB;;OAEG;IACH,gCAAe,CAAA;IAEf;;OAEG;IACH,gCAAe,CAAA;IAEf;;OAEG;IACH,kCAAiB,CAAA;IAEjB;;OAEG;IACH,0CAAyB,CAAA;IAEzB;;OAEG;IACH,kCAAiB,CAAA;AAClB,CAAC,EAnCW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAmCxB"}
+{"version":3,"file":"databaseTypes.js","sourceRoot":"","sources":["../../src/models/databaseTypes.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACH,IAAY,aAmCX;AAnCD,WAAY,aAAa;IACxB;;OAEG;IACH,4BAAW,CAAA;IAEX;;OAEG;IACH,oCAAmB,CAAA;IAEnB;;OAEG;IACH,gCAAe,CAAA;IAEf;;OAEG;IACH,gCAAe,CAAA;IAEf;;OAEG;IACH,kCAAiB,CAAA;IAEjB;;OAEG;IACH,0CAAyB,CAAA;IAEzB;;OAEG;IACH,kCAAiB,CAAA;AAClB,CAAC,EAnCW,aAAa,6BAAb,aAAa,QAmCxB"}

package/dist/models/dbColumn.d.ts

@@ -1,43 +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;
-}
+/**
+ * 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

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

package/dist/models/dbDiffModel.d.ts

@@ -1,43 +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;
-}
+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

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

package/dist/models/dbForeignKey.d.ts

@@ -1,33 +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;
-}
+/**
+ * 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

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

package/dist/models/dbIndex.d.ts

@@ -1,28 +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;
-}
+/**
+ * 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

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

package/dist/models/dbIndexType.d.ts

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