oak-db 3.2.0 → 3.3.0

package/lib/MySQL/translator.d.ts

@@ -1,108 +1,107 @@
-import { EntityDict, Q_FullTextValue, RefOrExpression, Ref, StorageSchema } from "oak-domain/lib/types";
-import { EntityDict as BaseEntityDict } from 'oak-domain/lib/base-app-domain';
-import { DataType } from "oak-domain/lib/types/schema/DataTypes";
-import { SqlOperateOption, SqlSelectOption, SqlTranslator } from "../sqlTranslator";
-export interface MySqlSelectOption extends SqlSelectOption {
-}
-export interface MysqlOperateOption extends SqlOperateOption {
-}
-export declare class MySqlTranslator<ED extends EntityDict & BaseEntityDict> extends SqlTranslator<ED> {
-    protected getDefaultSelectFilter(alias: string, option?: MySqlSelectOption): string;
-    private makeUpSchema;
-    constructor(schema: StorageSchema<ED>);
-    static supportedDataTypes: DataType[];
-    static spatialTypes: DataType[];
-    static withLengthDataTypes: DataType[];
-    static withPrecisionDataTypes: DataType[];
-    static withScaleDataTypes: DataType[];
-    static unsignedAndZerofillTypes: DataType[];
-    static withWidthDataTypes: DataType[];
-    static dataTypeDefaults: {
-        varchar: {
-            length: number;
-        };
-        nvarchar: {
-            length: number;
-        };
-        "national varchar": {
-            length: number;
-        };
-        char: {
-            length: number;
-        };
-        binary: {
-            length: number;
-        };
-        varbinary: {
-            length: number;
-        };
-        decimal: {
-            precision: number;
-            scale: number;
-        };
-        dec: {
-            precision: number;
-            scale: number;
-        };
-        numeric: {
-            precision: number;
-            scale: number;
-        };
-        fixed: {
-            precision: number;
-            scale: number;
-        };
-        float: {
-            precision: number;
-        };
-        double: {
-            precision: number;
-        };
-        time: {
-            precision: number;
-        };
-        datetime: {
-            precision: number;
-        };
-        timestamp: {
-            precision: number;
-        };
-        bit: {
-            width: number;
-        };
-        int: {
-            width: number;
-        };
-        integer: {
-            width: number;
-        };
-        tinyint: {
-            width: number;
-        };
-        smallint: {
-            width: number;
-        };
-        mediumint: {
-            width: number;
-        };
-        bigint: {
-            width: number;
-        };
-    };
-    maxAliasLength: number;
-    private populateDataTypeDef;
-    protected translateAttrProjection(dataType: DataType, alias: string, attr: string): string;
-    protected translateObjectPredicate(predicate: Record<string, any>, alias: string, attr: string): string;
-    protected translateObjectProjection(projection: Record<string, any>, alias: string, attr: string, prefix: string): string;
-    protected translateAttrValue(dataType: DataType | Ref, value: any): string;
-    protected translateFullTextSearch<T extends keyof ED>(value: Q_FullTextValue, entity: T, alias: string): string;
-    translateCreateEntity<T extends keyof ED>(entity: T, options?: {
-        replace?: boolean;
-    }): string[];
-    private translateFnName;
-    private translateAttrInExpression;
-    protected translateExpression<T extends keyof ED>(entity: T, alias: string, expression: RefOrExpression<keyof ED[T]["OpSchema"]>, refDict: Record<string, [string, keyof ED]>): string;
-    protected populateSelectStmt<T extends keyof ED>(projectionText: string, fromText: string, aliasDict: Record<string, string>, filterText: string, sorterText?: string, groupByText?: string, indexFrom?: number, count?: number, option?: MySqlSelectOption): string;
-    protected populateUpdateStmt(updateText: string, fromText: string, aliasDict: Record<string, string>, filterText: string, sorterText?: string, indexFrom?: number, count?: number, option?: MysqlOperateOption): string;
-    protected populateRemoveStmt(updateText: string, fromText: string, aliasDict: Record<string, string>, filterText: string, sorterText?: string, indexFrom?: number, count?: number, option?: MysqlOperateOption): string;
-}
+import { EntityDict, Q_FullTextValue, RefOrExpression, Ref, StorageSchema } from "oak-domain/lib/types";
+import { EntityDict as BaseEntityDict } from 'oak-domain/lib/base-app-domain';
+import { DataType } from "oak-domain/lib/types/schema/DataTypes";
+import { SqlOperateOption, SqlSelectOption, SqlTranslator } from "../sqlTranslator";
+import { CreateEntityOption } from '../types/Translator';
+export interface MySqlSelectOption extends SqlSelectOption {
+}
+export interface MysqlOperateOption extends SqlOperateOption {
+}
+export declare class MySqlTranslator<ED extends EntityDict & BaseEntityDict> extends SqlTranslator<ED> {
+    protected getDefaultSelectFilter(alias: string, option?: MySqlSelectOption): string;
+    private makeUpSchema;
+    constructor(schema: StorageSchema<ED>);
+    static supportedDataTypes: DataType[];
+    static spatialTypes: DataType[];
+    static withLengthDataTypes: DataType[];
+    static withPrecisionDataTypes: DataType[];
+    static withScaleDataTypes: DataType[];
+    static unsignedAndZerofillTypes: DataType[];
+    static withWidthDataTypes: DataType[];
+    static dataTypeDefaults: {
+        varchar: {
+            length: number;
+        };
+        nvarchar: {
+            length: number;
+        };
+        "national varchar": {
+            length: number;
+        };
+        char: {
+            length: number;
+        };
+        binary: {
+            length: number;
+        };
+        varbinary: {
+            length: number;
+        };
+        decimal: {
+            precision: number;
+            scale: number;
+        };
+        dec: {
+            precision: number;
+            scale: number;
+        };
+        numeric: {
+            precision: number;
+            scale: number;
+        };
+        fixed: {
+            precision: number;
+            scale: number;
+        };
+        float: {
+            precision: number;
+        };
+        double: {
+            precision: number;
+        };
+        time: {
+            precision: number;
+        };
+        datetime: {
+            precision: number;
+        };
+        timestamp: {
+            precision: number;
+        };
+        bit: {
+            width: number;
+        };
+        int: {
+            width: number;
+        };
+        integer: {
+            width: number;
+        };
+        tinyint: {
+            width: number;
+        };
+        smallint: {
+            width: number;
+        };
+        mediumint: {
+            width: number;
+        };
+        bigint: {
+            width: number;
+        };
+    };
+    maxAliasLength: number;
+    private populateDataTypeDef;
+    protected translateAttrProjection(dataType: DataType, alias: string, attr: string): string;
+    protected translateObjectPredicate(predicate: Record<string, any>, alias: string, attr: string): string;
+    protected translateObjectProjection(projection: Record<string, any>, alias: string, attr: string, prefix: string): string;
+    protected translateAttrValue(dataType: DataType | Ref, value: any): string;
+    protected translateFullTextSearch<T extends keyof ED>(value: Q_FullTextValue, entity: T, alias: string): string;
+    translateCreateEntity<T extends keyof ED>(entity: T, options?: CreateEntityOption): string[];
+    private translateFnName;
+    private translateAttrInExpression;
+    protected translateExpression<T extends keyof ED>(entity: T, alias: string, expression: RefOrExpression<keyof ED[T]["OpSchema"]>, refDict: Record<string, [string, keyof ED]>): string;
+    protected populateSelectStmt<T extends keyof ED>(projectionText: string, fromText: string, aliasDict: Record<string, string>, filterText: string, sorterText?: string, groupByText?: string, indexFrom?: number, count?: number, option?: MySqlSelectOption): string;
+    protected populateUpdateStmt(updateText: string, fromText: string, aliasDict: Record<string, string>, filterText: string, sorterText?: string, indexFrom?: number, count?: number, option?: MysqlOperateOption): string;
+    protected populateRemoveStmt(updateText: string, fromText: string, aliasDict: Record<string, string>, filterText: string, sorterText?: string, indexFrom?: number, count?: number, option?: MysqlOperateOption): string;
+}

