Ruby-MySQL 项目技术文档

2024-12-23 07:25:01作者：冯爽妲Honey

1. 安装指南

环境要求

Ruby 版本：2.5.0 或以上
MySQL 版本：5.7 或以上

安装步骤

克隆项目到本地：

git clone https://gitlab.com/tmtms/ruby-mysql.git

进入项目目录：
```
cd ruby-mysql
```
安装项目依赖：
```
gem install bundler
bundle install
```
确保你的 MySQL 服务已启动，并创建相应的数据库。
运行以下命令进行数据库迁移：
```
bundle exec rake db:migrate
```

2. 项目的使用说明

本项目是基于 Ruby 开发的一个 MySQL 连接库，用于在 Ruby 程序中连接和操作 MySQL 数据库。

连接数据库

首先，需要创建一个数据库连接对象：

require 'ruby-mysql'

db = Mysql.new('localhost', 'user', 'password', 'database')

执行 SQL 语句

可以通过以下方式执行 SQL 语句：

db.query("SELECT * FROM table_name")

获取查询结果

查询结果可以通过遍历返回的 Mysql::Result 对象来获取：

result = db.query("SELECT * FROM table_name")

result.each_hash do |row|
  puts row['column_name']
end

关闭数据库连接

在完成操作后，不要忘记关闭数据库连接：

db.close

3. 项目API使用文档

以下是本项目提供的部分 API 文档：

Mysql.new(host, username, password, database)

创建一个新的 MySQL 连接。

参数：

host: 数据库服务器的地址。
username: 数据库的用户名。
password: 数据库的密码。
database: 数据库名称。

返回值：一个新的 MySQL 连接对象。

db.query(sql)

执行一个 SQL 语句。

参数：

sql: 要执行的 SQL 语句。

返回值：一个 Mysql::Result 对象。

result.each_hash

遍历查询结果，返回每个记录的哈希表示。

参数：无。

返回值：当前记录的哈希表示。

db.close

关闭 MySQL 连接。