SQLite3 Ruby 接口技术文档

1. 安装指南

1.1 使用 RubyGems 安装

要安装 sqlite3 库，您可以使用 RubyGems 进行安装。打开终端并运行以下命令：

gem install sqlite3

1.2 手动安装

如果您需要手动安装，可以按照以下步骤进行：

1. 下载源代码：
   • 源代码地址：https://github.com/sparklemotion/sqlite3-ruby
2. 解压下载的文件。
3. 进入解压后的目录，运行以下命令进行安装：

ruby setup.rb

1.3 依赖项

确保您的系统上已安装以下依赖项：

• Ruby 版本 >= 2.5.0
• SQLite 版本 >= 3.6.16

2. 项目使用说明

2.1 快速开始

以下是一个简单的示例，展示了如何使用 sqlite3 库在 Ruby 中操作 SQLite 数据库。

require "sqlite3"

# 打开一个数据库
db = SQLite3::Database.new "test.db"

# 创建一个表
rows = db.execute <<-SQL
  create table numbers (
    name varchar(30),
    val int
  );
SQL

# 执行一些插入操作
{
  "one" => 1,
  "two" => 2,
}.each do |pair|
  db.execute "insert into numbers values ( ?, ? )", pair
end

# 查找一些行
db.execute( "select * from numbers" ) do |row|
  p row
end
# => ["one", 1]
#    ["two", 2]

# 创建另一个表，包含多个列
db.execute <<-SQL
  create table students (
    name varchar(50),
    email varchar(50),
    grade varchar(5),
    blog varchar(50)
  );
SQL

# 执行带参数标记的插入操作
db.execute("INSERT INTO students (name, email, grade, blog)
            VALUES (?, ?, ?, ?)", ["Jane", "[e-mail]", "A", "http://blog.janedoe.com"])

db.execute( "select * from students" ) do |row|
  p row
end
# => ["Jane", "[e-mail]", "A", "http://blog.janedoe.com"]

2.2 线程安全

当 SQLite3.threadsafe? 返回 true 时，SQLite3 已编译为支持在多线程环境中运行。然而，这并不意味着 sqlite3 库中的所有类都是线程安全的。

• 当 SQLite3.threadsafe? 返回 true 时，可以安全地在多个线程之间共享 SQLite3::Database 实例，而无需提供自己的锁定机制。
• 其他实例（如 SQLite3::Statement）可以在多个线程之间共享，但需要您提供自己的锁定机制以确保线程安全。

3. 项目API使用文档

3.1 SQLite3::Database

SQLite3::Database 类封装了与 SQLite3 数据库的单个连接。以下是一些常用的 API：

• new(filename)：打开一个数据库文件。
• execute(sql)：执行 SQL 语句。
• prepare(sql)：准备一个 SQL 语句。

3.2 SQLite3::Statement

SQLite3::Statement 类表示一个已准备但未执行的 SQL 查询。以下是一些常用的 API：

• execute(*bind_vars)：执行准备好的 SQL 语句。
• columns：返回查询结果的列名。
• each：遍历查询结果。

3.3 SQLite3::ResultSet

SQLite3::ResultSet 类封装了查询结果的可枚举性。以下是一些常用的 API：

• each：遍历结果集。
• each_hash：将每一行作为哈希返回。
• close：关闭结果集。

4. 项目安装方式

4.1 通过 RubyGems 安装

最简单的安装方式是通过 RubyGems 安装：

gem install sqlite3

4.2 手动安装

如果您需要手动安装，可以按照以下步骤进行：

1. 下载源代码。
2. 解压文件。
3. 运行安装命令：

ruby setup.rb

4.3 依赖项

确保您的系统上已安装以下依赖项：

• Ruby 版本 >= 2.5.0
• SQLite 版本 >= 3.6.16

通过以上步骤，您可以成功安装并使用 sqlite3 库在 Ruby 中操作 SQLite 数据库。