Soli Db
Soli Db 提供了一个简单、易用的数据库工具包。, (*1)
目录
安装
使用 composer 安装到你的项目：, (*2)
composer require soliphp/db
配置信息
Soli Db 采用 dsn 的方式配置连接信息，例如下面的格式：, (*3)
mysql:host=localhost;port=3307;dbname=testdb;charset=utf8
mysql:unix_socket=/tmp/mysql.sock;dbname=testdb;charset=utf8
sqlite:/opt/databases/mydb.sq3
...
完整的配置信息，如：, (*4)
$dbConfig = [
'dsn' => 'mysql:host=192.168.56.102;dbname=test;charset=utf8',
'username' => 'username',
'password' => 'password',
'options' => [
PDO::ATTR_TIMEOUT => 2,
PDO::ATTR_DEFAULT_FETCH_MODE => PDO::FETCH_OBJ,
// PDO::ATTR_* ...
],
];
使用 Connection
将配置信息 $dbConfig 传入 \Soli\Db\Connection 的构造参数即可：, (*5)
$db = new \Soli\Db\Connection($dbConfig);
$result = $db->query("SELECT * FROM test");
var_dump($result);
Connection 四个重要的方法
Connection 的核心方法 query() 作用为执行一条 SQL 语句:, (*6)
query($sql, $binds = [], $fetchMode = 'column|row|all')
首先 query() 方法允许参数绑定，其次可以通过不同的 $fetchMode
返回相应的数据结果（如：返回所有行、一行或一个字段），
另外 query() 方法执行不同类型的 SQL 时，会自动返回对应类型的执行结果：, (*7)
INSERT 返回插入数据的主键ID
DELETE 返回影响行数
UPDATE 返回影响行数
SELECT 根据 column|row|all 返回对应的数据结果
基于查询数据时，对返回数据结果的要求不同，Connection 直接提供了对应 column|row|all
三个参数值的三个方法，便于我们直接使用：, (*8)
queryAll($sql, $binds = []) 获取多条数据
queryRow($sql, $binds = []) 获取一条数据
queryColumn($sql, $binds = []) 获取一个字段
自动重连
在执行SQL的过程中，我们不必关心由于连接丢失导致执行失败的问题。, (*9)
程序将自动执行重连操作，并自动执行失败的SQL。, (*10)
使用事务
$db = new \Soli\Db\Connection($config);
$db->beginTrans()
$deleted = $db->query("DELETE FROM course WHERE student_id = 101");
if ($deleted === false) {
$db->rollBack();
}
$deleted = $db->query("DELETE FROM student WHERE student_id = 101");
if ($deleted === false) {
$db->rollBack();
}
$db->commit();
配置多数据库连接
我们这里使用依赖注入容器作为多数据库连接的管理工具，如下配置一个 user_db 和一个 order_db：, (*11)
$container = new \Soli\Di\Container();
$container->set('db', function () { //db
return new \Soli\Db\Connection($defaultDbConfig);
});
$container->set('user_db', function () { //user_db
return new \Soli\Db\Connection($userDbConfig);
});
$container->set('order_db', function () { //order_db
return new \Soli\Db\Connection($orderDbConfig);
});
这个配置会在下面 Model 中使用。, (*12)
使用 Model
假设有一个 user 表，结构为：, (*13)
CREATE TABLE `user` (
`id` int(11) unsigned NOT NULL AUTO_INCREMENT,
`name` varchar(20) NOT NULL DEFAULT '',
`age` tinyint(3) unsigned NOT NULL DEFAULT '0',
`email` varchar(30) NOT NULL DEFAULT '',
`created_at` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP,
PRIMARY KEY (`id`)
)
以下文档中使用到的查询基于此表结构。, (*14)
定义模型
use Soli\Db\Model;
class User extends Model
{
}
这样就完成了一个模型的定义，现在如果我们直接使用这个 User 模型，如：, (*15)
// 查询主键为 101 的用户
$user = User::findFirst(101);
将默认使用容器中以 db 命名的数据库连接服务（也就是上面 //db 行，所设置的服务），且操作的表名为 user。, (*16)
我们也可以为模型指定数据库连接，和表名。, (*17)
指定数据库连接服务
通过 protected $connection 属性来设置：, (*18)
/**
* 当前模型访问的数据库连接服务名称
*/
protected $connection = 'user_db';
此时我们使用 User 模型时，访问的是容器中以 user_db 命名的数据库连接服务（也就是上面 //User_db 行，所设置的服务）。, (*19)
指定表名
通过 protected $table 属性来设置：, (*20)
/**
* 当前模型操作的表名
*/
protected $table = 'xxx_user';
此时我们使用 User 模型时，操作的表名为 xxx_user。, (*21)
指定主键
通过 protected $primaryKey 属性来设置，默认主键为 id：, (*22)
/**
* 当前模型所操作表的主键
*/
protected $primaryKey = 'xxx_id';
instance 方法
模型提供了 instance() 方法，供外部程序获取模型实例，如：, (*23)
// 获取表名
User::instance()->table();
// 通过 email 获取用户信息
User::instance()->findByEmail('ueaner@gmail.com');
新增数据 create
新增数据，返回插入的主键值，需要将主键设置为自增。, (*24)
$data = [
'name' => 'ueaner',
'age' => 28,
'email' => 'ueaner@gmail.com'
];
// 新增用户
$userId = User::create($data);
编辑数据 update
编辑数据，返回影响行数。, (*25)
$data = [
'name' => 'ueaner',
'age' => 28,
'email' => ':email'
];
// 编辑用户ID为 101 的用户信息
$rowCount = User::update($data, 101);
// 编辑年龄大于 20 的用户信息
$rowCount = User::update($data, 'age > 20');
// 参数绑定
$binds = [
':email' => 'ueaner@soliphp.com',
':created_at' => '2015-10-27 08:36:42'
];
$rowCount = User::update($data, 'created_at = :created_at', $binds);
保存数据 save
假设 user 表的主键是 id，如果保存的数据中有主键，则按主键更新，否则新增一条数据, (*26)
$data = [
'id' => 101, // 保存的数据中有主键，则按主键更新，否则新增一条数据
'name' => 'ueaner',
'age' => 28,
'email' => ':email'
];
$binds = [
':email' => 'ueaner@gmail.com',
':created_at' => '2015-10-27 08:36:42'
];
$rowCount = User::save($data);
// 相当于：
$rowCount = User::update($data, 12);
删除数据 delete
删除数据，返回影响行数。, (*27)
// 1. 删除主键为 123 的纪录
User::delete(123);
// 2. 按传入的条件删除
User::delete("age > 20 and email == ''");
// 3. 按传入的条件删除, 并过滤传入的删除条件
$binds = [':created_at' => '2015-10-27 07:16:16'];
User::delete("created_at < :created_at", $binds);
查询数据
find 和 findFirst
find 和 findFirst 同时适用于以下方式：, (*28)
// 1. 获取全部纪录
User::find();
// 2. 获取主键为 123 的纪录
User::find(123);
// 3. 按传入的条件查询
User::find("age > 20 and email == ''");
// 4. 按传入的条件查询, 并过滤传入的查询条件
$binds = [':created_at' => '2015-10-27 07:16:16'];
User::find("created_at < :created_at", $binds);
唯一的不同是：, (*29)
find 获取的是一个记录列表
findFirst 获取的是一条记录
以下 find* 和 findFirst* 开头的函数区别也是如此。, (*30)
findById
顾名思义通过ID（主键）获取一条记录。, (*31)
// 获取用户ID为 123 的用户信息
User::findById(123);
findByIds
通过一个ID列表（主键列表）获取相应的记录。, (*32)
// 获取用户ID为 123 和 456 的用户信息
User::findByIds([123, 456]);
findByColumn 和 findFirstByColumn
findByColumn / findFirstByColumn 通过某一个字段获取数据。, (*33)
其中的 Column 为表中的字段名，如果字段名带有下划线转为驼峰即可。, (*34)
// 获取 name 为 'ueaner' 的所有用户记录
User::findByName('ueaner');
// 通过 email 字段获取用户信息
User::findFirstByEmail('ueaner@gmail.com');
// 通过 create_at 字段获取用户信息
User::findByCreatedAt('2015-10-27 07:16:16');
MIT License
MIT Public License, (*35)
Wallogit.com
ueaner