baja-lite 1.4.5 → 1.4.7

package/sql.d.ts

@@ -20,6 +20,7 @@ declare const _inTransaction: unique symbol;
 declare const _daoDB: unique symbol;
 declare const _sqliteRemoteName: unique symbol;
 declare const _SqlOption: unique symbol;
+export declare const _dataConvert: unique symbol;
 export declare const _enum: unique symbol;
 export declare const _GlobalSqlOption: unique symbol;
 export declare const _EventBus: unique symbol;
@@ -40,27 +41,27 @@ export declare enum SyncMode {
 }
 export declare enum InsertMode {
     /**
-    # 默认使用
-    ** 支持单个、批量,语法 `INSERT INTO XX VALUES (第一条数据), (第二条数据);`
-    ** 批量执行有性能优势，但无法利用数据库的sql预编译功能
-    */
+     # 默认使用
+     ** 支持单个、批量,语法 `INSERT INTO XX VALUES (第一条数据), (第二条数据);`
+     ** 批量执行有性能优势，但无法利用数据库的sql预编译功能
+     */
     Insert = 0,
     /**
-    # 利用临时表
-    ## 执行步骤
-    1. 建立临时表(从正式表复制)
-    2. 数据全部进入临时表
-    3. 临时表数据转移到正式表: `INSERT INTO 正式表 SELECT * FROM 临时表`
-    4. 删除临时表
-    ## 注意
-    1. 适用于：主键不会冲突、非自增
-    2. 临时表的结构复制正式表
+     # 利用临时表
+     ## 执行步骤
+     1. 建立临时表(从正式表复制)
+     2. 数据全部进入临时表
+     3. 临时表数据转移到正式表: `INSERT INTO 正式表 SELECT * FROM 临时表`
+     4. 删除临时表
+     ## 注意
+     1. 适用于：主键不会冲突、非自增
+     2. 临时表的结构复制正式表
      */
     InsertWithTempTable = 1,
     InsertIfNotExists = 2,
     /**
-    # 插入或者更新
-    1. 判断依据是主键
+     # 插入或者更新
+     1. 判断依据是主键
      */
     Replace = 3
 }
@@ -71,7 +72,7 @@ export declare enum DeleteMode {
      `DELETE FROM WHERE (id = 1) OR (id = 2)`
      ### 例二
      `DELETE FROM WHERE (id = 1 AND idx = 11) OR (id = 2 AND idx = 22)`
-    */
+     */
     Common = 0,
     TempTable = 1
 }
@@ -82,7 +83,7 @@ export declare enum SelectMode {
      `SELECT * FROM WHERE (id = 1) OR (id = 2)`
      ### 例二
      `SELECT * FROM WHERE (id = 1 AND idx = 11) OR (id = 2 AND idx = 22)`
-    */
+     */
     Common = 0,
     TempTable = 1
 }
