基于文件的 JSON 数据库,内置 SQL 引擎和认证系统。
npm install @wbw121124/wbwdb
wbwdb [options] [command]
| 选项 | 说明 | 默认值 |
|---|---|---|
-d, --db <path> |
数据库路径 | ./data |
--json |
JSON 格式输出 | false |
# 交互式 SQL 终端
wbwdb shell
# 执行 SQL 语句
wbwdb query "CREATE TABLE users (name String, age Number)"
wbwdb query "INSERT INTO users (name, age) VALUES ('Alice', 30)"
wbwdb query "SELECT * FROM users WHERE age > 25"
wbwdb query --json "SELECT * FROM users" # JSON 输出
# 表管理
wbwdb tables # 列出所有表
wbwdb table list # 同上
wbwdb table info <name> # 查看表结构和数据
wbwdb table create # 交互式建表
wbwdb table drop <name> # 删表
# 用户管理
wbwdb user list
wbwdb user create
wbwdb user info <name>
wbwdb user delete <name>
wbwdb user login
# 角色管理
wbwdb role list
wbwdb role create
wbwdb role delete <name>
# 权限
wbwdb grant <username> <role>
wbwdb revoke <username> <role>
# 启动 API server
wbwdb server
wbwdb server [options]
wbwdb server -p 3000 -H 127.0.0.1
\dt 列出所有表
\d <name> 查看表结构
\schema <name> 输出表 schema (JSON)
\clear 清屏
\q 退出
import { wbwdbManager } from '@wbw121124/wbwdb';
const db = new wbwdbManager('./data');
await db.init();
// SQL 查询
db.query("CREATE TABLE users (name String, age Number)");
db.query("INSERT INTO users (name, age) VALUES ('Alice', 30)");
const result = db.query("SELECT * FROM users WHERE age > $1", [25]);
console.log(result.rows);
// 持久化
await db.save();
const db = new wbwdbManager('./data');
await db.init();
const auth = await db.initAuth();
// 注册
const { user, token } = await auth.register({
username: 'alice',
email: 'alice@example.com',
password: 'secret123',
});
// 登录
const loginResult = await auth.login('alice', 'secret123');
// 角色
const role = await auth.createRole({ name: 'admin', permissions: ['read', 'write'] });
await auth.assignRole(user.id, role.id);
| 类型 | 说明 |
|---|---|
Number |
数字 |
String |
字符串 |
Boolean |
布尔值 |
Date |
日期 |
Email |
邮箱(自动验证格式) |
Phone |
电话号码(支持中国大陆手机号) |
UUID |
UUID(自动校验) |
自定义类型:
import { addType } from '@wbw121124/wbwdb';
addType<MyType>('MyType', defaultValue);
CREATE TABLE, DROP TABLE, ALTER TABLE, CREATE INDEX, TRUNCATESELECT, INSERT, UPDATE, DELETEJOIN(INNER/LEFT/RIGHT/FULL)WHERE, GROUP BY, HAVING, ORDER BY, LIMIT, OFFSETCOUNT, SUM, AVG, MIN, MAXUPPER, LOWER, TRIM, SUBSTRING, REPLACE, CONCAT, LENGTHABS, CEIL, FLOOR, ROUNDCOALESCE, NULLIF, CASE WHEN, IN, BETWEEN, LIKE, EXISTS, CAST, DISTINCTBEGIN, COMMIT, ROLLBACKCREATE POLICY, ENABLE ROW LEVEL SECURITY, SET ROLECREATE HOOK, DROP HOOK(支持 JS 和 SQL 钩子)支持在 INSERT、UPDATE、DELETE 操作前后执行自定义逻辑。钩子使用 QuickJS 沙箱隔离执行 JS 代码,确保安全性。
-- 创建钩子
CREATE HOOK <hook_name> ON <table>
FOR INSERT|UPDATE|DELETE
BEFORE|AFTER
AS JS $$ <javascript_code> $$;
CREATE HOOK <hook_name> ON <table>
FOR INSERT|UPDATE|DELETE
BEFORE|AFTER
AS SQL $$ <sql_condition> $$;
-- 删除钩子
DROP HOOK <hook_name> ON <table>;
| 变量 | 说明 |
|---|---|
row |
当前行数据(BEFORE 钩子中可修改) |
oldRow |
UPDATE 时的旧行数据,INSERT/DELETE 时为 null |
tableName |
当前表名 |
abort(msg) |
终止操作并抛出错误 |
-- INSERT 前自动填充字段
CREATE HOOK auto_timestamp ON orders FOR INSERT BEFORE AS JS $$
row.created_at = new Date().toISOString();
$$;
-- UPDATE 前验证数据
CREATE HOOK check_balance ON accounts FOR UPDATE BEFORE AS JS $$
if (row.balance < 0) abort('余额不能为负数');
$$;
-- DELETE 前阻止删除
CREATE HOOK protect_admin ON users FOR DELETE BEFORE AS JS $$
if (row.role === 'admin') abort('不能删除管理员');
$$;
-- AFTER 钩子(仅执行,不阻止操作)
CREATE HOOK log_change ON orders FOR INSERT AFTER AS JS $$
console.log('新订单: ' + row.id);
$$;
require、fs、process 等均被隔离)abort() 函数可终止操作并回滚数据变更data/
dbroot/
index.json # 表索引
table/<table_name>/data.json # 表数据
npm run build # 编译
npm run build:watch # 监听模式编译
npm run lint # 代码检查
npm test # 运行测试
GPLv3.0