db-modeling-markdown 1.0.6 → 2.0.1

package/CHANGELOG.md

@@ -7,27 +7,39 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-## [1.0.6] - 2021-11-19
+## [2.0.1] - 2022-12-08
 
 ### Changes
 
+- [Feature]: [mariadb/mysql] provice method `fromDatabase`
+  Generate database model markdow files from a specific database.
+- [Feature]: [mariadb/mysql] provice method `toUpgradeSql`
+  Generate a SQL file with upgrade scripts.
+- [Feature]: provide more readable format for markdown files
+- [Feature]: [mariadb/mysql] provice method `genIndexFile`
+  Generate a `index.md` for all tables
+
+## [1.0.6] - 2021-11-19
+
+### Fix
+
 - [Defect]: error when there is an empty definition file
 
 ## [1.0.5] - 2021-11-19
 
-### Changes
+### Fix
 
 - [Defect]: bad package
 
 ## [1.0.4] - 2021-11-19
 
-### Changes
+### Fix
 
 - [Defect]: bad package
 
 ## [1.0.3] - 2021-11-17
 
-### Changes
+### Fix
 
 - [Defect]: do not export file when file name is not provided.
 
@@ -36,6 +48,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Changes
 
 - [Feature]: provice method toMarkdown
+
+### Fixed
+
 - [Defect]: some document issues.
 
 ## [1.0.1] - 2020-02-22

package/CONTRIBUTING.md

@@ -3,22 +3,26 @@
 ## Prepare Development Environment
 
 ```sh
-yarn install -g prettier
-yarn install -g ts-node
-yarn install -g typescript
-yarn install
+npm add --global yarn
+npm add --global prettier typescript ts-node
+yarn
 yarn prepare
 ```
 
 ## Publish steps
 
-- change the package version
-- change CHANGELOG
-- change version in README
+- change the package version `package.json`
+- change `CHANGELOG.md` for new features or fixes.
+- update sample scripts `examples\generator.ts`
+- update `README.md`
+  - version
+  - sample typescrit
+  - features and so on
 - build: run `yarn build`
 - check the package
+- edit `~/npmrc`, comment out the mirrow repositories
+- if need, `npm adduser` to add your npm user
 - publish: `npm publish --access public`
-
 - document: update gitee pages
 
 ## Test
@@ -32,7 +36,18 @@ yarn test
 - test a specific test file
 
 ```sh
-jest filename.test.ts
+yarn test filename.test.ts
+```
+
+## Tips
+
+- we can use the variable `OverwriteExpected` to overwrite expected files
+
+[dbmService.test.ts](tests\services\dbmService.test.ts)
+
+```ts
+// used to overwrite expected data
+const OverwriteExpected = false
 ```
 
 ## Command
@@ -43,6 +58,16 @@ jest filename.test.ts
 // run tests\data\generateMarkdown.ts
 ```
 
+- husky: project initialization
+
+```sh
+# husky init (for project initialization)
+# npx husky-init
+```
+
+- husky: pre-commit command
+  [pre-commit.sh](.husky/pre-commit)
+
 ## Guidelings
 
 ### Coding Conventions

package/README.md

@@ -6,7 +6,7 @@ Now, you may define your database tables in markdown files, and this utility wil
 
 ## Release Notes
 
-### 1.0.6
+### 2.0.1
 
 [Change Log](./CHANGELOG.md)
 
@@ -15,86 +15,123 @@ Now, you may define your database tables in markdown files, and this utility wil
 Define a markdown file(.db.md) like：
 
 ```markdown
-# Table: Departments
+# Table: departments
 
-- `Name`: Departments
-- `Comment`: The department table.
+## `Table`
+
+| `Name`      | `Comment`             | `Character Set` | `Collation`        |
+| ----------- | --------------------- | --------------- | ------------------ |
+| departments | The department table. | utf8mb4         | utf8mb4_general_ci |
 
 ## `Primary Key`
 
-- `Columns`: DepartmentID
-- `Cluster`: `true`
+| `Columns`    |
+| ------------ |
+| DepartmentID |
 
-## `Indexes[]`
+## `Indexes`
 