@@ -173,12 +174,12 @@ interface ServiceOption {
  # 全局行为配置文件
  ### `sqlDir?: string;` 数据库查询语句存放目录.存放格式为 export.default 的js、ts， 存放内容满足格式：
 
-    ```
-    interface SqlModel {
-        [key: string]: string | ((params: { [k: string]: any }, context: any, isCount?: boolean) => string)
-    }
-    ```
-    可以继承该接口来约束格式
+ ```
+ interface SqlModel {
+ [key: string]: string | ((params: { [k: string]: any }, context: any, isCount?: boolean) => string)
+ }
+ ```
+ 可以继承该接口来约束格式
  */
 export interface GlobalSqlOptionForWeb {
     /** 增改忽略Undefined */
@@ -192,18 +193,18 @@ export interface GlobalSqlOptionForWeb {
     SqliteRemote?: {
         /**
          ## 单一数据源
-        ```
-        db: 'd:/1.db'
-        ```
-        ## 多数据源：传入多个连接配置
-        ```
-        db: {
-                db1: 'd:/1.db',
-                db2: 'd:/2.db'
-        }
-        ```
-        不支持 `SqliteMemory`
-        */
+         ```
+         db: 'd:/1.db'
+         ```
+         ## 多数据源：传入多个连接配置
+         ```
+         db: {
+         db1: 'd:/1.db',
+         db2: 'd:/2.db'
+         }
+         ```
+         不支持 `SqliteMemory`
+         */
         db?: Record<string, string> | string;
         /** 远程SQLITE接口实现，适用于Electron, 采用Ipc 的handel机制实现 */
         service: SqliteRemoteInterface;
@@ -221,11 +222,11 @@ export interface GlobalSqlOptionForWeb {
      */
     sqlFNMap?: Record<string, string>;
     /**
-    // 第一个元素=列名，第二个元素是属性路径，
-    [
-        ['dit_id', ['id']], // 列名ditid,对应属性id
-        ['event_id', ['eventMainInfo', 'id']] // 列名event_id对应属性eventMainInfo.id
-    ]
+     // 第一个元素=列名，第二个元素是属性路径，
+     [
+     ['dit_id', ['id']], // 列名ditid,对应属性id
+     ['event_id', ['eventMainInfo', 'id']] // 列名event_id对应属性eventMainInfo.id
+     ]
      */
     sqlMapperMap?: SqlMappers;
     /** 提供的枚举MAP */
@@ -235,115 +236,126 @@ export interface GlobalSqlOptionForWeb {
      * 当设置为columnMode.HUMP时，切记将代码生成器中属性名称改对
      * # 自定义sql查询时，无法自动转换哦,可使用标签转换：
      *```
-        SELECT
+     SELECT
      *  {{#hump}} seller_sku2, seller_sku {{/hump}}
      * ```
      * 转换为
      *```
-        SELECT
+     SELECT
      *  {{#hump}} seller_sku2 sellerSku2, seller_sku sellerSku {{/hump}}
      * ```
      */
     columnMode?: ColumnMode;
     /** 对于WEB模式，默认为SqliteRemote */
     dbType?: DBType;
+    /**
+     * * 数据转换器，用于service的select、page方法，以及stream查询
+     * * 例如
+     * ```
+     * dataConvert: {
+     *      // 使用时，传入qiniu和列名，将根据列名对应的值生成URL
+     *      qiniu: data => qiniuConvertUrl(data)
+     * }
+     * ```
+     */
+    dataConvert?: Record<string, (data: any) => any>;
 }
 /**
  # 全局行为配置文件
-   MYSQL编码： 'utf8mb4', utf8mb4_general_ci'
+ MYSQL编码： 'utf8mb4', utf8mb4_general_ci'
  ### `sqlDir?: string;` 数据库查询语句存放目录.存放格式为 export.default 的js、ts， 存放内容满足格式：
- 
-    ```
-    interface SqlModel {
-        [key: string]: string | ((params: { [k: string]: any }, context: any, isCount?: boolean) => string)
-    }
-    ```
-    可以继承该接口来约束格式
+
+ ```
+ interface SqlModel {
+ [key: string]: string | ((params: { [k: string]: any }, context: any, isCount?: boolean) => string)
+ }
+ ```
+ 可以继承该接口来约束格式
  */
 export interface GlobalSqlOption extends GlobalSqlOptionForWeb {
     /**
-       初始化MYSQL链接 支持多数据源
-       ## 单一数据源: 直接传入Mysql2的连接配置
-       [MYSQL初始化文档](https://github.com/mysqljs/mysql#connection-options)
-       ```
-       Mysql: {
-          host: '127.0.0.1',
-          ...
-       }
-       ```
-       ## 多数据源：传入多个Mysql2的连接配置
-       ```
-       Mysql: {
-          db1: {
-              host: '127.0.0.1',
-              ...
-          },
-          db2: {
-              host: '127.0.0.1',
-              ...
-          },
-          ...
-       }
-       ```
-      */
+     初始化MYSQL链接 支持多数据源
+     ## 单一数据源: 直接传入Mysql2的连接配置
+     [MYSQL初始化文档](https://github.com/mysqljs/mysql#connection-options)
+     ```
+     Mysql: {
+     host: '127.0.0.1',
+     ...
+     }
+     ```
+     ## 多数据源：传入多个Mysql2的连接配置
+     ```
+     Mysql: {
+     db1: {
+     host: '127.0.0.1',
+     ...
+     },
+     db2: {
+     host: '127.0.0.1',
+     ...
+     },
+     ...
+     }
+     ```
+     */
     Mysql?: Record<string, Record<string, any>> | Record<string, any>;
     /**
-         初始化postgresql链接 支持多数据源
-         ## 单一数据源: 直接传入postgresql的连接配置
-         [Postgresql初始化文档](https://github.com/brianc/node-postgres/tree/master/packages/pg-pool)
-         ```
-         Postgresql: {
-            database: 'postgres',
-            user: 'brianc',
-            password: 'secret!',
-            port: 5432,
-            ssl: true,
-            max: 20, // set pool max size to 20
-            idleTimeoutMillis: 1000, // close idle clients after 1 second
-            connectionTimeoutMillis: 1000, // return an error after 1 second if connection could not be established
-            maxUses: 7500, // close (and replace) a connection after it has been used 7500 times (see below for discussion)
-            host?: string | undefined;
-            connectionString?: string | undefined;
-            keepAlive?: boolean | undefined;
-            stream?: () => stream.Duplex | stream.Duplex | undefined;
-            statement_timeout?: false | number | undefined;
-            query_timeout?: number | undefined;
-            keepAliveInitialDelayMillis?: number | undefined;
-            idle_in_transaction_session_timeout?: number | undefined;
-            application_name?: string | undefined;
-            types?: CustomTypesConfig | undefined;
-            options?: string | undefined;
-         }
-         ```
-         ## 多数据源：传入多个Postgresql的连接配置
-         ```
-         Postgresql: {
-            db1: {
-              database: 'postgres',
-              user: 'brianc',
-              password: 'secret!',
-              port: 5432,
-              ssl: true,
-              max: 20, // set pool max size to 20
-              idleTimeoutMillis: 1000, // close idle clients after 1 second
-              connectionTimeoutMillis: 1000, // return an error after 1 second if connection could not be established
-              maxUses: 7500, // close (and replace) a connection after it has been used 7500 times (see below for discussion)
-            },
-            db2: {
-              database: 'postgres',
-              user: 'brianc',
-              password: 'secret!',
-              port: 5432,
-              ssl: true,
-              max: 20, // set pool max size to 20
-              idleTimeoutMillis: 1000, // close idle clients after 1 second
-              connectionTimeoutMillis: 1000, // return an error after 1 second if connection could not be established
-              maxUses: 7500, // close (and replace) a connection after it has been used 7500 times (see below for discussion)
-            },
-            ...
-         }
-         ```
-        */
+     初始化postgresql链接 支持多数据源
+     ## 单一数据源: 直接传入postgresql的连接配置
+     [Postgresql初始化文档](https://github.com/brianc/node-postgres/tree/master/packages/pg-pool)
+     ```
+     Postgresql: {
+     database: 'postgres',
+     user: 'brianc',
+     password: 'secret!',
+     port: 5432,
+     ssl: true,
+     max: 20, // set pool max size to 20
+     idleTimeoutMillis: 1000, // close idle clients after 1 second
+     connectionTimeoutMillis: 1000, // return an error after 1 second if connection could not be established
+     maxUses: 7500, // close (and replace) a connection after it has been used 7500 times (see below for discussion)
+     host?: string | undefined;
+     connectionString?: string | undefined;
+     keepAlive?: boolean | undefined;
+     stream?: () => stream.Duplex | stream.Duplex | undefined;
+     statement_timeout?: false | number | undefined;
+     query_timeout?: number | undefined;
+     keepAliveInitialDelayMillis?: number | undefined;
+     idle_in_transaction_session_timeout?: number | undefined;
+     application_name?: string | undefined;
+     types?: CustomTypesConfig | undefined;
+     options?: string | undefined;
+     }
+     ```
+     ## 多数据源：传入多个Postgresql的连接配置
+     ```
+     Postgresql: {
+     db1: {
+     database: 'postgres',
+     user: 'brianc',
+     password: 'secret!',
+     port: 5432,
+     ssl: true,
+     max: 20, // set pool max size to 20
+     idleTimeoutMillis: 1000, // close idle clients after 1 second
+     connectionTimeoutMillis: 1000, // return an error after 1 second if connection could not be established
+     maxUses: 7500, // close (and replace) a connection after it has been used 7500 times (see below for discussion)
+     },
+     db2: {
+     database: 'postgres',
+     user: 'brianc',
+     password: 'secret!',
+     port: 5432,
+     ssl: true,
+     max: 20, // set pool max size to 20
+     idleTimeoutMillis: 1000, // close idle clients after 1 second
+     connectionTimeoutMillis: 1000, // return an error after 1 second if connection could not be established
+     maxUses: 7500, // close (and replace) a connection after it has been used 7500 times (see below for discussion)
+     },
+     ...
+     }
+     ```
+     */
     Postgresql?: Record<string, Record<string, any>> | Record<string, any>;
     /**
      ## 单一数据源
@@ -352,34 +364,34 @@ export interface GlobalSqlOption extends GlobalSqlOptionForWeb {
      ```
      ## 多数据源：传入多个连接配置
      ```
-       Sqlite: {
-            db1: 'd:/1.db',
-            db2: 'd:/2.db'
-       }
+     Sqlite: {
+     db1: 'd:/1.db',
+     db2: 'd:/2.db'
+     }
      ```
-       路径 = `SqliteMemory` 将创建内存库
+     路径 = `SqliteMemory` 将创建内存库
      */
     Sqlite?: Record<string, string> | string;
     /**
      ## 日志文件存放路径,该目录下文件名是模块名，例如有一个文件名为 `user.js`,内容为:
      ```
-       export default {
-            'sql_1': 'SELECT * FROM user WHERE username = :username',
-            'sql_2': (options: {
-                ctx?: any;
-                isCount?: boolean;
-                isSum?: boolean;
-                limitStart?: number;
-                limitEnd?: number;
-                sortName?: string; sortType?: string;
-                params?: Record<string, any>;
-            }) => {
-                return   `
-                    SELECT * FROM user u LEFT JOIN organ o ON u.orgid = o.orgid
-                    WHERE o.orgid = :orgid;
-                `;
-            }
-        } as SqlModel;
+     export default {
+     'sql_1': 'SELECT * FROM user WHERE username = :username',
+     'sql_2': (options: {
+     ctx?: any;
+     isCount?: boolean;
+     isSum?: boolean;
+     limitStart?: number;
+     limitEnd?: number;
+     sortName?: string; sortType?: string;
+     params?: Record<string, any>;
+     }) => {
+     return   `
+     SELECT * FROM user u LEFT JOIN organ o ON u.orgid = o.orgid
+     WHERE o.orgid = :orgid;
+     `;
+     }
+     } as SqlModel;
      ```
      ** 可以看到，sql语句支持直接映射一个sql语句，也可以通过函数返回,返回字符串支持[mustache](https://github.com/janl/mustache.js)
      ** 上面的文件中，将注册两个SQL：`user.sql_1` 和 `user.sql_2`.
@@ -390,51 +402,64 @@ export interface GlobalSqlOption extends GlobalSqlOptionForWeb {
      ### 注意
      1. 不要直接拼接参数：不安全且效率低
      2. sqlite不支持多语句拼接
-    ## 也支持.mu文件,格式略
-    */
+     ## 也支持.mu文件,格式略
+     */
     sqlDir?: string;
     /**
-    ## [mustache](https://mustache.github.io/) 编译时的[模板](https://github.com/janl/mustache.js#:~:text=requires%20only%20this%3A-,%7B%7B%3E%20next_more%7D%7D,-Why%3F%20Because%20the)
-      ## 文件名就是模板名
+     ## [mustache](https://mustache.github.io/) 编译时的[模板](https://github.com/janl/mustache.js#:~:text=requires%20only%20this%3A-,%7B%7B%3E%20next_more%7D%7D,-Why%3F%20Because%20the)
+     ## 文件名就是模板名
      */
     sqlFNDir?: string;
     /**
-      ## 映射数据为对象，文件名就是模板名
-    ```
-    // 第一个元素=列名，第二个元素是属性路径，
-    // 该目录下可存放json文件，内容如下
-    //
-    // 可以在查询时使用，优先级高于hump
-    // 例如:
-    [
-        ['dit_id', ['id'], 可选的默认值], // 列名ditid,对应属性id,当未查询返回时，使用默认值
-        ['event_id', ['eventMainInfo', 'id']] // 列名event_id对应属性eventMainInfo.id,当未查询返回时，该属性不存在
-    ]
-    ```
+     *  #TODO 未完成读取 sqlMapDir
+     *  # sqlMapDir 目录定义如下，
+     *      `test.ts`
+     *      ```
+     *         export const dict:SqlMappers = [
+     *             {columnName: 'dit_id', mapNames: ['DTID'], def: 0, convert: 转换函数},  // 列名ditid,对应属性DTID,如果没有值，将返回默认值0,其中默认值0是可选的
+     *             {columnName: 'event_id', mapNames: ['eventMainInfo', 'id'], def: 0,  convert: 转换函数},// 列名event_id对应属性eventMainInfo.id,这种方式将返回嵌套的json对象,其中默认值null是可选的
+     *         ]
+     *      ```
+     *      将得到 test.dict 这个map
+     */
+    sqlMapDir?: string;
+    /**
+     ## 映射数据为对象，文件名就是模板名
+     ```
+     // 第一个元素=列名，第二个元素是属性路径，
+     // 该目录下可存放json文件，内容如下
+     //
+     // 可以在查询时使用，优先级高于hump
+     // 例如:
+     [
+     ['dit_id', ['id'], 可选的默认值], // 列名ditid,对应属性id,当未查询返回时，使用默认值
+     ['event_id', ['eventMainInfo', 'id']] // 列名event_id对应属性eventMainInfo.id,当未查询返回时，该属性不存在
+     ]
+     ```
      */
     sqlMapperDir?: string;
     /**
      [REDIS初始化文档](https://github.com/redis/ioredis?tab=readme-ov-file#:~:text=connect%20to%20by%3A-,new%20Redis()%3B,-//%20Connect%20to%20127.0.0.1)
-    ```
-    Redis: {
-        host: '127.0.0.1',
-        ...
-    }
-    ```
-    ## 多数据源：传入多个Redis的连接配置
-    ```
-    Redis: {
-        db1: {
-            host: '127.0.0.1',
-            ...
-        },
-        db2: {
-            host: '127.0.0.1',
-            ...
-        },
-        ...
-    }
-    ```
+     ```
+     Redis: {
+     host: '127.0.0.1',
+     ...
+     }
+     ```
+     ## 多数据源：传入多个Redis的连接配置
+     ```
+     Redis: {
+     db1: {
+     host: '127.0.0.1',
+     ...
+     },
+     db2: {
+     host: '127.0.0.1',
+     ...
+     },
+     ...
+     }
+     ```
      */
     Redis?: Record<string, Record<string, any>> | Record<string, any>;
     /** sqlite数据库驱动初始化函数 */
@@ -596,7 +621,12 @@ export declare class SqliteRemote implements Dao {
     restore(sync: SyncMode.Sync, importPath: string): void;
     restore(sync: SyncMode.Async, importPath: string): Promise<void>;
 }
-export type SqlMapper = ([string, string[], any?])[];
+export type SqlMapper = {
+    columnName: string;
+    mapNames: string[];
+    def?: any;
+    convert?: (data: any) => any;
+}[];
 export type SqlMappers = Record<string, SqlMapper>;
 export type SqlModel = Record<string, string | ((options: {
     ctx?: any;
@@ -633,14 +663,15 @@ export declare class SqlCache {
     /**
      *
      * ```
-    // 第一个元素=列名，第二个元素是属性路径，
-    [
-        ['dit_id', ['id']], // 列名ditid,对应属性id
-        ['event_id', ['eventMainInfo', 'id']] // 列名event_id对应属性eventMainInfo.id
-    ]
+     // 第一个元素=列名，第二个元素是属性路径，
+     [
+     ['dit_id', ['id']], // 列名ditid,对应属性id
+     ['event_id', ['eventMainInfo', 'id']] // 列名event_id对应属性eventMainInfo.id
+     ]
      * ```
-     * @param am
+     * @param ams
      * @param keys
+     * @param key
      */
     private readResultMap;
     init(options: {
@@ -703,40 +734,40 @@ export declare const DB: (config: ServiceOption) => <C extends {
     };
 } & C;
 /**
-  js项目中实体类注解替代品，只要确保函数被执行即可,举例：
-  ```
-  // 声明一个class
-    export class AmaFuck {}
-    DeclareClass(AmaFuck, [
-        { type: "String", name: "SellerSKU" },
-        { type: "String", name: "SellerSKU2" },
-        { type: "String", name: "site" }
-    ]);
-  ```
+ js项目中实体类注解替代品，只要确保函数被执行即可,举例：
+ ```
+ // 声明一个class
+ export class AmaFuck {}
+ DeclareClass(AmaFuck, [
+ { type: "String", name: "SellerSKU" },
+ { type: "String", name: "SellerSKU2" },
+ { type: "String", name: "site" }
+ ]);
+ ```
  */
 export declare function DeclareClass(clz: any, FieldOptions: FieldOption[]): void;
 /**
  JS项目中，service注解代替,举例：
  ```
  // 声明一个service,注意这里的let
-    export let AmaService = class AmaService extends SqlService {};
-    AmaService = DeclareService(AmaService, {
-        tableName: "ama_fuck2",
-        clz: AmaFuck,
-        dbType: DBType.Sqlite,
-        sqliteVersion: "0.0.3"
-    });
+ export let AmaService = class AmaService extends SqlService {};
+ AmaService = DeclareService(AmaService, {
+ tableName: "ama_fuck2",
+ clz: AmaFuck,
+ dbType: DBType.Sqlite,
+ sqliteVersion: "0.0.3"
+ });
  ```
  */
 export declare function DeclareService(clz: any, config: ServiceOption): any;
 /**
  ## 数据库服务
  ### 注解DB
- 
+
  ### 泛型 T，同DB注解中的clz
  ** 服务中所有方法默认以该类型为准
  **
- 
+
  */
 export declare class SqlService<T extends object> {
     [_tableName]?: string;
@@ -767,32 +798,30 @@ export declare class SqlService<T extends object> {
     }) => Partial<T>;
     private _insert;
     /**
-    0. `sync`: 同步（sqlite）或者异步（mysql、remote），影响返回值类型,默认 `异步`
-    1. `data`：可是数组或者单对象
-    2. `skipUndefined`: boolean; 是否不处理值为undefined的字段,默认 true
-    3. `skipNull`: boolean; 是否不处理值为null的字段,默认 true
-    4. `skipEmptyString`: boolean; 是否不处理值为空字符串(`注意：多个空格也算空字符串`)的字段,默认 true
-    5. `maxDeal`: number; 批量处理时，每次处理多少个？默认500
-    6. `tableName`: 默认使用service注解的`tableName`,可以在某个方法中覆盖
-    7. `dbName`: 默认使用service注解的`dbName`,可以在某个方法中覆盖
-    8. `conn`: 仅在开启事务时需要主动传入,传入示例:
-        ```
-            service.transaction(async conn => {
-                service.insert({conn});
-            });
-        ```
-    9.  `dao`: 永远不需要传入该值
-    10. `mode` :默认`insert`，可选如下
-        1. `insert`: 默认
-        2. `insertIfNotExists`: 通过主键或者existConditionOtherThanIds字段判断数据是否存在，不存在才插入,存在则不执行
-        3. `replace`: 只支持用主键判断, 存在更新, 不存在插入
-    11. `existConditionOtherThanIds`: insertIfNotExists时判断同一记录的字段名称，默认情况下按照ID判断，设置existConditionOtherThanIds后，不用id
-    12. `replaceWithDef` replace时，是否带入默认值? 默认true
-    ### 返回值是最后一次插入的主键ID，对于自增ID表适用
-    1. 如果主键是自增批量操作，且期望返回所有记录的ID，那么需要设置 `option 中的 every = true`,此时效率降低
-     * @param {{[P in keyof T]?: T[P]}} data
-     * @param {MethodOption} [option]
-     * @memberof SqlServer
+     0. `sync`: 同步（sqlite）或者异步（mysql、remote），影响返回值类型,默认 `异步`
+     1. `data`：可是数组或者单对象
+     2. `skipUndefined`: boolean; 是否不处理值为undefined的字段,默认 true
+     3. `skipNull`: boolean; 是否不处理值为null的字段,默认 true
+     4. `skipEmptyString`: boolean; 是否不处理值为空字符串(`注意：多个空格也算空字符串`)的字段,默认 true
+     5. `maxDeal`: number; 批量处理时，每次处理多少个？默认500
+     6. `tableName`: 默认使用service注解的`tableName`,可以在某个方法中覆盖
+     7. `dbName`: 默认使用service注解的`dbName`,可以在某个方法中覆盖
+     8. `conn`: 仅在开启事务时需要主动传入,传入示例:
+     ```
+     service.transaction(async conn => {
+     service.insert({conn});
+     });
+     ```
+     9.  `dao`: 永远不需要传入该值
+     10. `mode` :默认`insert`，可选如下
+     1. `insert`: 默认
+     2. `insertIfNotExists`: 通过主键或者existConditionOtherThanIds字段判断数据是否存在，不存在才插入,存在则不执行
+     3. `replace`: 只支持用主键判断, 存在更新, 不存在插入
+     11. `existConditionOtherThanIds`: insertIfNotExists时判断同一记录的字段名称，默认情况下按照ID判断，设置existConditionOtherThanIds后，不用id
+     12. `replaceWithDef` replace时，是否带入默认值? 默认true
+     ### 返回值是最后一次插入的主键ID，对于自增ID表适用
+     1. 如果主键是自增批量操作，且期望返回所有记录的ID，那么需要设置 `option 中的 every = true`,此时效率降低
+     * @memberof SqlService
      */
     insert(option: MethodOption & {
         data: Partial<T>;
@@ -848,22 +877,22 @@ export declare class SqlService<T extends object> {
     }): bigint[];
     private _update;
     /**
-    ## 根据主键修改
-    0. `sync`: 同步（sqlite）或者异步（mysql、remote），影响返回值类型,默认`异步模式`
-    1. `data`：可是数组或者单对象
-    2. `skipUndefined`: boolean; 是否不处理值为undefined的字段,默认 true
-    3. `skipNull`: boolean; 是否不处理值为null的字段,默认 true
-    4. `skipEmptyString`: boolean; 是否不处理值为空字符串(`注意：多个空格也算空字符串`)的字段,默认 true
-    5. `maxDeal`: number; 批量处理时，每次处理多少个？默认500
-    6. `tableName`: 默认使用service注解的`tableName`,可以在某个方法中覆盖
-    7. `dbName`: 默认使用service注解的`dbName`,可以在某个方法中覆盖
-    8. `conn`: 仅在开启事务时需要主动传入,传入示例:
-        ```
-            service.transaction(async conn => {
-                service.insert({conn});
-            });
-        ```
-    9.  `dao`: 永远不需要传入该值
+     ## 根据主键修改
+     0. `sync`: 同步（sqlite）或者异步（mysql、remote），影响返回值类型,默认`异步模式`
+     1. `data`：可是数组或者单对象
+     2. `skipUndefined`: boolean; 是否不处理值为undefined的字段,默认 true
+     3. `skipNull`: boolean; 是否不处理值为null的字段,默认 true
+     4. `skipEmptyString`: boolean; 是否不处理值为空字符串(`注意：多个空格也算空字符串`)的字段,默认 true
+     5. `maxDeal`: number; 批量处理时，每次处理多少个？默认500
+     6. `tableName`: 默认使用service注解的`tableName`,可以在某个方法中覆盖
+     7. `dbName`: 默认使用service注解的`dbName`,可以在某个方法中覆盖
+     8. `conn`: 仅在开启事务时需要主动传入,传入示例:
+     ```
+     service.transaction(async conn => {
+     service.insert({conn});
+     });
+     ```
+     9.  `dao`: 永远不需要传入该值
      */
     update(option: MethodOption & {
         data: Partial<T> | Array<Partial<T>>;
@@ -882,23 +911,23 @@ export declare class SqlService<T extends object> {
         maxDeal?: number;
     }): number;
     /**
-    ## 删除
-    0. `sync`: 同步（sqlite）或者异步（mysql、remote），影响返回值类型,默认`异步模式`
-    1. 支持按ID删除：可以单个ID或者ID数组 `需要实体类只有一个ID`
-    2. 支持实体类删除: 用于多个ID或者按实体类某些字段删除
-    3. 两种模式：`mode`=`Common` 或者 `TempTable`
-    3. 如果数据多，使用 `TempTable`模式
-    4. 当设置实体类的字段有 `logicDelete` ，将进行逻辑删除，除非设置 forceDelete = true
-    6. `tableName`: 默认使用service注解的`tableName`,可以在某个方法中覆盖
-    7. `dbName`: 默认使用service注解的`dbName`,可以在某个方法中覆盖
-    8. `conn`: 仅在开启事务时需要主动传入,传入示例:
-        ```
-            service.transaction(async conn => {
-                service.insert({conn});
-            });
-        ```
-    9.  `dao`: 永远不需要传入该值
-    */
+     ## 删除
+     0. `sync`: 同步（sqlite）或者异步（mysql、remote），影响返回值类型,默认`异步模式`
+     1. 支持按ID删除：可以单个ID或者ID数组 `需要实体类只有一个ID`
+     2. 支持实体类删除: 用于多个ID或者按实体类某些字段删除
+     3. 两种模式：`mode`=`Common` 或者 `TempTable`
+     3. 如果数据多，使用 `TempTable`模式
+     4. 当设置实体类的字段有 `logicDelete` ，将进行逻辑删除，除非设置 forceDelete = true
+     6. `tableName`: 默认使用service注解的`tableName`,可以在某个方法中覆盖
+     7. `dbName`: 默认使用service注解的`dbName`,可以在某个方法中覆盖
+     8. `conn`: 仅在开启事务时需要主动传入,传入示例:
+     ```
+     service.transaction(async conn => {
+     service.insert({conn});
+     });
+     ```
+     9.  `dao`: 永远不需要传入该值
+     */
     delete(option: MethodOption & {
         sync?: SyncMode.Async;
         id?: string | number | Array<string | number>;
@@ -915,26 +944,26 @@ export declare class SqlService<T extends object> {
     }): number;
     private _template;
     /**
-    #根据条件查询对象
-    ## 特点：快速、简单，可快速根据某些字段是否等于来查询返回，可以查询记录和记录数
-    0. `sync`: 同步（sqlite）或者异步（mysql、remote），影响返回值类型,默认`异步模式`
-    1. `templateResult`: 返回值类型断言，4种
-        1. `AssertOne` 确定返回一个，如果不是一个，将报错，返回类型是T `默认`
-        2. `NotSureOne` 可能返回一个，返回类型是T|null
-        3. `Many` 返回多个
-        4. `Count` 返回记录数
-    2. 支持按ID查询：可以单个ID或者ID数组 `需要实体类只有一个ID`
-    3. 支持实体类查询: 用于多个ID或者按实体类某些字段查询
-    4. 两种查询方式：`mode`=`Common`(默认) 或者 `TempTable`
-    5. `tableName`: 默认使用service注解的`tableName`,可以在某个方法中覆盖
-    6. `dbName`: 默认使用service注解的`dbName`,可以在某个方法中覆盖
-    7. `conn`: 仅在开启事务时需要主动传入,传入示例:
-        ```
-            service.transaction(async conn => {
-                service.insert({conn});
-            });
-        ```
-    8.  `dao`: 永远不需要传入该值
+     #根据条件查询对象
+     ## 特点：快速、简单，可快速根据某些字段是否等于来查询返回，可以查询记录和记录数
+     0. `sync`: 同步（sqlite）或者异步（mysql、remote），影响返回值类型,默认`异步模式`
+     1. `templateResult`: 返回值类型断言，4种
+     1. `AssertOne` 确定返回一个，如果不是一个，将报错，返回类型是T `默认`
+     2. `NotSureOne` 可能返回一个，返回类型是T|null
+     3. `Many` 返回多个
+     4. `Count` 返回记录数
+     2. 支持按ID查询：可以单个ID或者ID数组 `需要实体类只有一个ID`
+     3. 支持实体类查询: 用于多个ID或者按实体类某些字段查询
+     4. 两种查询方式：`mode`=`Common`(默认) 或者 `TempTable`
+     5. `tableName`: 默认使用service注解的`tableName`,可以在某个方法中覆盖
+     6. `dbName`: 默认使用service注解的`dbName`,可以在某个方法中覆盖
+     7. `conn`: 仅在开启事务时需要主动传入,传入示例:
+     ```
+     service.transaction(async conn => {
+     service.insert({conn});
+     });
+     ```
+     8.  `dao`: 永远不需要传入该值
 
      */
     template<L = T>(option: MethodOption & {
@@ -1059,32 +1088,58 @@ export declare class SqlService<T extends object> {
     }): Promise<ArrayList<L>>;
     private _select;
     /**
-    # 自由查询
-    0. `sync`: 同步（sqlite）或者异步（mysql、remote），影响返回值类型,默认`异步模式`
-    1. `templateResult`: 返回值类型断言，6种, R表示行，C表示列，带S表示复数
-        1. R_C_Assert,
-        2. R_C_NotSure,
-        3. R_CS_Assert,
-        4. R_CS_NotSure,
-        5. RS_C,
-        6. RS_C_List
-        7. RS_CS[默认]
-        8. RS_CS_List
-    2. `sql` 或者 `sqlid`
-    3. `params`
-    4. `defValue`: One_Row_One_Column 时有效
-    5. 禁止一次查询多个语句
-    6. `dbName`: 默认使用service注解的`dbName`,可以在某个方法中覆盖
-    7. `conn`: 仅在开启事务时需要主动传入,传入示例:
-        ```
-            service.transaction(async conn => {
-                service.insert({conn});
-            });
-        ```
-    9.  `dao`: 永远不需要传入该值
-    10. `hump`: 是否将列名改为驼峰写法？默认情况下按照全局配置
-    11. `mapper`: 列名-属性 映射工具，优先级高于hump
-
+     # 自由查询
+     0. `sync`: 同步（sqlite）或者异步（mysql、remote），影响返回值类型,默认`异步模式`
+     1. `templateResult`: 返回值类型断言，6种, R表示行，C表示列，带S表示复数
+     1. R_C_Assert,
+     2. R_C_NotSure,
+     3. R_CS_Assert,
+     4. R_CS_NotSure,
+     5. RS_C,
+     6. RS_C_List
+     7. RS_CS[默认]
+     8. RS_CS_List
+     2. `sql` 或者 `sqlid`
+     3. `params`
+     4. `defValue`: One_Row_One_Column 时有效
+     5. 禁止一次查询多个语句
+     6. `dbName`: 默认使用service注解的`dbName`,可以在某个方法中覆盖
+     7. `conn`: 仅在开启事务时需要主动传入,传入示例:
+     ```
+     service.transaction(async conn => {
+     service.insert({conn});
+     });
+     ```
+     9.  `dao`: 永远不需要传入该值
+     10. `hump`: 是否将列名改为驼峰写法？默认情况下按照全局配置
+     11. `mapper`: 列名-属性 映射工具，优先级高于hump
+     ```
+     //    该属性支持传入mybatis.xml中定义的resultMap块ID，或者读取sqlMapDir目录下的JSON文件.
+     //    注意：resultMap块ID与sql语句逻辑一致，同样是 目录.ID
+     //    或者自定义Mapper,自定义Mapper格式如下:
+     [
+     {columnName: 'dit_id', mapNames: ['DTID'], def: 0, convert: 转换函数},  // 列名ditid,对应属性DTID,如果没有值，将返回默认值0,其中默认值0是可选的
+     {columnName: 'event_id', mapNames: ['eventMainInfo', 'id'], def: 0,  convert: 转换函数},// 列名event_id对应属性eventMainInfo.id,这种方式将返回嵌套的json对象,其中默认值null是可选的
+     ]
+     ```
+     #TODO 未完成读取 sqlMapDir
+     #### sqlMapDir 目录定义如下，
+     `test.ts`
+     ```
+     export const dict:SqlMappers = [
+     {columnName: 'dit_id', mapNames: ['DTID'], def: 0, convert: 转换函数},  // 列名ditid,对应属性DTID,如果没有值，将返回默认值0,其中默认值0是可选的
+     {columnName: 'event_id', mapNames: ['eventMainInfo', 'id'], def: 0,  convert: 转换函数},// 列名event_id对应属性eventMainInfo.id,这种方式将返回嵌套的json对象,其中默认值null是可选的
+     ]
+     ```
+     将得到 test.dict 这个map
+     12. dataConvert 数据转换器
+     ```
+     dataConvert: {
+         fileName: 'qiniu'
+     }
+         // 表示列 fileName 按 qiniu的函数格式化
+         // qiniu 在开始时定义
+     ```
      */
     select<L = T>(option: MethodOption & {
         sync?: SyncMode.Async;
@@ -1099,6 +1154,8 @@ export declare class SqlService<T extends object> {
         hump?: boolean;
         mapper?: string | SqlMapper;
         mapperIfUndefined?: MapperIfUndefined;
+        buildInConvert?: Record<keyof L, string>;
+        dataConvert?: Record<string, string>;
     }): Promise<L[]>;
     select<L = T>(option: MethodOption & {
         sync?: SyncMode.Async;
@@ -1113,6 +1170,8 @@ export declare class SqlService<T extends object> {
         hump?: boolean;
         mapper?: string | SqlMapper;
         mapperIfUndefined?: MapperIfUndefined;
+        buildInConvert?: Record<keyof L, string>;
+        dataConvert?: Record<string, string>;
     }): Promise<ArrayList<L>>;
     select<L = T>(option: MethodOption & {
         sync?: SyncMode.Async;
@@ -1127,6 +1186,8 @@ export declare class SqlService<T extends object> {
         hump?: boolean;
         mapper?: string | SqlMapper;
         mapperIfUndefined?: MapperIfUndefined;
+        buildInConvert?: Record<keyof L, string>;
+        dataConvert?: Record<string, string>;
     }): Promise<L>;
     select<L = T>(option: MethodOption & {
         sync?: SyncMode.Async;
@@ -1141,6 +1202,8 @@ export declare class SqlService<T extends object> {
         hump?: boolean;
         mapper?: string | SqlMapper;
         mapperIfUndefined?: MapperIfUndefined;
+        buildInConvert?: Record<keyof L, string>;
+        dataConvert?: Record<string, string>;
     }): Promise<L | null>;
     select<L = T>(option: MethodOption & {
         sync: SyncMode.Sync;
@@ -1155,6 +1218,8 @@ export declare class SqlService<T extends object> {
         hump?: boolean;
         mapper?: string | SqlMapper;
         mapperIfUndefined?: MapperIfUndefined;
+        buildInConvert?: Record<keyof L, string>;
+        dataConvert?: Record<string, string>;
     }): L[];
     select<L = T>(option: MethodOption & {
         sync: SyncMode.Sync;
@@ -1169,6 +1234,8 @@ export declare class SqlService<T extends object> {
         hump?: boolean;
         mapper?: string | SqlMapper;
         mapperIfUndefined?: MapperIfUndefined;
+        buildInConvert?: Record<keyof L, string>;
+        dataConvert?: Record<string, string>;
     }): ArrayList<L>;
     select<L = T>(option: MethodOption & {
         sync: SyncMode.Sync;
@@ -1183,6 +1250,8 @@ export declare class SqlService<T extends object> {
         hump?: boolean;
         mapper?: string | SqlMapper;
         mapperIfUndefined?: MapperIfUndefined;
+        buildInConvert?: Record<keyof L, string>;
+        dataConvert?: Record<string, string>;
     }): L;
     select<L = T>(option: MethodOption & {
         sync: SyncMode.Sync;
@@ -1197,6 +1266,8 @@ export declare class SqlService<T extends object> {
         hump?: boolean;
         mapper?: string | SqlMapper;
         mapperIfUndefined?: MapperIfUndefined;
+        buildInConvert?: Record<keyof L, string>;
+        dataConvert?: Record<string, string>;
     }): L | null;
     /**
      # 自由执行sql
@@ -1205,14 +1276,14 @@ export declare class SqlService<T extends object> {
      2. `params`
      3. `dbName`: 默认使用service注解的`dbName`,可以在某个方法中覆盖
      4. `conn`: 仅在开启事务时需要主动传入,传入示例:
-         ```
-             service.transaction(async conn => {
-                 service.insert({conn});
-             });
-         ```
+     ```
+     service.transaction(async conn => {
+     service.insert({conn});
+     });
+     ```
      5.  `dao`: 永远不需要传入该值
-     
-      */
+
+     */
     excute<L = T>(option: MethodOption & {
         sync?: SyncMode.Async;
         sqlId?: string;
@@ -1268,6 +1339,7 @@ export declare class SqlService<T extends object> {
         hump?: boolean;
         mapper?: string | SqlMapper;
         mapperIfUndefined?: MapperIfUndefined;
+        dataConvert?: Record<string, string>;
     }): Promise<PageQuery<L>>;
     page<L = T>(option: MethodOption & {
         sync: SyncMode.Sync;
@@ -1284,6 +1356,7 @@ export declare class SqlService<T extends object> {
         hump?: boolean;
         mapper?: string | SqlMapper;
         mapperIfUndefined?: MapperIfUndefined;
+        dataConvert?: Record<string, string>;
     }): PageQuery<L>;
     /**
      * 导出数据，可以为EJS-EXCEL直接使用
@@ -1326,16 +1399,16 @@ export declare class SqlService<T extends object> {
         sync: SyncMode.Sync;
     }): void;
     /**
-    #创建表
-    ** `tableName` 表名称
-    ** `temp` 是否是临时表，默认true
-    ** `columns` 字符串数组，默认是当前实体类全部字段，通过`columns` 可以创建部分字段临时表
-    ** `id` 表的主键设置 4种：
-    1. `auto`: `columns`中已经在当前实体类配置的ID作为主键 `默认`
-    2. `all`: `columns`中所有字段全部当主键
-    3. `none`: 没有主键
-    4. 自定义字段名称：字符串数组
-    ** `index` 表的索引，设置方式同ID
+     #创建表
+     ** `tableName` 表名称
+     ** `temp` 是否是临时表，默认true
+     ** `columns` 字符串数组，默认是当前实体类全部字段，通过`columns` 可以创建部分字段临时表
+     ** `id` 表的主键设置 4种：
+     1. `auto`: `columns`中已经在当前实体类配置的ID作为主键 `默认`
+     2. `all`: `columns`中所有字段全部当主键
+     3. `none`: 没有主键
+     4. 自定义字段名称：字符串数组
+     ** `index` 表的索引，设置方式同ID
      */
     private _createTable;
     private _matchSqlid;
@@ -1343,7 +1416,7 @@ export declare class SqlService<T extends object> {
     private _generSql;
 }
 declare class StreamQuery<T extends object> {
-    private _prefix;
+    private readonly _prefix;
     private _index;
     private _wheres;
     private _andQuerys;
@@ -1360,7 +1433,7 @@ declare class StreamQuery<T extends object> {
     private _orders;
     private _startRow;
     private _pageSize;
-    private _service;
+    private readonly _service;
     private [_fields];
     private [_columns];
     constructor(service: SqlService<T>, __fields: Record<string, AField>, __columns: string[]);
@@ -1371,6 +1444,8 @@ declare class StreamQuery<T extends object> {
     /**
      * AND(key1 = :value OR key2 = :value)
      * @param keys [key1, key2, ...]
+     * @param keys
+     * @param value
      */
     eqs(keys: (keyof T)[], value: string | number, { paramName, skipEmptyString, breakExcuteIfSkip }?: {
         paramName?: string | undefined;
@@ -1689,6 +1764,7 @@ declare class StreamQuery<T extends object> {
     update(key: keyof T, value: T[keyof T]): this;
     update2(sql: string, param?: Record<string, any>): this;
     updateT(t: Partial<T>): this;
+    /** SET key = REPLACE(key, :valueToFind,  :valueToReplace) */
     replace(key: keyof T, valueToFind: T[keyof T], valueToReplace: T[keyof T]): this;
     excuteSelect<L = T>(option?: MethodOption & {
         sync?: SyncMode.Async;
@@ -1753,6 +1829,7 @@ declare class StreamQuery<T extends object> {
         hump?: boolean;
         mapper?: string | SqlMapper;
         mapperIfUndefined?: MapperIfUndefined;
+        dataConvert?: Record<string, string>;
     }): PageQuery<L> | Promise<PageQuery<L>>;
     excuteUpdate(option?: MethodOption & {
         sync?: SyncMode.Async;