mm_sqlite 1.1.3 → 1.1.5

package/LICENSE

@@ -1,201 +1,21 @@
-Apache License
-                           Version 2.0, January 2004
-                        http://www.apache.org/licenses/
-
-   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-   1. Definitions.
-
-      "License" shall mean the terms and conditions for use, reproduction,
-      and distribution as defined by Sections 1 through 9 of this document.
-
-      "Licensor" shall mean the copyright owner or entity authorized by
-      the copyright owner that is granting the License.
-
-      "Legal Entity" shall mean the union of the acting entity and all
-      other entities that control, are controlled by, or are under common
-      control with that entity. For the purposes of this definition,
-      "control" means (i) the power, direct or indirect, to cause the
-      direction or management of such entity, whether by contract or
-      otherwise, or (ii) ownership of fifty percent (50%) or more of the
-      outstanding shares, or (iii) beneficial ownership of such entity.
-
-      "You" (or "Your") shall mean an individual or Legal Entity
-      exercising permissions granted by this License.
-
-      "Source" form shall mean the preferred form for making modifications,
-      including but not limited to software source code, documentation
-      source, and configuration files.
-
-      "Object" form shall mean any form resulting from mechanical
-      transformation or translation of a Source form, including but
-      not limited to compiled object code, generated documentation,
-      and conversions to other media types.
-
-      "Work" shall mean the work of authorship, whether in Source or
-      Object form, made available under the License, as indicated by a
-      copyright notice that is included in or attached to the work
-      (an example is provided in the Appendix below).
-
-      "Derivative Works" shall mean any work, whether in Source or Object
-      form, that is based on (or derived from) the Work and for which the
-      editorial revisions, annotations, elaborations, or other modifications
-      represent, as a whole, an original work of authorship. For the purposes
-      of this License, Derivative Works shall not include works that remain
-      separable from, or merely link (or bind by name) to the interfaces of,
-      the Work and Derivative Works thereof.
-
-      "Contribution" shall mean any work of authorship, including
-      the original version of the Work and any modifications or additions
-      to that Work or Derivative Works thereof, that is intentionally
-      submitted to Licensor for inclusion in the Work by the copyright owner
-      or by an individual or Legal Entity authorized to submit on behalf of
-      the copyright owner. For the purposes of this definition, "submitted"
-      means any form of electronic, verbal, or written communication sent
-      to the Licensor or its representatives, including but not limited to
-      communication on electronic mailing lists, source code control systems,
-      and issue tracking systems that are managed by, or on behalf of, the
-      Licensor for the purpose of discussing and improving the Work, but
-      excluding communication that is conspicuously marked or otherwise
-      designated in writing by the copyright owner as "Not a Contribution."
-
-      "Contributor" shall mean Licensor and any individual or Legal Entity
-      on behalf of whom a Contribution has been received by Licensor and
-      subsequently incorporated within the Work.
-
-   2. Grant of Copyright License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      copyright license to reproduce, prepare Derivative Works of,
-      publicly display, publicly perform, sublicense, and distribute the
-      Work and such Derivative Works in Source or Object form.
-
-   3. Grant of Patent License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      (except as stated in this section) patent license to make, have made,
-      use, offer to sell, sell, import, and otherwise transfer the Work,
-      where such license applies only to those patent claims licensable
-      by such Contributor that are necessarily infringed by their
-      Contribution(s) alone or by combination of their Contribution(s)
-      with the Work to which such Contribution(s) was submitted. If You
-      institute patent litigation against any entity (including a
-      cross-claim or counterclaim in a lawsuit) alleging that the Work
-      or a Contribution incorporated within the Work constitutes direct
-      or contributory patent infringement, then any patent licenses
-      granted to You under this License for that Work shall terminate
-      as of the date such litigation is filed.
-
-   4. Redistribution. You may reproduce and distribute copies of the
-      Work or Derivative Works thereof in any medium, with or without
-      modifications, and in Source or Object form, provided that You
-      meet the following conditions:
-
-      (a) You must give any other recipients of the Work or
-          Derivative Works a copy of this License; and
-
-      (b) You must cause any modified files to carry prominent notices
-          stating that You changed the files; and
-
-      (c) You must retain, in the Source form of any Derivative Works
-          that You distribute, all copyright, patent, trademark, and
-          attribution notices from the Source form of the Work,
-          excluding those notices that do not pertain to any part of
-          the Derivative Works; and
-
-      (d) If the Work includes a "NOTICE" text file as part of its
-          distribution, then any Derivative Works that You distribute must
-          include a readable copy of the attribution notices contained
-          within such NOTICE file, excluding those notices that do not
-          pertain to any part of the Derivative Works, in at least one
-          of the following places: within a NOTICE text file distributed
-          as part of the Derivative Works; within the Source form or
-          documentation, if provided along with the Derivative Works; or,
-          within a display generated by the Derivative Works, if and
-          wherever such third-party notices normally appear. The contents
-          of the NOTICE file are for informational purposes only and
-          do not modify the License. You may add Your own attribution
-          notices within Derivative Works that You distribute, alongside
-          or as an addendum to the NOTICE text from the Work, provided
-          that such additional attribution notices cannot be construed
-          as modifying the License.
-
-      You may add Your own copyright statement to Your modifications and
-      may provide additional or different license terms and conditions
-      for use, reproduction, or distribution of Your modifications, or
-      for any such Derivative Works as a whole, provided Your use,
-      reproduction, and distribution of the Work otherwise complies with
-      the conditions stated in this License.
-
-   5. Submission of Contributions. Unless You explicitly state otherwise,
-      any Contribution intentionally submitted for inclusion in the Work
-      by You to the Licensor shall be under the terms and conditions of
-      this License, without any additional terms or conditions.
-      Notwithstanding the above, nothing herein shall supersede or modify
-      the terms of any separate license agreement you may have executed
-      with Licensor regarding such Contributions.
-
-   6. Trademarks. This License does not grant permission to use the trade
-      names, trademarks, service marks, or product names of the Licensor,
-      except as required for reasonable and customary use in describing the
-      origin of the Work and reproducing the content of the NOTICE file.
-
-   7. Disclaimer of Warranty. Unless required by applicable law or
-      agreed to in writing, Licensor provides the Work (and each
-      Contributor provides its Contributions) on an "AS IS" BASIS,
-      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-      implied, including, without limitation, any warranties or conditions
-      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-      PARTICULAR PURPOSE. You are solely responsible for determining the
-      appropriateness of using or redistributing the Work and assume any
-      risks associated with Your exercise of permissions under this License.
-
-   8. Limitation of Liability. In no event and under no legal theory,
-      whether in tort (including negligence), contract, or otherwise,
-      unless required by applicable law (such as deliberate and grossly
-      negligent acts) or agreed to in writing, shall any Contributor be
-      liable to You for damages, including any direct, indirect, special,
-      incidental, or consequential damages of any character arising as a
-      result of this License or out of the use or inability to use the
-      Work (including but not limited to damages for loss of goodwill,
-      work stoppage, computer failure or malfunction, or any and all
-      other commercial damages or losses), even if such Contributor
-      has been advised of the possibility of such damages.
-
-   9. Accepting Warranty or Additional Liability. While redistributing
-      the Work or Derivative Works thereof, You may choose to offer,
-      and charge a fee for, acceptance of support, warranty, indemnity,
-      or other liability obligations and/or rights consistent with this
-      License. However, in accepting such obligations, You may act only
-      on Your own behalf and on Your sole responsibility, not on behalf
-      of any other Contributor, and only if You agree to indemnify,
-      defend, and hold each Contributor harmless for any liability
-      incurred by, or claims asserted against, such Contributor by reason
-      of your accepting any such warranty or additional liability.
-
-   END OF TERMS AND CONDITIONS
-
-   APPENDIX: How to apply the Apache License to your work.
-
-      To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "[]"
-      replaced with your own identifying information. (Don't include
-      the brackets!)  The text should be enclosed in the appropriate
-      comment syntax for the file format. We also recommend that a
-      file or class name and description of purpose be included on the
-      same "printed page" as the copyright notice for easier
-      identification within third-party archives.
-
-   Copyright [yyyy] [name of copyright owner]
-
-   Licensed under the Apache License, Version 2.0 (the "License");
-   you may not use this file except in compliance with the License.
-   You may obtain a copy of the License at
-
-       http://www.apache.org/licenses/LICENSE-2.0
-
-   Unless required by applicable law or agreed to in writing, software
-   distributed under the License is distributed on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
-   limitations under the License.
+MIT License
+
+Copyright (c) 2024 邱文武
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -2,28 +2,26 @@
 
 高性能SQLite数据库操作模块，提供与mm_mysql完全兼容的API接口。适用于Node.js应用的轻量级数据存储解决方案。
 
