db-modeling-markdown 2.0.1 → 2.1.0

package/dist/models/dbIndexType.js

@@ -1,13 +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 = {}));
+"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 = DbIndexType = {}));
 //# sourceMappingURL=dbIndexType.js.map

package/dist/models/dbIndexType.js.map

@@ -1 +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"}
+{"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,2BAAX,WAAW,QAItB"}

package/dist/models/dbModel.d.ts

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

package/dist/models/dbModel.js

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

package/dist/models/dbPrimaryKey.d.ts

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

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

package/dist/models/dbTable.d.ts

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

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

package/dist/models/dbTableMarkdown.d.ts

@@ -1,34 +1,35 @@
-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;
-    }[];
-}
+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;
+        engine?: string;
+        name: string;
+    }[];
+}

package/dist/models/dbTableMarkdown.js

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

package/dist/resources/mariadb/procAppUpgradeDB.sql

@@ -0,0 +1,164 @@
+drop procedure if exists procAppUpgradeDB;
+drop function if exists funcAppTableExists;
+drop function if exists funcAppColumnExists;
+drop function if exists funcAppPrimaryKeyExists;
+drop function if exists funcAppIndexExists;
+drop function if exists funcAppForeignKeyExists;
+
+DELIMITER $$
+
+create function funcAppTableExists(p_table text)
+returns int
+begin
+  declare v_count int;
+  
+  select
+    count(*) into v_count
+  from
+    information_schema.tables t
+  where
+    t.table_name = p_table
+  and t.table_schema = database();
+
+  return v_count;
+end;
+$$
+
+create function funcAppColumnExists(p_table text, p_column text)
+returns int
+begin
+  declare v_count int;
+  
+  select 
+    count(*) into v_count
+  from 
+    information_schema.columns c
+  where 
+    c.table_schema = database()
+  and c.table_name = p_table
+  and c.column_name = p_column;
+
+  return v_count;
+end;
+$$
+
+create function funcAppPrimaryKeyExists(p_table text, p_columns text)
+returns int
+begin
+  declare v_count int;
+  
+  select 
+    count(*) into v_count
+  from 
+    (
+      select
+        s.table_name,
+        s.index_name,
+        group_concat(s.column_name) columns
+      from 
+        information_schema.statistics s
+      join information_schema.table_constraints tc
+      on 
+        s.table_schema = tc.table_schema
+      and s.table_name = tc.table_name
+      and s.index_name = tc.constraint_name
+      where
+        s.table_schema = database()
+      and s.table_name = p_table
+      and tc.constraint_type = 'PRIMARY KEY'
+      group by s.table_name, s.index_name
+    ) a
+  where 
+    a.columns = p_columns;
+
+  return v_count;
+end;
+$$
+
+create function funcAppIndexExists(p_table text, p_columns text)
+returns int
+begin
+  declare v_count int;
+  
+  select 
+    count(*) into v_count
+  from
+    (
+      select
+        s.table_name,
+        s.index_name,
+        group_concat(s.column_name) columns
+      from 
+        information_schema.statistics s
+      left join information_schema.table_constraints tc
+      on
+        s.table_schema = tc.table_schema
+      and s.table_name = tc.table_name
+      and s.index_name = tc.constraint_name
+      where
+        s.table_schema = database()
+      and s.table_name = p_table
+      and tc.constraint_type is null
+      group by
+        s.table_name, s.index_name
+    ) a
+  where
+    a.columns = p_columns;
+
+  return v_count;
+end;
+$$
+
+create function funcAppForeignKeyExists(p_table text, p_columns text, p_reftable text, p_refcolumns text)
+returns int
+begin
+  declare v_count int;
+  
+  select
+    count(*) into v_count
+  from
+    (
+      select
+        k.table_name ,
+        k.referenced_table_name ,
+        group_concat(k.column_name) columns,
+        group_concat(k.referenced_column_name) referenced_columns
+      from
+        information_schema.referential_constraints r
+      join information_schema.key_column_usage k
+      on
+        r.constraint_schema = k.constraint_schema
+        and r.table_name = k.table_name
+        and r.constraint_name = k.constraint_name
+      where
+        k.constraint_schema = database()
+        and k.table_name = p_table
+        and k.referenced_table_name = p_reftable
+    ) a
+  where 
+    a.columns = p_columns
+  and a.referenced_columns = p_refcolumns;
+
+  return v_count;
+end;
+$$
+
+create procedure procAppUpgradeDB() 
+begin
+  drop table if exists `temp_app_upgrade_log`;
+  create temporary table `temp_app_upgrade_log` (
+    `timestamp` timestamp(6) NOT NULL DEFAULT CURRENT_TIMESTAMP(6) ON UPDATE CURRENT_TIMESTAMP(6),
+    `message` varchar(2048)
+  );
+
+  -- $body
+
+  select * from `temp_app_upgrade_log`;
+  drop table `temp_app_upgrade_log`;
+end;
+$$
+
+DELIMITER ;
+
+
+call procAppUpgradeDB();

