#moonbitDB

⚠️ 项目能力边界

moonbitDB 是一个单进程内存型数据库库，以下能力暂不在项目范围内：

• 暂不提供网络服务 — 无 TCP/HTTP 服务器，无远程连接能力，不支持客户端-服务器架构
• 暂不提供数据持久化 — 所有数据仅存储于内存中（Map[String, RedisValue]），进程退出后数据即丢失
• 暂不提供并发处理 — 无异步操作，无线程安全保证，无锁机制

适用场景：嵌入式场景、测试模拟、本地缓存、学习参考

README 中的 PING/ECHO/INFO 等命令为 API 方法，非网络服务协议命令。

#安装

#前置条件

#安装 MoonBit CLI

curl -fsSL https://cli.moonbitlang.com/install/unix.sh | bash

Set-ExecutionPolicy RemoteSigned -Scope CurrentUser
irm https://cli.moonbitlang.com/install/powershell.ps1 | iex

npm install -g @moonbit/cli

更多安装方式请参考 MoonBit 官方安装文档。

#验证安装

moon version

#快速开始

#运行演示

moon run . --target native

#运行测试

moon test

#库导入指南

#1. 添加模块依赖

{
  "name": "your-name/your-project",
  "deps": {
    "JIA2JIA2/moonbitdb": "0.1.1"
  }
}

#2. 同步依赖

moon update

#3. 声明包导入

{
  "import": ["JIA2JIA2/moonbitdb/lib"]
}

#4. 使用

fn main {
  let db = @lib.Database::new()
  db.set("greeting", "Hello, moonbitDB!")
  let value = db.get("greeting")
  println(value) // Some("Hello, moonbitDB!")
}

注意：moon update 是必须步骤，添加依赖后未执行此命令将导致编译错误。 导入路径为 JIA2JIA2/moonbitdb/lib（注意包含 /lib 后缀），不是 JIA2JIA2/moonbitdb。

#项目结构

moonbitDB/
├── lib/                        # 核心库（非 main 包，可被其他包 import）
│   ├── database.mbt            # 核心数据库实现（~3200 行）
│   └── moon.pkg.json
├── demo.mbt                    # 快速开始演示（主包入口）
├── moon.pkg.json               # 主包配置（is_main: true，依赖 lib）
├── examples/                   # 场景部署示例（独立子包，均可运行）
│   ├── basic_usage/            # 基础 API 使用示例
│   │   ├── main.mbt
│   │   └── moon.pkg.json
│   ├── leaderboard/            # 游戏排行榜场景
│   │   ├── main.mbt
│   │   └── moon.pkg.json
│   ├── shopping_cart/          # 电商购物车 / 缓存场景
│   │   ├── main.mbt
│   │   └── moon.pkg.json
│   └── cli_repl/               # 命令行交互演示
│       ├── main.mbt
│       └── moon.pkg.json
├── moon.mod.json               # 模块配置（moonbitdb/moonbitdb）
└── README.md                   # 本文档

包架构说明：核心逻辑放在 lib/ 子包（非 main），主包和 examples 均依赖 lib。这种设计符合 MoonBit 规范，避免了 "examples depend on main package" 的警告。

#支持的命令

#String 命令

#Key 命令

#Hash 命令

注意：HEXISTS、HKEYS、HVALS 在 command() 返回列表中已声明，但源码中尚未实现对应方法，待后续版本补充。

#List 命令

#Set 命令

#Sorted Set 命令

#批量命令

#服务器命令

#完整公共 API 文档

#Database 结构体

#构造函数与辅助方法

#String 操作

#Key 操作

#Hash 操作

注意：hexists、hkeys、hvals 在 command() 返回列表中已声明，但当前版本源码中尚未实现。

#List 操作

#Set 操作

#Sorted Set 操作

#批量操作

#服务器命令

#Deque 结构体

#独立函数

#部署示例

#1. 快速开始演示

moon run . --target native

========================================
  MoonBitDB - 快速开始演示
========================================

📌 1. String 基础操作
  GET greeting = "Hello, MoonBitDB!"
  INCR counter = 11

📌 2. Hash 用户信息存储
  HLEN user:1001 = 3

📌 3. List 任务队列
  LRANGE tasks 0 -1 = [完成报告, 代码审查, 团队会议]

📌 4. Set 标签系统
  SCARD = 3 (自动去重)

📌 5. Sorted Set 排行榜
  TOP 3 (ZREVRANGE 0 2):
    #1 玩家D - 3200分
    #2 玩家B - 2500分

📌 6. Key 过期机制
  65秒后 EXISTS = false

📌 7. 批量操作
📌 8. 服务器信息
========================================
  ✅ 演示完成！
========================================

#2. 基础 API 使用示例

moon run examples/basic_usage --target native

#3. 游戏排行榜系统

moon run examples/leaderboard --target native

• ZSET 实现玩家分数排名
• ZINCRBY 实时更新分数
• ZREVRANGE / ZRANK 查询排名
• ZPOPMAX 领奖台功能
• SET 实现好友关系
• SINTER 共同好友
• LIST 实现消息队列
• HASH 存储玩家信息

#4. 电商购物车 & 缓存

moon run examples/shopping_cart --target native

• HASH 存储购物车商品和商品信息
• String + EXPIRE 实现会话管理和缓存
• LIST 实现浏览历史
• SET 实现收藏和商品标签
• SINTER / SUNION 实现标签筛选
• ZSET 实现销量排行榜
• MSET / MGET 批量预热缓存

#5. CLI 命令行交互

moon run examples/cli_repl --target native

#许可证

#Redis 参考范围说明

#参考范围

• String — 字符串值
• Hash — 哈希表（字段-值映射）
• List — 列表（双端队列）
• Set — 集合（无序唯一元素）
• Sorted Set — 有序集合（分数排序）

• EXPIRE / PEXPIRE — 设置过期时间（秒/毫秒）
• TTL / PTTL — 查询剩余生存时间
• PERSIST — 移除过期时间
• 惰性过期检查策略

• embstr — String 类型编码
• listpack — Hash/List/Set/ZSet 小规模编码
• hashtable — Hash/Set 大规模编码
• skiplist — ZSet 大规模编码
• quicklist — List 大规模编码

#第三方依赖