Redis::Dump 技术文档

2024-12-20 20:26:34作者：薛曦旖Francesca

本文档旨在帮助用户安装、使用以及深入了解 Redis::Dump 项目。以下为项目的安装指南、使用说明以及 API 使用文档。

1. 安装指南

Redis::Dump 项目可以通过以下几种方式安装：

Gemfile 中添加依赖：
```
gem 'redis-dump', '~> 0.4.0'
```
手动安装：
```
gem install redis-dump
```

使用 git 克隆仓库：

git clone git@github.com:delano/redis-dump.git

2. 使用说明

项目包含两个可执行文件：redis-dump 和 redis-load。

命令行用法：

# 默认运行 redis-dump
$ redis-dump

# 导出本地数据库到 JSON 文件
$ redis-dump -u 127.0.0.1:6379 > db_full.json
$ redis-dump -u 127.0.0.1:6379 -d 15 > db_db15.json

# 从 JSON 文件加载到本地数据库
$ < db_full.json redis-load
$ < db_db15.json redis-load -d 15
# 或者
$ cat db_full.json | redis-load
$ cat db_db15.json | redis-load -d 15

# 使用环境变量指定 Redis URI
$ export REDIS_URI=127.0.0.1:6379
$ redis-dump

# 如果你的 Redis 实例设置了密码，可以这样指定 Redis URL：
# :<password>@<domain>:<port>
# 注意，冒号用于指定没有用户名
$ redis-dump -u :234288a830f009980e08@example.redistogo.com:9055

输出格式：

所有 Redis 数据类型都会输出为一个简单的 JSON 对象。所有对象包含以下五个字段：

db (Integer)：数据库编号
key (String)：键名
ttl (Integer)：键的存活时间（秒）。如果没有设置过期时间，则为 -1。
type (String)：数据类型，可以是 string, list, set, zset, hash, none 之一。
value (String)：JSON 编码的值。对于 list, set, zset, 和 hash 类型的键，数据会有特定的结构（见下文）。

以下是每种数据类型的示例：

{"db":0,"key":"hashkey","ttl":-1,"type":"hash","value":{"field_a":"value_a","field_b":"value_b","field_c":"value_c"},"size":42}
{"db":0,"key":"listkey","ttl":-1,"type":"list","value":["value_0","value_1","value_2","value_0","value_1","value_2"],"size":42}
{"db":0,"key":"setkey","ttl":-1,"type":"set","value":["value_2","value_0","value_1","value_3"],"size":28}
{"db":0,"key":"zsetkey","ttl":-1,"type":"zset","value":[["value_0","100"],["value_1","100"],["value_2","200"],["value_3","300"],["value_4","400"]],"size":50}
{"db":0,"key":"stringkey","ttl":79,"type":"string","value":"stringvalue","size":11}