package/dist/resources/mariadb/sql-create-table-fk.njk

@@ -0,0 +1,10 @@
+{% if table.foreignKeys.length > 0 %}
+-- Foreign keys for table '{{ table.name }}'
+{% for foreignKey in table.foreignKeys %}
+ALTER TABLE `{{ table.name }}`
+  ADD CONSTRAINT {{ foreignKey.name }}
+  FOREIGN KEY ({{ foreignKey.columns.replace(r/,\s*/g, ', ') }})
+  REFERENCES {{ foreignKey.refTable }}({{ foreignKey.refColumns.replace(r/\s*/g, '').replaceAll(',', ', ') }}){{ " " + foreignKey.options if foreignKey.options }};
+{% endfor %}
+
+{% endif %}

package/dist/resources/mariadb/sql-create-table.njk

@@ -0,0 +1,12 @@
+-- Create table '{{ table.name }}'
+CREATE TABLE{{ " IF NOT EXISTS" if ifNotExists }} `{{ table.name }}` (
+{% for column in table.columns %}
+  {{ "  " if loop.index == 1 else ", " }}`{{ column.name }}` {{ column.type }}{{ " NOT NULL" if not column.nullable }}{{ " DEFAULT " + column.default if column.default }}{{ " COMMENT " + (column | getComment | toSQL) if withComment and (column | getComment) }}
+{% endfor %}
+{% if table.primaryKey %}
+  , PRIMARY KEY ({{ table.primaryKey.columns }})
+{% endif %}
+{% for index in table.indexes %}
+  , {{ "UNIQUE " if index.unique }}KEY `{{ index.name }}` ({{ index.columns }})
+{% endfor %}
+){{ " ENGINE=" + table.engine if table.engine }}{{ " AUTO_INCREMENT=" + table.autoIncrement if table.autoIncrement and table.autoIncrement !== 1 }}{{ " DEFAULT CHARSET=" + table.characterSet if table.characterSet }}{{ " COMMENT=" + (table.comment | toSQL) if withComment and table.comment }};

package/dist/resources/mariadb/sql-create-tables.njk

@@ -0,0 +1,9 @@
+{% for table in tables %}
+{% include "sql-create-table.njk" %}
+
+
+{% endfor %}
+
+{% for table in tables %}
+{% include "sql-create-table-fk.njk" %}
+{% endfor %}

package/dist/resources/mariadb/sql-drop-tables.njk

@@ -0,0 +1,10 @@
+-- Disable foreign key check
+SET foreign_key_checks = 0;
+
+{% for table in tables %}
+-- Drop table '{{ table.name }}'
+DROP TABLE IF EXISTS `{{ table.name }}`;
+
+{% endfor %}
+-- Enable foreign key check
+SET foreign_key_checks = 1;

package/dist/resources/mariadb/sql-drop-then-create-tables.njk

@@ -0,0 +1,4 @@
+{% include "sql-drop-tables.njk" %}
+
+
+{% include "sql-create-tables.njk" %}

package/dist/resources/mariadb/sql-upgrade-new-table.njk

@@ -0,0 +1,15 @@
+  -- Create table '{{ table.name }}'
+  if funcAppTableExists('{{ table.name }}') = 0 then
+    insert into temp_app_upgrade_log(message) values ('create table: {{ table.name }}');
+    CREATE TABLE `{{ table.name }}` (
+    {% for column in table.columns %}
+      {{ "  " if loop.index == 1 else ", " }}`{{ column.name }}` {{ column.type }}{{ " NOT NULL" if not column.nullable }}{{ " DEFAULT " + column.default if column.default }}{{ " COMMENT " + (column | getComment | toSQL) if withComment and (column | getComment) }}
+    {% endfor %}
+    {% if table.primaryKey %}
+      , PRIMARY KEY ({{ table.primaryKey.columns }})
+    {% endif %}
+    {% for index in table.indexes %}
+      , {{ "UNIQUE " if index.unique }}KEY `{{ index.name }}` ({{ index.columns }})
+    {% endfor %}
+    ){{ " ENGINE=" + table.engine if table.engine }}{{ " AUTO_INCREMENT=" + table.autoIncrement if table.autoIncrement and table.autoIncrement !== 1 }}{{ " DEFAULT CHARSET=" + table.characterSet if table.characterSet }}{{ " COMMENT=" + (table.comment | toSQL) if withComment and table.comment }};
+  end if;