-## 特性
-
-- 🚀 **高性能优化**：经过深度优化的SQL构建器和连接管理
-- 🔄 **完全兼容**：与mm_mysql模块API完全兼容
-- 📊 **内存优化**：优化的内存使用，减少GC压力
-- 🔧 **链式调用**：流畅的SQL构建器链式调用
-- 🛡️ **错误处理**：完善的错误处理机制
-- 📈 **性能监控**：内置性能测试和内存监控
+[![npm version](https://img.shields.io/npm/v/mm_sqlite.svg?style=flat-square)](https://www.npmjs.com/package/mm_sqlite)
+[![npm downloads](https://img.shields.io/npm/dm/mm_sqlite.svg?style=flat-square)](https://www.npmjs.com/package/mm_sqlite)
+[![node version](https://img.shields.io/node/v/mm_sqlite.svg?style=flat-square)](https://nodejs.org/en/)
+[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](LICENSE)
 
 ## 安装
 
-通过npm安装模块：
-
 ```bash
 npm install mm_sqlite --save
 ```
 
-通过yarn安装模块：
+## 特性
 
-```bash
-yarn add mm_sqlite
-```
+- 🚀 **高性能优化**：经过深度优化的SQL构建器和连接管理
+- 🔄 **完全兼容**：与mm_mysql模块API完全兼容
+- 📊 **内存优化**：优化的内存使用，减少GC压力
+- 🔧 **链式调用**：流畅的SQL构建器链式调用
+- 🛡️ **错误处理**：完善的错误处理机制
+- 📈 **连接池支持**：支持连接池模式，提高并发性能
+- 🔒 **事务支持**：完整的事务处理机制
 
 ## 依赖要求
 
@@ -41,11 +39,25 @@ const { Sqlite } = require('mm_sqlite');
 
 // 创建数据库实例
 const sqlite = new Sqlite({
-    database: './data/test.db',     // 数据库文件路径
-    timeout: 30000,                 // 查询超时时间（毫秒）
-    retry_count: 3,                 // 失败重试次数
-    conn_timeout: 30000,            // 连接超时时间（毫秒）
-    enablePerformanceLog: false     // 是否启用性能日志
+    dir: './db/',                  // 数据库文件存储目录
+    database: 'test',              // 数据库文件名（不包含扩展名）
+    charset: 'utf8mb4',            // 字符集
+    timezone: '+08:00',            // 时区
+    connect_timeout: 20000,        // 连接超时时间（毫秒）
+    acquire_timeout: 20000,        // 获取连接超时时间（毫秒）
+    query_timeout: 20000,          // 查询超时时间（毫秒）
+    connection_limit: 1,           // 连接限制（>1启用连接池）
+    enable_keep_alive: true,       // 启用保活
+    keep_alive_initial_delay: 10000, // 保活初始延迟
+    enable_reconnect: true,        // 启用重连
+    reconnect_interval: 1000,      // 重连间隔
+    max_reconnect_attempts: 5,     // 最大重连尝试次数
+    wait_for_connections: true,    // 等待连接
+    pool_min: 1,                   // 连接池最小连接数
+    pool_max: 5,                   // 连接池最大连接数
+    pool_acquire_timeout: 30000,   // 连接池获取超时
+    pool_idle_timeout: 60000,      // 连接池空闲超时
+    pool_reap_interval: 1000       // 连接池清理间隔
 });
 
 // 打开数据库连接
@@ -161,34 +173,38 @@ await sqlite.close();
 
 ```javascript
 // 开始事务
-await sqlite.beginTransaction();
+const transaction = await sqlite.beginTransaction();
 
 try {
-    // 插入数据
-    await sqlite.table('users').insert({
-        name: '张三',
-        email: 'zhangsan@example.com',
-        status: 'active'
-    });
-
-    // 更新数据
-    await sqlite.table('profiles').insert({
-        user_id: 1,
-        bio: '这是一个测试用户'
-    });
+    // 在事务中执行操作
+    await transaction.exec('INSERT INTO users (username, email) VALUES (?, ?)', ['张三', 'zhangsan@example.com']);
+    await transaction.exec('INSERT INTO profiles (user_id, bio) VALUES (?, ?)', [1, '这是一个测试用户']);
 
     // 提交事务
-    await sqlite.commit();
+    await transaction.commit();
 } catch (error) {
     // 回滚事务
-    await sqlite.rollback();
+    await transaction.rollback();
     console.error('事务执行失败:', error);
 }
 ```
 
-#### 复杂查询
+#### 使用事务包装器
 
 ```javascript
+// 使用事务包装器简化事务处理
+const result = await sqlite.transaction(async (transaction) => {
+    // 在事务中执行操作
+    await transaction.exec('INSERT INTO users (username, email) VALUES (?, ?)', ['李四', 'lisi@example.com']);
+    await transaction.exec('INSERT INTO profiles (user_id, bio) VALUES (?, ?)', [2, '这是另一个测试用户']);
+    
+    return { success: true };
+});
+
+console.log('事务执行结果:', result);
+```
+
+#### 复杂查询
 // 多表连接查询
 const results = await sqlite
     .table('users')
@@ -242,102 +258,173 @@ const users = await sqlite
 new Sqlite(config)
 ```
 
-**参数：**
-- `config.database` - 数据库文件路径，默认为`'./db.sqlite'`
-- `config.timeout` - 查询超时时间，默认`30000ms`
-- `config.retry_count` - 失败重试次数，默认`3`
-- `config.conn_timeout` - 连接超时时间，默认`30000ms`
-- `config.enablePerformanceLog` - 是否启用性能日志，默认false
+**配置参数：**
+- `config.dir` - 数据库文件存储目录，默认为`'./db/'`
+- `config.database` - 数据库文件名，默认为`'mm'`
+- `config.charset` - 字符集，默认为`'utf8mb4'`
+- `config.timezone` - 时区，默认为`'+08:00'`
+- `config.connect_timeout` - 连接超时时间，默认`20000ms`
+- `config.acquire_timeout` - 获取连接超时时间，默认`20000ms`
+- `config.query_timeout` - 查询超时时间，默认`20000ms`
+- `config.connection_limit` - 连接限制（>1启用连接池），默认`1`
+- `config.enable_keep_alive` - 启用保活，默认`true`
+- `config.keep_alive_initial_delay` - 保活初始延迟，默认`10000ms`
+- `config.enable_reconnect` - 启用重连，默认`true`
+- `config.reconnect_interval` - 重连间隔，默认`1000ms`
+- `config.max_reconnect_attempts` - 最大重连尝试次数，默认`5`
+- `config.wait_for_connections` - 等待连接，默认`true`
+- `config.pool_min` - 连接池最小连接数，默认`1`
+- `config.pool_max` - 连接池最大连接数，默认`5`
+- `config.pool_acquire_timeout` - 连接池获取超时，默认`30000ms`
+- `config.pool_idle_timeout` - 连接池空闲超时，默认`60000ms`
+- `config.pool_reap_interval` - 连接池清理间隔，默认`1000ms`
 
 #### 主要方法
 
-- `getConnection()` - 获取数据库连接，返回Promise<Connection>
-- `closeConnection(conn)` - 关闭数据库连接，返回Promise<Boolean>
-- `run(sql, params)` - 执行SQL语句（非查询操作），返回Promise<Object>
-- `exec(sql, params)` - 执行SQL查询，返回Promise<Array>
-- `transaction(fn)` - 执行事务，返回Promise<any>
-- `table(tableName)` - 设置表名，返回Sql实例
+- `open(timeout)` - 打开数据库连接，返回`Promise<Boolean>`
+- `close()` - 关闭数据库连接，返回`Promise<Boolean>`
+- `getConn(timeout)` - 获取数据库连接，返回`Promise<Connection>`
+- `run(sql, params, timeout)` - 执行SQL查询语句，返回`Promise<Array>`
+- `exec(sql, params, timeout)` - 执行SQL语句（非查询操作），返回`Promise<Object>`
+- `read(table, condition, options)` - 读取整张表的数据，返回`Promise<Array>`
+- `db(database)` - 获取数据库操作实例，返回`DB`实例
+- `beginTransaction()` - 开始事务，返回`Promise<Object>`（事务对象）
+- `transaction(callback)` - 在事务中执行多个操作，返回`Promise<*>`
 
-### Sql类
+#### 事务对象方法
 
-#### 数据操作方法
+- `commit()` - 提交事务
+- `rollback()` - 回滚事务
+- `exec(sql, params)` - 在事务中执行SQL语句
 
-- `add(body)` - 添加单条数据，返回Promise<Object>
-- `del(query, like)` - 删除数据，返回Promise<Object>
-- `set(query, body, like)` - 更新数据，返回Promise<Object>
-- `get(query, sort, view, like, timeout)` - 查询多条数据，返回Promise<Array>
-- `getObj(query, sort, view, like, timeout)` - 获取单条记录，返回Promise<Object|null>
+### DB类
 
-#### 批量操作方法
+DB类继承自Sql类，提供SQL构建器功能。
 
-- `addList(list, lock, batchSize, timeout)` - 批量添加数据，返回Promise<Object>
-- `delList(list, like, batchSize, timeout)` - 批量删除数据，返回Promise<Object>
-- `setList(list, like, batchSize, timeout)` - 批量更新数据，返回Promise<Object>
-
-#### 统计方法
+#### 主要方法
 
-- `count(query, like, timeout)` - 统计记录数，返回Promise<Number>
-- `getCount(query, like, timeout)` - 查询数据并返回总数，返回Promise<{count: Number, data: Array}>
-- `groupCount(query, groupby, view, sort)` - 分组统计，返回Promise<Array>
-- `groupSum(query, groupby, view, sort)` - 分组求和，返回Promise<Array>
-- `groupAvg(query, groupby, view, sort)` - 分组平均值，返回Promise<Array>
+- `table(tableName)` - 设置表名，返回当前实例
+- `add(body)` - 添加单条数据，返回`Promise<Object>`
+- `del(query, like)` - 删除数据，返回`Promise<Object>`
+- `set(query, body, like)` - 更新数据，返回`Promise<Object>`
+- `get(query, sort, view, like, timeout)` - 查询多条数据，返回`Promise<Array>`
+- `getObj(query, sort, view, like, timeout)` - 获取单条记录，返回`Promise<Object|null>`
+- `addList(list, lock, batchSize, timeout)` - 批量添加数据，返回`Promise<Object>`
+- `delList(list, like, batchSize, timeout)` - 批量删除数据，返回`Promise<Object>`
+- `count(query, like, timeout)` - 统计记录数，返回`Promise<Number>`
+- `groupCount(query, groupby, view, sort)` - 分组统计，返回`Promise<Array>`
+- `groupSum(query, groupby, view, sort)` - 分组求和，返回`Promise<Array>`
+- `groupAvg(query, groupby, view, sort)` - 分组平均值，返回`Promise<Array>`
+
+#### SQL构建器方法
+
+- `select(fields)` - 设置查询字段
+- `where(condition)` - 设置查询条件
+- `orWhere(condition)` - 设置OR查询条件
+- `like(field, value)` - 设置LIKE查询条件
+- `orderBy(field, direction)` - 设置排序
+- `groupBy(field)` - 设置分组
+- `having(condition)` - 设置HAVING条件
+- `limit(count)` - 设置限制数量
+- `offset(count)` - 设置偏移量
+- `join(table, condition)` - 设置表连接
 
 ## 错误处理
 
 模块提供完善的错误处理机制：
 
+1. **参数验证**：所有公开方法都会验证输入参数，参数不符合要求时会抛出`TypeError`
+2. **SQL错误捕获**：SQL执行错误会被捕获并记录到日志中
+3. **连接错误处理**：连接失败时会自动重连，超过最大重试次数后抛出错误
+4. **事务错误处理**：事务执行失败时会自动回滚，确保数据一致性
+
+错误处理示例：
+
 ```javascript
+// 参数验证错误
 try {
-    const result = await sqlite.table('users').where({ id: 999 }).first();
-    if (!result) {
-        throw new Error('用户不存在');
-    }
-} catch (error) {
-    console.error('查询失败:', error.message);
-    // 错误码和详细信息
-    console.error('错误码:', error.code);
-    console.error('SQL语句:', error.sql);
+    await db.add(null); // 抛出TypeError
+} catch (err) {
+    console.error('参数错误:', err.message);
+}
+
+// SQL执行错误
+try {
+    await db.exec('SELECT * FROM non_existent_table');
+} catch (err) {
+    console.error('SQL错误:', err.message);
+}
+
+// 事务错误处理
+try {
+    await sqlite.transaction(async (tx) => {
+        await tx.exec('INSERT INTO users (name) VALUES (?)', ['Alice']);
+        await tx.exec('INSERT INTO users (name) VALUES (?)', [null]); // 触发错误
+    });
+} catch (err) {
+    console.error('事务执行失败:', err.message);
 }
 ```
 
 ## 性能监控
 
-模块设计注重性能优化，您可以通过以下方式监控性能：
+模块内置连接池和性能优化功能：
+
+1. **连接池管理**：自动管理数据库连接，提高并发性能
+2. **连接复用**：连接使用完毕后自动归还到连接池
+3. **连接保活**：定期检查连接状态，自动重连失效连接
+4. **超时控制**：支持连接超时、查询超时等配置
+
+连接池配置示例：
 
 ```javascript
-// 启用性能日志
 const sqlite = new Sqlite({
-    database: './data/test.db',
-    enablePerformanceLog: true
+    connection_limit: 5, // 启用连接池，最大5个连接
+    pool_min: 1,        // 最小连接数
+    pool_max: 5,        // 最大连接数
+    pool_idle_timeout: 60000, // 空闲超时60秒
+    enable_keep_alive: true,  // 启用保活
+    enable_reconnect: true    // 启用自动重连
 });
-
-// 测试特定操作的性能
-console.time('query_test');
-const results = await sqlite.table('users').get();
-console.timeEnd('query_test');
 ```
 
 对于大规模应用，建议在生产环境前进行压力测试，确保数据库操作满足性能要求。
 
 ## 兼容性
 
-- Node.js 14.0+ (推荐使用最新的LTS版本)
-- SQLite3 3.0+
-- 与mm_mysql模块API完全兼容
+- **Node.js版本**：支持 Node.js 12.0 及以上版本
+- **SQLite版本**：支持 SQLite 3.0 及以上版本
+- **操作系统**：支持 Windows、Linux、macOS
+
+## FAQ
+
+### Q: 如何处理数据库文件不存在的情况？
+A: 模块会自动创建数据库文件，无需手动创建。
+
+### Q: 如何优化查询性能？
+A: 建议使用索引、合理设计表结构、避免全表扫描。
 
-## 常见问题解答 (FAQ)
+### Q: 如何处理并发访问？
+A: 模块内置连接池机制，支持并发访问。当连接数超过1时自动启用连接池。
 
-**Q: 如何处理大量数据的插入操作？**
-A: 对于大量数据插入，建议使用`addList`方法配合事务处理，这样可以显著提高性能。
+### Q: 如何备份数据库？
+A: 可以直接复制数据库文件进行备份。
 
-**Q: 为什么连接池大小设置为1？**
-A: SQLite是单文件数据库，在大多数情况下单连接已经足够高效。多连接可能会导致锁竞争，反而降低性能。
+### Q: 如何查看SQL执行日志？
+A: 启用调试模式即可查看详细的SQL执行日志。
 
-**Q: 如何处理数据库文件路径？**
-A: 可以使用相对路径或绝对路径。建议使用绝对路径以避免路径解析问题。
+### Q: 连接池如何工作？
+A: 当`connection_limit`大于1时启用连接池，连接池会自动管理连接的获取和释放。
 
-**Q: 事务处理是否支持嵌套？**
-A: 目前不支持嵌套事务，但可以在一个事务中执行多个操作。
+### Q: 事务处理是否安全？
+A: 是的，事务处理包含完整的错误处理机制，失败时会自动回滚。
+
+### Q: 支持哪些SQL操作？
+A: 支持标准的CRUD操作、复杂查询、事务处理、批量操作等。
+
+## 贡献
+
+欢迎提交 Issue 和 Pull Request 来改进这个模块。
 
 ## 许可证
 
@@ -350,3 +437,13 @@ MIT License
 1. 运行测试确保功能正常
 2. 添加适当的注释和文档
 3. 遵循项目的代码风格
+4. 确保代码符合ES6+标准
+5. 提交前请先拉取最新代码，解决冲突
+
+### 开发流程
+
+1. Fork 仓库
+2. 创建特性分支 (`git checkout -b feature/AmazingFeature`)
+3. 提交更改 (`git commit -m 'Add some AmazingFeature'`)
+4. 推送到分支 (`git push origin feature/AmazingFeature`)
+5. 打开 Pull Request