package/lib/MySQL/translator.js

@@ -527,14 +527,17 @@ class MySqlTranslator extends sqlTranslator_1.SqlTranslator {
         return ` match(${columns2.join(',')}) against ('${$search}' in natural language mode)`;
     }
     translateCreateEntity(entity, options) {
-        const replace = options?.replace;
+        const ifExists = options?.ifExists;
         const { schema } = this;
         const entityDef = schema[entity];
-        const { storageName, attributes, indexes, view } = entityDef;
+        const { storageName, attributes, indexes, view, static: _static } = entityDef;
         let hasSequence = false;
         // todo view暂还不支持
         const entityType = view ? 'view' : 'table';
         let sql = `create ${entityType} `;
+        if (ifExists === 'omit' || (_static && ifExists === 'dropIfNotStatic')) {
+            sql += ' if not exists';
+        }
         if (storageName) {
             sql += `\`${storageName}\` `;
         }
@@ -629,10 +632,10 @@ class MySqlTranslator extends sqlTranslator_1.SqlTranslator {
         if (typeof hasSequence === 'number') {
             sql += `auto_increment = ${hasSequence}`;
         }
-        if (!replace) {
-            return [sql];
+        if (ifExists === 'drop' || (!_static && ifExists === 'dropIfNotStatic')) {
+            return [`drop ${entityType}  if exists \`${storageName || entity}\`;`, sql];
         }
-        return [`drop ${entityType}  if exists \`${storageName || entity}\`;`, sql];
+        return [sql];
     }
     translateFnName(fnName, argumentNumber) {
         switch (fnName) {

package/lib/MySQL/types/Configuration.d.ts

@@ -1,11 +1,12 @@
-export type MySQLConfiguration = {
-    host: string;
-    user: string;
-    password: string;
-    database: string;
-    charset: 'utf8mb4_general_ci';
-    connectionLimit: number;
-};
-export type Configuration = {
-    mysql: MySQLConfiguration;
-};
+export type MySQLConfiguration = {
+    host: string;
+    user: string;
+    password: string;
+    database: string;
+    charset: 'utf8mb4_general_ci';
+    connectionLimit: number;
+    port?: number;
+};
+export type Configuration = {
+    mysql: MySQLConfiguration;
+};

package/lib/sqlTranslator.d.ts

@@ -1,56 +1,55 @@
-import { EntityDict, OperateOption, Q_FullTextValue, Ref, RefOrExpression, SelectOption, StorageSchema } from "oak-domain/lib/types";
-import { EntityDict as BaseEntityDict } from 'oak-domain/lib/base-app-domain';
-import { DataType } from "oak-domain/lib/types/schema/DataTypes";
-export interface SqlSelectOption extends SelectOption {
-}
-export interface SqlOperateOption extends OperateOption {
-}
-export declare abstract class SqlTranslator<ED extends EntityDict & BaseEntityDict> {
-    readonly schema: StorageSchema<ED>;
-    constructor(schema: StorageSchema<ED>);
-    private makeFullSchema;
-    protected abstract getDefaultSelectFilter<OP extends SqlSelectOption>(alias: string, option?: OP): string;
-    protected abstract translateAttrProjection(dataType: DataType, alias: string, attr: string): string;
-    protected abstract translateObjectProjection(projection: Record<string, any>, alias: string, attr: string, prefix: string): string;
-    protected abstract translateAttrValue(dataType: DataType | Ref, value: any): string;
-    protected abstract translateFullTextSearch<T extends keyof ED>(value: Q_FullTextValue, entity: T, alias: string): string;
-    abstract translateCreateEntity<T extends keyof ED>(entity: T, option: {
-        replace?: boolean;
-    }): string[];
-    protected abstract translateObjectPredicate(predicate: Record<string, any>, alias: string, attr: string): string;
-    protected abstract populateSelectStmt<T extends keyof ED, OP extends SqlSelectOption>(projectionText: string, fromText: string, aliasDict: Record<string, string>, filterText: string, sorterText?: string, groupByText?: string, indexFrom?: number, count?: number, option?: OP, selection?: ED[T]['Selection'], aggregation?: ED[T]['Aggregation']): string;
-    protected abstract populateUpdateStmt<OP extends SqlOperateOption>(updateText: string, fromText: string, aliasDict: Record<string, string>, filterText: string, sorterText?: string, indexFrom?: number, count?: number, option?: OP): string;
-    protected abstract populateRemoveStmt<OP extends SqlOperateOption>(updateText: string, fromText: string, aliasDict: Record<string, string>, filterText: string, sorterText?: string, indexFrom?: number, count?: number, option?: OP): string;
-    protected abstract translateExpression<T extends keyof ED>(entity: T, alias: string, expression: RefOrExpression<keyof ED[T]['OpSchema']>, refDict: Record<string, [string, keyof ED]>): string;
-    private getStorageName;
-    translateInsert<T extends keyof ED>(entity: T, data: ED[T]['CreateMulti']['data']): string;
-    /**
-     * analyze the join relations in projection/query/sort
-     * 所有的层次关系都当成left join处理，如果有内表为空的情况，请手动处理
-     * {
-     *      b: {
-     *          name: {
-     *              $exists: false,
-     *          }
-*           }
-     * }
-     * 这样的query会把内表为空的行也返回
-     * @param param0
-     */
-    private analyzeJoin;
-    private translateComparison;
-    private translateEvaluation;
-    protected translatePredicate(predicate: string, value: any, type?: DataType | Ref): string;
-    private translateFilter;
-    private translateSorter;
-    private translateProjection;
-    private translateSelectInner;
-    translateSelect<T extends keyof ED, OP extends SqlSelectOption>(entity: T, selection: ED[T]['Selection'], option?: OP): string;
-    translateWhere<T extends keyof ED, OP extends SqlSelectOption>(entity: T, selection: ED[T]['Selection'], option?: OP): string;
-    translateAggregate<T extends keyof ED, OP extends SqlSelectOption>(entity: T, aggregation: ED[T]['Aggregation'], option?: OP): string;
-    translateCount<T extends keyof ED, OP extends SqlSelectOption>(entity: T, selection: Pick<ED[T]['Selection'], 'filter' | 'count'>, option?: OP): string;
-    translateRemove<T extends keyof ED, OP extends SqlOperateOption>(entity: T, operation: ED[T]['Remove'], option?: OP): string;
-    translateUpdate<T extends keyof ED, OP extends SqlOperateOption>(entity: T, operation: ED[T]['Update'], option?: OP): string;
-    translateDestroyEntity(entity: string, truncate?: boolean): string;
-    escapeStringValue(value: string): string;
-}
+import { EntityDict, OperateOption, Q_FullTextValue, Ref, RefOrExpression, SelectOption, StorageSchema } from "oak-domain/lib/types";
+import { EntityDict as BaseEntityDict } from 'oak-domain/lib/base-app-domain';
+import { DataType } from "oak-domain/lib/types/schema/DataTypes";
+import { CreateEntityOption } from './types/Translator';
+export interface SqlSelectOption extends SelectOption {
+}
+export interface SqlOperateOption extends OperateOption {
+}
+export declare abstract class SqlTranslator<ED extends EntityDict & BaseEntityDict> {
+    readonly schema: StorageSchema<ED>;
+    constructor(schema: StorageSchema<ED>);
+    private makeFullSchema;
+    protected abstract getDefaultSelectFilter<OP extends SqlSelectOption>(alias: string, option?: OP): string;
+    protected abstract translateAttrProjection(dataType: DataType, alias: string, attr: string): string;
+    protected abstract translateObjectProjection(projection: Record<string, any>, alias: string, attr: string, prefix: string): string;
+    protected abstract translateAttrValue(dataType: DataType | Ref, value: any): string;
+    protected abstract translateFullTextSearch<T extends keyof ED>(value: Q_FullTextValue, entity: T, alias: string): string;
+    abstract translateCreateEntity<T extends keyof ED>(entity: T, option: CreateEntityOption): string[];
+    protected abstract translateObjectPredicate(predicate: Record<string, any>, alias: string, attr: string): string;
+    protected abstract populateSelectStmt<T extends keyof ED, OP extends SqlSelectOption>(projectionText: string, fromText: string, aliasDict: Record<string, string>, filterText: string, sorterText?: string, groupByText?: string, indexFrom?: number, count?: number, option?: OP, selection?: ED[T]['Selection'], aggregation?: ED[T]['Aggregation']): string;
+    protected abstract populateUpdateStmt<OP extends SqlOperateOption>(updateText: string, fromText: string, aliasDict: Record<string, string>, filterText: string, sorterText?: string, indexFrom?: number, count?: number, option?: OP): string;
+    protected abstract populateRemoveStmt<OP extends SqlOperateOption>(updateText: string, fromText: string, aliasDict: Record<string, string>, filterText: string, sorterText?: string, indexFrom?: number, count?: number, option?: OP): string;
+    protected abstract translateExpression<T extends keyof ED>(entity: T, alias: string, expression: RefOrExpression<keyof ED[T]['OpSchema']>, refDict: Record<string, [string, keyof ED]>): string;
+    private getStorageName;
+    translateInsert<T extends keyof ED>(entity: T, data: ED[T]['CreateMulti']['data']): string;
+    /**
+     * analyze the join relations in projection/query/sort
+     * 所有的层次关系都当成left join处理，如果有内表为空的情况，请手动处理
+     * {
+     *      b: {
+     *          name: {
+     *              $exists: false,
+     *          }
+*           }
+     * }
+     * 这样的query会把内表为空的行也返回
+     * @param param0
+     */
+    private analyzeJoin;
+    private translateComparison;
+    private translateEvaluation;
+    protected translatePredicate(predicate: string, value: any, type?: DataType | Ref): string;
+    private translateFilter;
+    private translateSorter;
+    private translateProjection;
+    private translateSelectInner;
+    translateSelect<T extends keyof ED, OP extends SqlSelectOption>(entity: T, selection: ED[T]['Selection'], option?: OP): string;
+    translateWhere<T extends keyof ED, OP extends SqlSelectOption>(entity: T, selection: ED[T]['Selection'], option?: OP): string;
+    translateAggregate<T extends keyof ED, OP extends SqlSelectOption>(entity: T, aggregation: ED[T]['Aggregation'], option?: OP): string;
+    translateCount<T extends keyof ED, OP extends SqlSelectOption>(entity: T, selection: Pick<ED[T]['Selection'], 'filter' | 'count'>, option?: OP): string;
+    translateRemove<T extends keyof ED, OP extends SqlOperateOption>(entity: T, operation: ED[T]['Remove'], option?: OP): string;
+    translateUpdate<T extends keyof ED, OP extends SqlOperateOption>(entity: T, operation: ED[T]['Update'], option?: OP): string;
+    translateDestroyEntity(entity: string, truncate?: boolean): string;
+    escapeStringValue(value: string): string;
+}

package/lib/types/Translator.d.ts

@@ -0,0 +1,3 @@
+export type CreateEntityOption = {
+    ifExists?: 'drop' | 'omit' | 'dropIfNotStatic';
+};

package/lib/types/Translator.js

@@ -1 +1,2 @@
-"use strict";
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "oak-db",
-	"version": "3.2.0",
+	"version": "3.3.0",
 	"description": "oak-db",
 	"main": "lib/index",
 	"author": {
@@ -18,7 +18,7 @@
 		"lodash": "^4.17.21",
 		"mysql": "^2.18.1",
 		"mysql2": "^2.3.3",
-		"oak-domain": "^4.3.0",
+		"oak-domain": "^5.0.0",
 		"uuid": "^8.3.2"
 	},
 	"license": "ISC",
@@ -31,7 +31,7 @@
 		"@types/uuid": "^8.3.4",
 		"cross-env": "^7.0.3",
 		"mocha": "^10.2.0",
-		"oak-general-business": "^4.3.0",
+		"oak-general-business": "^5.0.0",
 		"ts-node": "^10.9.1",
 		"tslib": "^2.4.0",
 		"typescript": "^5.2.2"