package/dist/resources/mariadb/sql-upgrade-table-fk.njk

@@ -0,0 +1,10 @@
+{% if table.foreignKeys.length > 0 -%}
+{# new foreignKeys #}
+  -- Update table foreign keys '{{ table.name }}'
+{% for foreignKey in table.foreignKeys %}
+  if funcAppForeignKeyExists('{{ table.name }}', '{{ foreignKey.columns }}', '{{ foreignKey.refTable }}', '{{ foreignKey.refColumns }}') = 0 then
+    insert into temp_app_upgrade_log(message) values ('create table foreingn key: {{ table.name }}:{{ foreignKey.columns }}');
+    ALTER TABLE {{ table.name }} ADD CONSTRAINT `{{ foreignKey.name }}` FOREIGN KEY ({{ foreignKey.columns }}) REFERENCES {{ foreignKey.refTable }}({{ foreignKey.refColumns }});
+  end if;
+{% endfor %}
+{%- endif -%}

package/dist/resources/mariadb/sql-upgrade-table.njk

@@ -0,0 +1,41 @@
+
+  -- Update table '{{ table.name }}'
+{# new columns -#}
+{% for column in table.newColumns %}
+  if funcAppColumnExists('{{ table.name }}', '{{ column.name }}') = 0 then
+    insert into temp_app_upgrade_log(message) values ('create table column: {{ table.name }}.{{ column.name }}');
+    ALTER TABLE {{ table.name }} ADD `{{ column.name }}` {{ column.type }}{{ " NOT NULL" if not column.nullable }}{{ " DEFAULT " + column.default if column.default }}{{ " COMMENT " + (column | getComment | toSQL) if withComment and (column | getComment) }}
+    {%- if column.afterColumn -%}
+    {{ " AFTER " + "`" + column.afterColumn + "`" }}
+    {%- else -%};
+    {{ " FIRST" }}
+    {%- endif %};
+  end if;
+{% endfor -%}
+{# new primary keys -#}
+{% if table.newPrimaryKeys %}
+  if funcAppPrimaryKeyExists('{{ table.name }}', '{{ table.newPrimaryKeys.columns }}') = 0 then
+    insert into temp_app_upgrade_log(message) values ('create table primary key: {{ table.name }}:{{ table.newPrimaryKeys.columns }}');
+    ALTER TABLE {{ table.name }} ADD CONSTRAINT PRIMARY KEY ({{ table.newPrimaryKeys.columns }});
+  end if;
+{% endif %}
+{# new indexes -#}
+{% for index in table.newIndexes %}
+{{ ("index: " + index.columns) | log }}
+{%- if index.unique %}
+  if funcAppIndexExists('{{ table.name }}', '{{ index.columns }}') = 0 then
+    insert into temp_app_upgrade_log(message) values ('create table index: {{ table.name }}:{{ index.columns }}');
+    CREATE UNIQUE INDEX `{{ index.name }}` USING BTREE ON {{ table.name }} ({{ index.columns }});
+  end if;
+{% elif index.type === "FULLTEXT" %}
+  if funcAppIndexExists('{{ table.name }}', '{{ index.columns }}') = 0 then
+    insert into temp_app_upgrade_log(message) values ('create table index: {{ table.name }}:{{ index.columns }}');
+    CREATE FULLTEXT INDEX `{{ index.name }}` USING BTREE ON {{ table.name }} ({{ index.columns }});
+  end if;
+{% else %}
+  if funcAppIndexExists('{{ table.name }}', '{{ index.columns }}') = 0 then
+    insert into temp_app_upgrade_log(message) values ('create table index: {{ table.name }}:{{ index.columns }}');
+    CREATE INDEX `{{ index.name }}` USING BTREE ON {{ table.name }} ({{ index.columns }});
+  end if;
+{% endif %}
+{% endfor %}

package/dist/resources/mariadb/sql-upgrade-tables.njk

@@ -0,0 +1,19 @@
+{#- for new tables #}
+{% for table in newTables %}
+{% include "sql-upgrade-new-table.njk" %}
+{% endfor %}
+
+{#- for changes in existing tables #}
+{% for table in diffTables %}
+{% include "sql-upgrade-table.njk" %}
+{% endfor %}
+
+{#- for new tables.foreignKeys #}
+{% for table in newTables %}
+{% include "sql-upgrade-table-fk.njk" %}
+{% endfor %}
+
+{#- for new foreignKeys #}
+{% for table in diffTables %}
+{% include "sql-upgrade-table-fk.njk" %}
+{% endfor %}

package/dist/services/dbOptions.d.ts

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