Rufus-Tokyo 技术文档

1. 安装指南

Rufus-Tokyo 是一个基于 ruby-ffi 的接口，用于访问 Tokyo Cabinet 和 Tokyo Tyrant。在安装之前，请确保系统中已安装了ruby和ffi库。

以下是安装 Rufus-Tokyo 的步骤：

sudo gem install rufus-tokyo --source http://gemcutter.org

如果需要安装 Tokyo Cabinet 和 Tokyo Tyrant，请参考以下链接获取安装指南：http://openwferu.rubyforge.org/tokyo.html

2. 项目的使用说明

Rufus-Tokyo 提供了两个模块：Rufus::Tokyo 和 Rufus::Edo。Rufus::Tokyo 通过 ruby-ffi 使用了 Hirabayashi-san 的 C 库，而 Rufus::Edo 则封装了 Tokyo Cabinet/Tyrant 作者的原始 C 绑定。

以下是使用 Rufus-Tokyo 的基本示例：

TC Abstract API

require 'rubygems'
require 'rufus/tokyo'

db = Rufus::Tokyo::Cabinet.new('data.tch')
db['nada'] = 'surf'
p db['nada'] # => 'surf'
p db['lost'] # => nil
5000.times { |i| db[i.to_s] = "x" }
p db.inject { |r, (k, v)| k } # => 4999
db.close

TC Table API

require 'rubygems'
require 'rufus/tokyo'

t = Rufus::Tokyo::Table.new('table.tct')
t['pk0'] = { 'name' => 'alfred', 'age' => '22' }
t['pk1'] = { 'name' => 'bob', 'age' => '18' }
t['pk2'] = { 'name' => 'charly', 'age' => '45' }
t['pk3'] = { 'name' => 'doug', 'age' => '77' }
t['pk4'] = { 'name' => 'ephrem', 'age' => '32' }

p t.query { |q|
  q.add_condition 'age', :numge, '32'
  q.order_by 'age'
}
# => [...] 结果省略 ...
t.close

TT remote db

# 启动 ttserver
ttserver -port 45001 data.tch

# Ruby 代码
require 'rubygems'
require 'rufus/tokyo/tyrant'

db = Rufus::Tokyo::Tyrant.new('localhost', 45001)
db['nada'] = 'surf'
p db['nada'] # => 'surf'
p db['lost'] # => nil
db.close

TT remote table

# 启动 ttserver
ttserver -port 45002 data.tct

# Ruby 代码
require 'rubygems'
require 'rufus/tokyo/tyrant'

t = Rufus::Tokyo::TyrantTable.new('localhost', 45002)
t['pk0'] = { 'name' => 'alfred', 'age' => '22' }
t['pk1'] = { 'name' => 'bob', 'age' => '18' }
t['pk2'] = { 'name' => 'charly', 'age' => '45' }
t['pk3'] = { 'name' => 'doug', 'age' => '77' }
t['pk4'] = { 'name' => 'ephrem', 'age' => '32' }

p t.query { |q|
  q.add_condition 'age', :numge, '32'
  q.order_by 'age'
}
# => [...] 结果省略 ...
t.close

3. 项目API使用文档

关于项目API的详细文档，可以访问以下链接：

• Rufus::Tokyo::Cabinet API
• Rufus::Tokyo::Table API
• Rufus::Tokyo::Tyrant API
• Rufus::Tokyo::TyrantTable API

4. 项目安装方式

请参考本文档的“安装指南”部分，安装方式如下：

sudo gem install rufus-tokyo --source http://gemcutter.org

确保在安装前系统中已安装了ruby和ffi库。