-## `Foreign Keys[]`
+## `Foreign Keys`
 
 | `Columns` | `Ref Table` | `Ref Columns` | `Options` |
 | --------- | ----------- | ------------- | --------- |
-| ManagerID | Employees   | EmployeeID    |           |
-| ParentID  | Departments | DepartmentID  |           |
-
-## `Columns[]`
-
-| `Label`           | `Name`         | `Type`             | `Nullable` | `Default` | `Comment` |
-| ----------------- | -------------- | ------------------ | ---------- | --------- | --------- |
-| Department ID     | DepartmentID   | int auto_increment | `false`    |           |           |
-| Department Name   | DepartmentName | varchar(50)        | `false`    |           |           |
-| Parent Department | ParentID       | int                | `true`     |           |           |
-| Manager           | ManagerID      | int                | `true`     |           |           |
+| ManagerID | employees   | EmployeeID    |           |
+| ParentID  | departments | DepartmentID  |           |
+
+## `Columns`
+
+| `Label`         | `Name`         | `Type`                                 | `Nullable` | `Default`           | `Comment`            |
+| --------------- | -------------- | -------------------------------------- | ---------- | ------------------- | -------------------- |
+| Department ID   | DepartmentID   | int auto_increment                     | `No`       |                     | Department ID        |
+| Department Name | DepartmentName | varchar(50)                            | `No`       |                     | Department Name      |
+| Parent ID       | ParentID       | int                                    | `Yes`      |                     | Parent Department    |
+| Manager ID      | ManagerID      | int                                    | `Yes`      |                     | Manager              |
+| Created By      | CreatedBy      | varchar(255)                           | `No`       | ''                  | Created By User Name |
+| Create Time     | CreateTime     | datetime                               | `No`       | current_timestamp() | Created Time         |
+| Update By       | UpdateBy       | varchar(255)                           | `No`       | ''                  | Updated By User Name |
+| Update Time     | UpdateTime     | datetime on update current_timestamp() | `No`       | current_timestamp() | Updated Time         |
 ```
 
 You will get SQL scripts:
 
 ```sql
-CREATE TABLE Departments (
-   DepartmentID int auto_increment NOT NULL COMMENT 'Department ID'
-  ,DepartmentName varchar(50) NOT NULL COMMENT 'Department Name'
-  ,ParentID int NULL COMMENT 'Parent Department'
-  ,ManagerID int NULL COMMENT 'Manager'
-  ,CONSTRAINT PK_Departments PRIMARY KEY (DepartmentID)
-);
+-- Create table 'departments'
+CREATE TABLE `departments` (
+    `DepartmentID` int auto_increment NOT NULL COMMENT 'Department ID'
+  , `DepartmentName` varchar(50) NOT NULL COMMENT 'Department Name'
+  , `ParentID` int COMMENT 'Parent Department'
+  , `ManagerID` int COMMENT 'Manager'
+  , `CreatedBy` varchar(255) NOT NULL DEFAULT '' COMMENT 'Created By User Name'
+  , `CreateTime` datetime NOT NULL DEFAULT current_timestamp() COMMENT 'Created Time'
+  , `UpdateBy` varchar(255) NOT NULL DEFAULT '' COMMENT 'Updated By User Name'
+  , `UpdateTime` datetime on update current_timestamp() NOT NULL DEFAULT current_timestamp() COMMENT 'Updated Time'
+  , PRIMARY KEY (DepartmentID)
+) COMMENT='The department table.'
+;
 ```
 
 ## Sample Code
 
 ```typescript
-import * as path from 'path';
-
-import { DatabaseTypes, DbmService, DbmOptions } from 'db-modeling-markdown';
-
-const context: DbmOptions = new DbmOptions();
-context.database = DatabaseTypes.mysql;
-context.sourceFolder = path.join(__dirname, '../tests/data/mysql/tables');
+import * as path from 'path'
+
+import { DatabaseTypes, DbmOptions, DbmService } from '../src'
+
+const options: DbmOptions = new DbmOptions()
+options.database = DatabaseTypes.mariadb
+
+// Generate database modeling markdown files (.db.md) from a database
+options.sourceFolder = path.join(__dirname, `../../temp/tables/v1`)
+await DbmService.fromDatabase(
+	{
+		databaseType: options.database,
+		host: '127.0.0.1',
+		port: 3306,
+		user: 'root',
+		password: 'password',
+		database: 'my-db',
+	},
+	options.sourceFolder,
+	true,
+)
 
 // Read table definition markdow files(.db.md), and produce a sql file with create-table-if-not-exists scripts
