PHPackages soliphp/db - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Database & ORM](/categories/database) 4. / 5. soliphp/db ActiveLibrary[Database & ORM](/categories/database) soliphp/db ========== Soli Database v1.2.0(7y ago)112911MITPHPPHP >=7.0 Since Dec 15Pushed 7y ago1 watchersCompare [ Source](https://github.com/soliphp/db)[ Packagist](https://packagist.org/packages/soliphp/db)[ Docs](https://github.com/soliphp/db)[ RSS](/packages/soliphp-db/feed)WikiDiscussions master Synced 3d ago READMEChangelog (3)Dependencies (2)Versions (4)Used By (1) Soli Db ------- [](#soli-db) Soli Db 提供了一个简单、易用的数据库工具包。 目录 -- [](#目录) - [安装](#%E5%AE%89%E8%A3%85) - [配置信息](#%E9%85%8D%E7%BD%AE%E4%BF%A1%E6%81%AF) - [使用 Connection](#%E4%BD%BF%E7%94%A8-connection) - [Connection 四个重要的方法](#connection-%E5%9B%9B%E4%B8%AA%E9%87%8D%E8%A6%81%E7%9A%84%E6%96%B9%E6%B3%95) - [自动重连](#%E8%87%AA%E5%8A%A8%E9%87%8D%E8%BF%9E) - [使用事务](#%E4%BD%BF%E7%94%A8%E4%BA%8B%E5%8A%A1) - [配置多数据库连接](#%E9%85%8D%E7%BD%AE%E5%A4%9A%E6%95%B0%E6%8D%AE%E5%BA%93%E8%BF%9E%E6%8E%A5) - [使用 Model](#%E4%BD%BF%E7%94%A8-model) - [定义模型](#%E5%AE%9A%E4%B9%89%E6%A8%A1%E5%9E%8B) - [指定数据库连接服务](#%E6%8C%87%E5%AE%9A%E6%95%B0%E6%8D%AE%E5%BA%93%E8%BF%9E%E6%8E%A5%E6%9C%8D%E5%8A%A1) - [指定表名](#%E6%8C%87%E5%AE%9A%E8%A1%A8%E5%90%8D) - [指定主键](#%E6%8C%87%E5%AE%9A%E4%B8%BB%E9%94%AE) - [instance 方法](#instance-%E6%96%B9%E6%B3%95) - [新增数据 create](#%E6%96%B0%E5%A2%9E%E6%95%B0%E6%8D%AE-create) - [编辑数据 update](#%E7%BC%96%E8%BE%91%E6%95%B0%E6%8D%AE-update) - [保存数据 save](#%E4%BF%9D%E5%AD%98%E6%95%B0%E6%8D%AE-save) - [删除数据 delete](#%E5%88%A0%E9%99%A4%E6%95%B0%E6%8D%AE-delete) - [查询数据](#%E6%9F%A5%E8%AF%A2%E6%95%B0%E6%8D%AE) - [find 和 findFirst](#find-%E5%92%8C-findfirst) - [findById](#findbyid) - [findByIds](#findbyids) - [findByColumn 和 findFirstByColumn](#findbycolumn-%E5%92%8C-findfirstbycolumn) - [MIT License](#mit-license) 安装 -- [](#安装) 使用 `composer` 安装到你的项目： ``` composer require soliphp/db ``` 配置信息 ---- [](#配置信息) Soli Db 采用 `dsn` 的方式配置连接信息，例如下面的格式： ``` mysql:host=localhost;port=3307;dbname=testdb;charset=utf8 mysql:unix_socket=/tmp/mysql.sock;dbname=testdb;charset=utf8 sqlite:/opt/databases/mydb.sq3 ... ``` 完整的配置信息，如： ``` $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 ------------- [](#使用-connection) 将配置信息 `$dbConfig` 传入 `\Soli\Db\Connection` 的构造参数即可： ``` $db = new \Soli\Db\Connection($dbConfig); $result = $db->query("SELECT * FROM test"); var_dump($result); ``` ### Connection 四个重要的方法 [](#connection-四个重要的方法) Connection 的核心方法 `query()` 作用为执行一条 SQL 语句: ``` query($sql, $binds = [], $fetchMode = 'column|row|all') ``` 首先 `query()` 方法允许参数绑定，其次可以通过不同的 $fetchMode 返回相应的数据结果（如：返回所有行、一行或一个字段）， 另外 `query()` 方法执行不同类型的 SQL 时，会自动返回对应类型的执行结果： ``` INSERT 返回插入数据的主键ID DELETE 返回影响行数 UPDATE 返回影响行数 SELECT 根据 column|row|all 返回对应的数据结果 ``` 基于查询数据时，对返回数据结果的要求不同，Connection 直接提供了对应 column|row|all 三个参数值的三个方法，便于我们直接使用： ``` queryAll($sql, $binds = []) 获取多条数据 queryRow($sql, $binds = []) 获取一条数据 queryColumn($sql, $binds = []) 获取一个字段 ``` ### 自动重连 [](#自动重连) 在执行SQL的过程中，我们不必关心由于连接丢失导致执行失败的问题。 程序将自动执行重连操作，并自动执行失败的SQL。 使用事务 ---- [](#使用事务) ``` $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(); ``` 配置多数据库连接 -------- [](#配置多数据库连接) 我们这里使用[依赖注入容器](https://github.com/soliphp/di)作为多数据库连接的管理工具，如下配置一个 `user_db` 和一个 `order_db`： ``` $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` 中使用。 使用 Model -------- [](#使用-model) 假设有一个 `user` 表，结构为： ``` 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`) ) ``` 以下文档中使用到的查询基于此表结构。 ### 定义模型 [](#定义模型) ``` use Soli\Db\Model; class User extends Model { } ``` 这样就完成了一个模型的定义，现在如果我们直接使用这个 `User` 模型，如： ``` // 查询主键为 101 的用户 $user = User::findFirst(101); ``` 将默认使用容器中以 `db` 命名的数据库连接服务（也就是上面 `//db` 行，所设置的服务），且操作的表名为 `user`。 我们也可以为模型指定数据库连接，和表名。 ### 指定数据库连接服务 [](#指定数据库连接服务) 通过 protected $connection 属性来设置： ``` /** * 当前模型访问的数据库连接服务名称 */ protected $connection = 'user_db'; ``` 此时我们使用 User 模型时，访问的是容器中以 `user_db` 命名的数据库连接服务（也就是上面 `//User_db` 行，所设置的服务）。 ### 指定表名 [](#指定表名) 通过 protected $table 属性来设置： ``` /** * 当前模型操作的表名 */ protected $table = 'xxx_user'; ``` 此时我们使用 User 模型时，操作的表名为 `xxx_user`。 ### 指定主键 [](#指定主键) 通过 protected $primaryKey 属性来设置，默认主键为 `id`： ``` /** * 当前模型所操作表的主键 */ protected $primaryKey = 'xxx_id'; ``` ### instance 方法 [](#instance-方法) 模型提供了 `instance()` 方法，供外部程序获取模型实例，如： ``` // 获取表名 User::instance()->table(); // 通过 email 获取用户信息 User::instance()->findByEmail('ueaner@gmail.com'); ``` ### 新增数据 create [](#新增数据-create) 新增数据，返回插入的主键值，需要将主键设置为自增。 ``` $data = [ 'name' => 'ueaner', 'age' => 28, 'email' => 'ueaner@gmail.com' ]; // 新增用户 $userId = User::create($data); ``` ### 编辑数据 update [](#编辑数据-update) 编辑数据，返回影响行数。 ``` $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 [](#保存数据-save) 假设 user 表的主键是 `id`，如果保存的数据中有主键，则按主键更新，否则新增一条数据 ``` $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 [](#删除数据-delete) 删除数据，返回影响行数。 ``` // 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) `find` 和 `findFirst` 同时适用于以下方式： ``` // 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); ``` 唯一的不同是： ``` find 获取的是一个记录列表 findFirst 获取的是一条记录 ``` 以下 `find*` 和 `findFirst*` 开头的函数区别也是如此。 #### findById [](#findbyid) 顾名思义通过ID（主键）获取一条记录。 ``` // 获取用户ID为 123 的用户信息 User::findById(123); ``` #### findByIds [](#findbyids) 通过一个ID列表（主键列表）获取相应的记录。 ``` // 获取用户ID为 123 和 456 的用户信息 User::findByIds([123, 456]); ``` #### findBy*Column* 和 findFirstBy*Column* [](#findbycolumn-和-findfirstbycolumn) findBy*Column* / findFirstBy*Column* 通过某一个字段获取数据。 其中的 *Column* 为表中的字段名，如果字段名带有下划线转为驼峰即可。 ``` // 获取 name 为 'ueaner' 的所有用户记录 User::findByName('ueaner'); // 通过 email 字段获取用户信息 User::findFirstByEmail('ueaner@gmail.com'); // 通过 create_at 字段获取用户信息 User::findByCreatedAt('2015-10-27 07:16:16'); ``` MIT License ----------- [](#mit-license) MIT Public License ### Health Score 28 — LowBetter than 54% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity12 Limited adoption so far Community10 Small or concentrated contributor base Maturity60 Established project with proven stability Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~107 days Total 3 Last Release 2858d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/a27fefc1f3d6ee23049e1d5f8e81f34c8ff055a3849524f18bfb56b816f43382?d=identicon)[ueaner](/maintainers/ueaner) --- Top Contributors [![ueaner](https://avatars.githubusercontent.com/u/318253?v=4)](https://github.com/ueaner "ueaner (8 commits)") --- Tags databasemodeldbsoliphp ### Embed Badge ![Health badge](/badges/soliphp-db/health.svg) ``` [![Health](https://phpackages.com/badges/soliphp-db/health.svg)](https://phpackages.com/packages/soliphp-db) ``` ### Alternatives [moloquent/moloquent A MongoDB based Eloquent model and Query builder for Laravel (Moloquent) 120114.6k7](/packages/moloquent-moloquent)[symlex/doctrine-active-record Object-oriented CRUD for Doctrine DBAL 308.7k2](/packages/symlex-doctrine-active-record)[lastzero/doctrine-active-record Object-oriented CRUD for Doctrine DBAL 306.0k](/packages/lastzero-doctrine-active-record)[craftcms/fix-fks Restore missing foreign key constraints in the database. 1217.4k](/packages/craftcms-fix-fks) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)