wbwdb - v1.2.10
    正在准备搜索索引...

    类 wbwdbManager

    wbwdb 数据库管理器

    const db = new wbwdbManager('./data');
    await db.init();

    文件夹结构为

    dbroot/
    ├─ index.json // 索引表
    ├─ table/(table name)/data.json // 数据
    索引
    path: string

    数据库路径

    rootdir: string | null = null

    根目录路径

    dbTables: Map<string, DBTable> = ...

    数据表

    auth: Auth | null = null

    Auth 认证模块

    • 初始化(加载)数据库

      返回 Promise<void>

      Promise

      当创建目录失败时抛出错误

    • 保存数据库

      返回 Promise<void>

      Promise

    • 刷新数据库(重新从磁盘加载)

      返回 Promise<void>

      Promise

    • 获取表

      参数

      • name: string

        表名

      返回 DBTable | undefined

      表实例或 undefined

    • 删除表

      参数

      • name: string

        表名

      返回 Promise<void>

      Promise

    • 执行 SQL 查询

      参数

      • sql: string

        SQL 语句

      • 可选params: unknown[]

        参数化查询的参数

      • 可选authContext:
            | {
                userId: string;
                username: string;
                roles: string[];
                permissions: string[];
            }
            | null

      返回 QueryResult

      查询结果

      const result = db.query("SELECT * FROM users WHERE age > $1", [25]);
      console.log(result.rows);
    • 注册事件监听器

      参数

      • event: string

        事件名 (beforeInsert, afterInsert, beforeUpdate, afterUpdate, beforeDelete, afterDelete)

      • table: string

        表名 (可选,不传则所有表触发)

      • fn: (...args: unknown[]) => void

        回调函数

      返回 void

    • 注册事件监听器

      参数

      • event: string

        事件名 (beforeInsert, afterInsert, beforeUpdate, afterUpdate, beforeDelete, afterDelete)

      • fn: (...args: unknown[]) => void

        回调函数

      返回 void

    • 移除事件监听器

      参数

      • event: string
      • table: string
      • fn: (...args: unknown[]) => void

      返回 void

    • 移除事件监听器

      参数

      • event: string
      • fn: (...args: unknown[]) => void

      返回 void

    • 触发事件

      参数

      • event: string
      • tableName: string
      • ...args: unknown[]

      返回 void