-context.targetPath = path.join(__dirname, '../tmp/createTableIf.sql');
-DbmService.toCreateTableIfNotExistsSql(context);
+options.sourceFolder = path.join(__dirname, '../tests/data/mariadb/tables')
+options.targetPath = path.join(__dirname, '../temp/createTableIf.sql')
+DbmService.toCreateTableIfNotExistsSql(options)
 
 // Read table definition markdow files(.db.md), and produce a sql file with create-table scripts
-context.targetPath = path.join(__dirname, '../tmp/createTable.sql');
-DbmService.toCreateTableSql(context);
+options.targetPath = path.join(__dirname, '../temp/createTable.sql')
+DbmService.toCreateTableSql(options)
 
 // Read table definition markdow files(.db.md), and produce a sql file with drop-table scripts
-context.targetPath = path.join(__dirname, '../tmp/dropTable.sql');
-DbmService.toDropTableSql(context);
+options.targetPath = path.join(__dirname, '../temp/dropTable.sql')
+DbmService.toDropTableSql(options)
 
 // Read table definition markdow files(.db.md), and produce a sql file with drop-then-create-table scripts
-context.targetPath = path.join(__dirname, '../tmp/dropThenCreateTable.sql');
-DbmService.toDropThenCreateTableSql(context);
+options.targetPath = path.join(__dirname, '../temp/dropThenCreateTable.sql')
+DbmService.toDropThenCreateTableSql(options)
+
+// Read table definition markdow files(.db.md), and produce a sql file with upgrade scripts
+options.previousVersionFolder = path.join(__dirname, `../tests/data/mariadb/tables/v1`)
+options.targetPath = path.join(__dirname, '../temp/upgrade.sql')
+DbmService.toUpgradeSql(options)
 
 // Read table definition markdow files(.db.md), and produce a json file
-context.targetPath = path.join(__dirname, '../tmp/model.json');
-DbmService.toJson(context);
+options.targetPath = path.join(__dirname, '../temp/model.json')
+DbmService.toJson(options)
 
 // Read table definition markdow files(.db.md), and produce a model object
-context.targetPath = '';
-const model = DbmService.toModel(context);
-console.log(JSON.stringify(model, null, 2));
+options.targetPath = ''
+const model = DbmService.toModel(options)
+// eslint-disable-next-line no-console
+console.log(JSON.stringify(model, null, 2))
 
 // Generate database modeling markdown files (.db.md) from a model
-DbmService.toMarkdown(model, path.join(__dirname, '../tmp/tables'), true);
+DbmService.toMarkdown(model, path.join(__dirname, '../temp/tables'), true)
 
