Mysql2 项目技术文档

1. 安装指南

通用安装说明

在Ruby环境中安装Mysql2库，您可以使用以下命令：

gem install mysql2

Mysql2库依赖于MySQL的libmysqlclient库或Connector/C库，以及兼容的替代品如MariaDB。您可能需要根据您的系统安装相应的开发包，例如libmariadb-dev、libmysqlclient-dev、mysql-devel或其他适合的包。

配置选项

您可以在安装时使用以下配置选项：

• --with-mysql-dir[=/path/to/mysqldir]：指定MySQL的安装目录。
• --with-mysql-config[=/path/to/mysql_config]：指定mysql_config的路径。
• --with-mysql-rpath=/path/to/mysql/lib / --without-mysql-rpath：覆盖运行时查找MySQL库的路径。
• --with-openssl-dir[=/path/to/openssl]：指定OpenSSL的安装目录。

根据操作系统安装

Linux 和其他 Unix 系统

您可能需要安装libmariadb-dev、libmysqlclient-dev、mysql-devel或default-libmysqlclient-dev包。请参考您的发行版的软件包指南。

Mac OS X

您可以使用Homebrew、MacPorts或原生MySQL安装包。如果尚未安装XCode选择工具，请运行以下命令：

xcode-select --install

在较新的MacOS版本中，不再提供可链接的OpenSSL库。您可以通过Homebrew或MacPorts安装OpenSSL。

Windows

确保已安装Ruby和DevKit编译器。我们推荐使用Ruby Installer。

2. 项目的使用说明

使用Mysql2库连接数据库、执行查询和迭代结果的基本方法如下：

client = Mysql2::Client.new(:host => "localhost", :username => "root")
results = client.query("SELECT * FROM users WHERE group='githubbers'")
results.each do |row|
  # 处理每一行结果
end

3. 项目API使用文档

Mysql2库提供了以下三个主要类：

• Mysql2::Client：用于连接数据库。
• Mysql2::Result：执行查询后返回的结果集，包含Enumerable模块。
• Mysql2::Statement：执行预处理语句后返回的对象。

连接数据库

client = Mysql2::Client.new(options)

options是一个包含数据库连接信息的哈希。

执行查询

results = client.query(sql, options)

sql是要执行的SQL语句，options是可选的查询选项。

使用预处理语句

statement = client.prepare("SELECT * FROM users WHERE login_count = ?")
result = statement.execute(1)

预处理语句使用?占位符，并在执行时提供具体的值。

获取字段信息

headers = results.fields
types = results.field_types

4. 项目安装方式

请参考上述“安装指南”部分，根据您的操作系统选择合适的方式进行安装。