Redis-namespace 项目技术文档

本文档将详细介绍如何使用和安装 Redis-namespace 项目，帮助用户更好地理解和应用该项目。

1. 安装指南

Redis-namespace 项目被打包为 redis-namespace gem，托管在 rubygems.org 上。以下是安装步骤：

• 命令行安装：

  $ gem install redis-namespace
  

• Gemfile 配置：

  将以下内容添加到你的 Gemfile 文件中：

  gem 'redis-namespace'
  

  然后运行 bundle install 命令。

2. 项目使用说明

Redis-namespace 提供了一个接口，用于访问 Redis 数据库中命名空间（namespace）内的键集合（例如，具有共同前缀的键）。它依赖于 redis-rb gem。

以下是一个使用示例：

require 'redis-namespace'

redis_connection = Redis.new
namespaced_redis = Redis::Namespace.new(:ns, redis: redis_connection)

namespaced_redis.set('foo', 'bar')
# 输出: "OK"

# Redis::Namespace 会自动在键名前加上命名空间
namespaced_redis.get('foo')
# 输出: "bar"

redis_connection.get('foo')
# 输出: nil

redis_connection.get('ns:foo')
# 输出: "bar"

namespaced_redis.del('foo')
# 输出: 1

namespaced_redis.get('foo')
# 输出: nil

redis_connection.get('ns:foo')
# 输出: nil

Redis-namespace 也支持使用 Proc 作为命名空间，它将在运行时使用返回的字符串作为命名空间：

redis_connection = Redis.new
namespaced_redis = Redis::Namespace.new(Proc.new { Tenant.current_tenant }, redis: redis_connection)

3. 项目API使用文档

Redis-namespace 继承了 redis-rb gem 的方法，并自动在键名前加上命名空间。以下是部分方法的使用示例：

• set(key, value)：设置键值对。
• get(key)：获取键的值。
• del(key)：删除键。

所有 redis-rb 支持的方法都可以通过 namespaced_redis 对象调用，命名空间会自动添加到键名上。

4. 项目安装方式

项目的安装方式已在安装指南部分详细说明，请参考上文。

---

以上就是关于 Redis-namespace 项目的技术文档，希望对用户使用和理解该项目有所帮助。