+// Generate index.md from a model
+DbmService.genIndexFile(model, options.sourceFolder)
 ```
 
 ## Features
@@ -113,8 +150,15 @@ DbmService.toMarkdown(model, path.join(__dirname, '../tmp/tables'), true);
 - Support generate SQL scripts of create tables if not exists.
 - Support generate SQL scripts of drop then create tables.
 - Support generate SQL scripts of drop tables.
+- Support generate SQL scripts of upgrade a database (mariadb/mysql only).
+- Support generate database definition markdown files from a database (mariadb/mysql only).
 - Support generate a json file of the database model.
 - Support generate an model object of the database model.
-- Support generate database definition markdown files from a database model.
+- Support generate database definition markdown files from a database model (json).
+- Support generate `index.md` for a database model.
+
+## Contributing
+
+Please see [Contributing](./CONTRIBUTING.md)
 
 **Enjoy!**

package/dist/dialects/core/dbImportProvider.d.ts

@@ -0,0 +1,5 @@
+import { DbModel } from '../../models/dbModel';
+import { DbOptions } from '../../services/dbOptions';
+export declare abstract class DbImportProvider {
+    abstract getModel(dbOptions: DbOptions): Promise<DbModel>;
+}

package/dist/dialects/core/dbImportProvider.js

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

package/dist/dialects/core/dbImportProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dbImportProvider.js","sourceRoot":"","sources":["../../../src/dialects/core/dbImportProvider.ts"],"names":[],"mappings":";;;AAGA,MAAsB,gBAAgB;CAErC;AAFD,4CAEC"}

package/dist/dialects/core/dbProvider.d.ts

@@ -1,11 +1,18 @@
-import { DbModel, DbColumn, DbForeignKey, DbIndex, DbTable } from '../../services/dbModel';
+import { DbColumn } from '../../models/dbColumn';
+import { DbForeignKey } from '../../models/dbForeignKey';
+import { DbIndex } from '../../models/dbIndex';
+import { DbModel } from '../../models/dbModel';
+import { DbTable } from '../../models/dbTable';
+export declare const line: string;
+export declare const indent: string;
 export declare abstract class DbProvider {
     private outputs;
     getColumnComment(column: DbColumn): string;
-    abstract getCreateTableIfNotExistsSql(model: DbModel, withComments: boolean): string;
-    abstract getCreateTableSql(model: DbModel, withComments: boolean): string;
-    abstract getDropTableSql(model: DbModel, withComments: boolean): string;
-    abstract getDropThenCreateTableSql(model: DbModel, withComments: boolean): string;
+    abstract getCreateTableIfNotExistsSql(model: DbModel, withComment: boolean): string;
+    abstract getCreateTableSql(model: DbModel, withComment: boolean): string;
+    abstract getDropTableSql(model: DbModel, withComment: boolean): string;
+    abstract getDropThenCreateTableSql(model: DbModel, withComment: boolean): string;
+    getUpgradeSql(fromModel: DbModel, model: DbModel, withComment: boolean): string;
     private getOutput;
     outputCopy(): string;
     outputInitialize(): void;
@@ -13,9 +20,15 @@ export declare abstract class DbProvider {
     outputlnln(text: string, outputId?: number): void;
     renderDefaultName(table: DbTable, column: DbColumn): string;
     renderFkName(table: DbTable, foreignKey: DbForeignKey): string;
+    renderFkName2(tableName: string, foreignKey: DbForeignKey): string;
     renderIndexName(table: DbTable, index: DbIndex): string;
+    renderIndexName2(tableName: string, index: DbIndex): string;
     renderPkName(table: DbTable): string;
     renderTableName(name: string): string;
+    /**
+     * make sure the length of the name is <= 64
+     * @param name the key name
+     */
+    private renderName;
     stripBrackets(value: string, stripAll?: boolean): string;
 }
-export declare const line: string;

package/dist/dialects/core/dbProvider.js

@@ -1,17 +1,24 @@
 "use strict";
+/* eslint-disable class-methods-use-this */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.line = exports.DbProvider = void 0;
+exports.DbProvider = exports.indent = exports.line = void 0;
+exports.line = '\n';
+exports.indent = '    ';
 class DbProvider {
     constructor() {
         this.outputs = new Map();
     }
     getColumnComment(column) {
-        let sqlComment = (column.comment ? column.comment : '');
-        if (sqlComment.length === 0 && column.label.length > 0) {
+        let sqlComment = column.comment ? column.comment : '';
+        if (sqlComment.length === 0 && column.label) {
             sqlComment = column.label;
         }
         return sqlComment;
     }
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    getUpgradeSql(fromModel, model, withComment) {
+        throw new Error('Method not implemented.');
+    }
     getOutput(outputId) {
         let output = this.outputs.get(outputId);
         if (output === undefined) {
@@ -48,10 +55,23 @@ class DbProvider {
         return `DF_${this.renderTableName(table.name)}_${column.name}`;
     }
     renderFkName(table, foreignKey) {
-        return `FK_${this.renderTableName(table.name)}_${foreignKey.columns.replace(/[()\s]/g, '').replace(',', '_')}`;
+        return this.renderFkName2(table.name, foreignKey);
+    }
+    renderFkName2(tableName, foreignKey) {
+        return `FK_${this.renderTableName(tableName)}_${foreignKey.columns
+            .replace(/[()\s]/g, '')
+            .replace(/,/g, '_')}`;
     }
     renderIndexName(table, index) {
-        return `IK_${this.renderTableName(table.name)}_${index.columns.replace(/[()\s]/g, '').replace(',', '_')}`;
+        return this.renderIndexName2(table.name, index);
+    }
+    renderIndexName2(tableName, index) {
+        if (index.name) {
+            return index.name;
+        }
+        return `IK_${this.renderTableName(tableName)}_${index.columns
+            .replace(/[()\s]/g, '')
+            .replace(/,/g, '_')}`;
     }
     renderPkName(table) {
         return `PK_${this.renderTableName(table.name)}`;
@@ -59,6 +79,21 @@ class DbProvider {
     renderTableName(name) {
         return name.replace('\\s', '').replace('_', '');
     }
+    /**
+     * make sure the length of the name is <= 64
+     * @param name the key name
+     */
+    renderName(prefix, columns, name) {
+        if (name.length <= 64) {
+            return name;
+        }
+        const sections = name.split('_');
+        // for 1 field case, cut it
+        if (sections.length <= 2) {
+            return name.substring(0, 64);
+        }
+        return name;
+    }
     stripBrackets(value, stripAll = false) {
         let newValue = value;
         const minLength = stripAll ? 2 : 4;
@@ -82,5 +117,4 @@ class DbProvider {
     }
 }
 exports.DbProvider = DbProvider;
-exports.line = '\n';
 //# sourceMappingURL=dbProvider.js.map

package/dist/dialects/core/dbProvider.js.map

@@ -1 +1 @@
-{"version":3,"file":"dbProvider.js","sourceRoot":"","sources":["../../../src/dialects/core/dbProvider.ts"],"names":[],"mappings":";;;AASA,MAAsB,UAAU;IAAhC;QACS,YAAO,GAAG,IAAI,GAAG,EAAkB,CAAC;IAkG7C,CAAC;IAhGO,gBAAgB,CAAC,MAAgB;QACvC,IAAI,UAAU,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QACxD,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,IAAI,MAAM,CAAC,KAAM,CAAC,MAAM,GAAG,CAAC,EAAE;YACxD,UAAU,GAAG,MAAM,CAAC,KAAM,CAAC;SAC3B;QACD,OAAO,UAAU,CAAC;IACnB,CAAC;IAOO,SAAS,CAAC,QAAgB;QACjC,IAAI,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACxC,IAAI,MAAM,KAAK,SAAS,EAAE;YACzB,MAAM,GAAG,EAAE,CAAC;YACZ,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;SACnC;QACD,OAAO,MAAM,CAAC;IACf,CAAC;IAEM,UAAU;QAChB,IAAI,MAAM,GAAG,EAAE,CAAC;QAChB,IAAI,IAAI,GAAa,EAAE,CAAC;QACxB,gDAAgD;QAChD,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE;YACtC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;SACf;QACD,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;QAClC,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE;YAC3B,MAAM,IAAI,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,YAAI,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC7D,CAAC,CAAC,CAAC;QAEH,OAAO,MAAM,CAAC;IACf,CAAC;IAEM,gBAAgB;QACtB,IAAI,CAAC,OAAO,GAAG,IAAI,GAAG,EAAkB,CAAC;IAC1C,CAAC;IAEM,QAAQ,CAAC,IAAY,EAAE,WAAmB,CAAC;QACjD,IAAI,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;QACtC,MAAM,IAAI,IAAI,GAAG,YAAI,CAAC;QACtB,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IACpC,CAAC;IAEM,UAAU,CAAC,IAAY,EAAE,WAAmB,CAAC;QACnD,IAAI,CAAC,QAAQ,CAAC,IAAI,GAAG,YAAI,EAAE,QAAQ,CAAC,CAAC;IACtC,CAAC;IAEM,iBAAiB,CAAC,KAAc,EAAE,MAAgB;QACxD,OAAO,MAAM,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC;IAChE,CAAC;IAEM,YAAY,CAClB,KAAc,EACd,UAAwB;QAExB,OAAO,MAAM,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,CAAC;IAChH,CAAC;IAEM,eAAe,CACrB,KAAc,EACd,KAAc;QAEd,OAAO,MAAM,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,CAAC;IAC3G,CAAC;IAEM,YAAY,CAAC,KAAc;QACjC,OAAO,MAAM,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;IACjD,CAAC;IAEM,eAAe,CAAC,IAAY;QAClC,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;IACjD,CAAC;IAEM,aAAa,CAAC,KAAa,EAAE,WAAoB,KAAK;QAC5D,IAAI,QAAQ,GAAG,KAAK,CAAC;QACrB,MAAM,SAAS,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACnC,OAAO,QAAQ,CAAC,MAAM,GAAG,SAAS,EAAE;YACnC,IAAI,QAAQ,EAAE;gBACb,IAAI,QAAQ,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;oBACvD,QAAQ,GAAG,QAAQ,CAAC,SAAS,CAAC,CAAC,EAAE,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;iBACtD;qBAAM;oBACN,MAAM;iBACN;aACD;iBAAM,IAAI,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE;gBAChE,QAAQ,GAAG,QAAQ,CAAC,SAAS,CAAC,CAAC,EAAE,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;aACtD;iBAAM;gBACN,MAAM;aACN;SACD;QAED,OAAO,QAAQ,CAAC;IACjB,CAAC;CACD;AAnGD,gCAmGC;AAEY,QAAA,IAAI,GAAW,IAAI,CAAC"}
+{"version":3,"file":"dbProvider.js","sourceRoot":"","sources":["../../../src/dialects/core/dbProvider.ts"],"names":[],"mappings":";AAAA,2CAA2C;;;AAQ9B,QAAA,IAAI,GAAW,IAAI,CAAA;AACnB,QAAA,MAAM,GAAW,MAAM,CAAA;AAEpC,MAAsB,UAAU;IAAhC;QACS,YAAO,GAAG,IAAI,GAAG,EAAkB,CAAA;IAmI5C,CAAC;IAjIO,gBAAgB,CAAC,MAAgB;QACvC,IAAI,UAAU,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAA;QACrD,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,IAAI,MAAM,CAAC,KAAK,EAAE;YAC5C,UAAU,GAAG,MAAM,CAAC,KAAK,CAAA;SACzB;QACD,OAAO,UAAU,CAAA;IAClB,CAAC;IAMD,6DAA6D;IACtD,aAAa,CAAC,SAAkB,EAAE,KAAc,EAAE,WAAoB;QAC5E,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAA;IAC3C,CAAC;IAEO,SAAS,CAAC,QAAgB;QACjC,IAAI,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;QACvC,IAAI,MAAM,KAAK,SAAS,EAAE;YACzB,MAAM,GAAG,EAAE,CAAA;YACX,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;SAClC;QAED,OAAO,MAAM,CAAA;IACd,CAAC;IAEM,UAAU;QAChB,IAAI,MAAM,GAAG,EAAE,CAAA;QACf,IAAI,IAAI,GAAa,EAAE,CAAA;QACvB,gDAAgD;QAChD,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE;YACtC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;SACd;QACD,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAA;QACjC,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE;YAC3B,MAAM,IAAI,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,YAAI,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;QAC5D,CAAC,CAAC,CAAA;QAEF,OAAO,MAAM,CAAA;IACd,CAAC;IAEM,gBAAgB;QACtB,IAAI,CAAC,OAAO,GAAG,IAAI,GAAG,EAAkB,CAAA;IACzC,CAAC;IAEM,QAAQ,CAAC,IAAY,EAAE,WAAmB,CAAC;QACjD,IAAI,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAA;QACrC,MAAM,IAAI,IAAI,GAAG,YAAI,CAAA;QACrB,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;IACnC,CAAC;IAEM,UAAU,CAAC,IAAY,EAAE,WAAmB,CAAC;QACnD,IAAI,CAAC,QAAQ,CAAC,IAAI,GAAG,YAAI,EAAE,QAAQ,CAAC,CAAA;IACrC,CAAC;IAEM,iBAAiB,CAAC,KAAc,EAAE,MAAgB;QACxD,OAAO,MAAM,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,MAAM,CAAC,IAAI,EAAE,CAAA;IAC/D,CAAC;IAEM,YAAY,CAAC,KAAc,EAAE,UAAwB;QAC3D,OAAO,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,IAAI,EAAE,UAAU,CAAC,CAAA;IAClD,CAAC;IAEM,aAAa,CAAC,SAAiB,EAAE,UAAwB;QAC/D,OAAO,MAAM,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,IAAI,UAAU,CAAC,OAAO;aAChE,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC;aACtB,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,EAAE,CAAA;IACvB,CAAC;IAEM,eAAe,CAAC,KAAc,EAAE,KAAc;QACpD,OAAO,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,CAAA;IAChD,CAAC;IAEM,gBAAgB,CAAC,SAAiB,EAAE,KAAc;QACxD,IAAI,KAAK,CAAC,IAAI,EAAE;YACf,OAAO,KAAK,CAAC,IAAI,CAAA;SACjB;QACD,OAAO,MAAM,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,IAAI,KAAK,CAAC,OAAO;aAC3D,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC;aACtB,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,EAAE,CAAA;IACvB,CAAC;IAEM,YAAY,CAAC,KAAc;QACjC,OAAO,MAAM,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAA;IAChD,CAAC;IAEM,eAAe,CAAC,IAAY;QAClC,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAA;IAChD,CAAC;IAED;;;OAGG;IACK,UAAU,CAAC,MAAc,EAAE,OAAe,EAAE,IAAY;QAC/D,IAAI,IAAI,CAAC,MAAM,IAAI,EAAE,EAAE;YACtB,OAAO,IAAI,CAAA;SACX;QAED,MAAM,QAAQ,GAAa,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;QAC1C,2BAA2B;QAC3B,IAAI,QAAQ,CAAC,MAAM,IAAI,CAAC,EAAE;YACzB,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,CAAA;SAC5B;QAGD,OAAO,IAAI,CAAA;IACZ,CAAC;IAEM,aAAa,CAAC,KAAa,EAAE,WAAoB,KAAK;QAC5D,IAAI,QAAQ,GAAG,KAAK,CAAA;QACpB,MAAM,SAAS,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;QAClC,OAAO,QAAQ,CAAC,MAAM,GAAG,SAAS,EAAE;YACnC,IAAI,QAAQ,EAAE;gBACb,IAAI,QAAQ,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;oBACvD,QAAQ,GAAG,QAAQ,CAAC,SAAS,CAAC,CAAC,EAAE,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;iBACrD;qBAAM;oBACN,MAAK;iBACL;aACD;iBAAM,IAAI,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE;gBAChE,QAAQ,GAAG,QAAQ,CAAC,SAAS,CAAC,CAAC,EAAE,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;aACrD;iBAAM;gBACN,MAAK;aACL;SACD;QAED,OAAO,QAAQ,CAAA;IAChB,CAAC;CACD;AApID,gCAoIC"}

package/dist/dialects/core/dbUtils.d.ts

@@ -0,0 +1,35 @@
+import { DbColumn } from '../../models/dbColumn';
+import { DbForeignKey } from '../../models/dbForeignKey';
+import { DbIndex } from '../../models/dbIndex';
+import { DbModel } from '../../models/dbModel';
+import { DbTable } from '../../models/dbTable';
+export declare const line: string;
+export declare const indent: string;
+export declare class DbUtils {
+    static getComment(column: DbColumn): string | undefined;
+    /**
+     * Generate names for indexes and foreign keys
+     * @param model the database model
+     * @param maxLength the max length of key name limitation
+     */
+    static genModelNames(model: DbModel, maxLength?: number): void;
+    /**
+     * Generate names for indexes and foreign keys
+     * - table name + first field
+     * - if there is a duplicate, and more fields
+     * - only keep characters in max length
+     * - if there is a duplicate, remove and last 4 chars and add an index like 0001.
+     * @param table
+     * @param maxLength
+     */
+    static genTableNames(table: DbTable, maxLength?: number): void;
+    static renderDefaultName(table: DbTable, column: DbColumn): string;
+    static renderFkName(table: DbTable, foreignKey: DbForeignKey): string;
+    static renderFkName2(tableName: string, foreignKey: DbForeignKey): string;
+    static renderIndexName(table: DbTable, index: DbIndex): string;
+    static renderIndexName2(tableName: string, index: DbIndex): string;
+    static renderPkName(table: DbTable): string;
+    static renderTableName(name: string): string;
+    static stripBrackets(value: string, stripAll?: boolean): string;
+    static log(data: any): string;
+}