Taps 项目技术文档

1. 安装指南

安装步骤

1. 安装依赖：确保你的系统已经安装了Ruby环境。如果没有，请先安装Ruby。

2. 安装Taps：使用Ruby的包管理工具gem来安装Taps。

   gem install taps
   

3. 验证安装：安装完成后，可以通过以下命令验证Taps是否安装成功。

   taps --version
   

   如果显示版本号，说明安装成功。

2. 项目的使用说明

启动Taps服务器

要启动Taps服务器，使用以下命令：

taps server <数据库URL> <HTTP用户名> <HTTP密码>

例如，启动一个PostgreSQL数据库的Taps服务器：

taps server postgres://localdbuser:localdbpass@localhost/dbname httpuser httppassword

你还可以在数据库URL中指定编码：

taps server mysql://localdbuser:localdbpass@localhost/dbname?encoding=latin1 httpuser httppassword

客户端操作

拉取数据库

要从Taps服务器拉取数据库，使用以下命令：

taps pull <本地数据库URL> <Taps服务器URL>

例如：

taps pull postgres://dbuser:dbpassword@localhost/dbname http://httpuser:[e-mail]:5000

推送数据库

要将本地数据库推送到Taps服务器，使用以下命令：

taps push <本地数据库URL> <Taps服务器URL>

例如：

taps push postgres://dbuser:dbpassword@localhost/dbname http://httpuser:[e-mail]:5000

传输特定表

你可以指定要传输的表，使用--tables选项：

taps push postgres://dbuser:dbpassword@localhost/dbname http://httpuser:[e-mail]:5000 --tables logs,tags

使用过滤器传输表

你还可以使用正则表达式过滤器来传输以特定字符串开头的表：

taps push postgres://dbuser:dbpassword@localhost/dbname http://httpuser:[e-mail]:5000 --filter '^log_'

3. 项目API使用文档

服务器API

• 启动服务器：

  taps server <数据库URL> <HTTP用户名> <HTTP密码>
  

• 指定编码：

  taps server <数据库URL>?encoding=<编码> <HTTP用户名> <HTTP密码>
  

客户端API

• 拉取数据库：

  taps pull <本地数据库URL> <Taps服务器URL>
  

• 推送数据库：

  taps push <本地数据库URL> <Taps服务器URL>
  

• 传输特定表：

  taps push <本地数据库URL> <Taps服务器URL> --tables <表名1,表名2>
  

• 使用过滤器传输表：

  taps push <本地数据库URL> <Taps服务器URL> --filter <正则表达式>
  

4. 项目安装方式

使用RubyGems安装

Taps可以通过Ruby的包管理工具gem进行安装：

gem install taps

验证安装

安装完成后，可以通过以下命令验证Taps是否安装成功：

taps --version

如果显示版本号，说明安装成功。

5. 已知问题

• 外键约束丢失：在模式传输过程中，外键约束会丢失。
• 无主键表传输慢：没有主键的表传输速度会非常慢，因为查询中使用大偏移值效率低下。
• 多模式不支持：当前版本不支持多个模式的传输。

6. 维护与贡献

• 维护者：Ricardo Chimal, Jr. (ricardo at heroku dot com)
• 作者：Ricardo Chimal, Jr. 和 Adam Wiggins
• 早期研究与灵感：Blake Mizerany
• 许可证：MIT License

感谢Sequel库的支持，使得Taps工具成为可能。