PHPackages                             yiisoft/data-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. [Framework](/categories/framework)
4. /
5. yiisoft/data-db

ActiveLibrary[Framework](/categories/framework)

yiisoft/data-db
===============

Database query adapter for Yii Data

1.0.0(6mo ago)147.9k↑60.2%3[2 issues](https://github.com/yiisoft/data-db/issues)[1 PRs](https://github.com/yiisoft/data-db/pulls)2BSD-3-ClausePHPPHP 8.1 - 8.5CI passing

Since Oct 18Pushed 3d ago13 watchersCompare

[ Source](https://github.com/yiisoft/data-db)[ Packagist](https://packagist.org/packages/yiisoft/data-db)[ Docs](https://www.yiiframework.com/)[ GitHub Sponsors](https://github.com/sponsors/yiisoft)[ OpenCollective](https://opencollective.com/yiisoft)[ RSS](/packages/yiisoft-data-db/feed)WikiDiscussions master Synced 2d ago

READMEChangelog (1)Dependencies (17)Versions (5)Used By (2)

 [ ![Yii](https://camo.githubusercontent.com/8317c17418b39410a660f5149071d26c5023c0d5fb2b7ebb771324812f666d73/68747470733a2f2f796969736f66742e6769746875622e696f2f646f63732f696d616765732f7969695f6c6f676f2e737667) ](https://github.com/yiisoft)

Yii Data DB
===========

[](#yii-data-db)

[![Latest Stable Version](https://camo.githubusercontent.com/11df111bd7e53ea5b5cc783d930b7c84252175a38b5713e840c55379d6e0a471/68747470733a2f2f706f7365722e707567782e6f72672f796969736f66742f646174612d64622f76)](https://packagist.org/packages/yiisoft/data-db)[![Total Downloads](https://camo.githubusercontent.com/4f5ce4e531c2d46399aa500a5ba643346e295432529e440a0843cd7cd375cc1a/68747470733a2f2f706f7365722e707567782e6f72672f796969736f66742f646174612d64622f646f776e6c6f616473)](https://packagist.org/packages/yiisoft/data-db)[![Code Coverage](https://camo.githubusercontent.com/7533f1fe863662508ad090d73b60a7cdc709e3f23749501119bb9498418c85e6/68747470733a2f2f636f6465636f762e696f2f67682f796969736f66742f646174612d64622f67726170682f62616467652e7376673f746f6b656e3d39716c664761346b4931)](https://codecov.io/gh/yiisoft/data-db)[![Mutation testing badge](https://camo.githubusercontent.com/8bfa336633f83cb22313e45fc07abf4855daa9b85a52ab5e7cfb0a4cb9da02cb/68747470733a2f2f696d672e736869656c64732e696f2f656e64706f696e743f7374796c653d666c61742675726c3d687474707325334125324625324662616467652d6170692e737472796b65722d6d757461746f722e696f2532466769746875622e636f6d253246796969736f6674253246646174612d64622532466d6173746572)](https://dashboard.stryker-mutator.io/reports/github.com/yiisoft/data-db/master)[![Static analysis](https://github.com/yiisoft/data-db/actions/workflows/static.yml/badge.svg?branch=master)](https://github.com/yiisoft/data-db/actions/workflows/static.yml?query=branch%3Amaster)[![type-coverage](https://camo.githubusercontent.com/605eaec2b17d6598254ca0a6eac6cac5710a1a420755f516cf382ca039bcb4dd/68747470733a2f2f73686570686572642e6465762f6769746875622f796969736f66742f646174612d64622f636f7665726167652e737667)](https://shepherd.dev/github/yiisoft/data-db)[![psalm-level](https://camo.githubusercontent.com/0b8d4fd92a0e63fafdbcd289d9c4284377439cc145c230dd739f1253ec1274cb/68747470733a2f2f73686570686572642e6465762f6769746875622f796969736f66742f646174612d64622f6c6576656c2e737667)](https://shepherd.dev/github/yiisoft/data-db)

The package provides [data reader](https://github.com/yiisoft/data?tab=readme-ov-file#reading-data) implementation based on [Yii DB](https://github.com/yiisoft/db) query and a set of DB-specific filters.

Detailed build statuses:

RDBMSStatusSQLite[![SQLite status](https://github.com/yiisoft/data-db/actions/workflows/sqlite.yml/badge.svg?branch=master)](https://github.com/yiisoft/data-db/actions/workflows/sqlite.yml?query=branch%3Amaster)MySQL[![MySQL status](https://github.com/yiisoft/data-db/actions/workflows/mysql.yml/badge.svg?branch=master)](https://github.com/yiisoft/data-db/actions/workflows/mysql.yml?query=branch%3Amaster)PostgreSQL[![PostgreSQL status](https://github.com/yiisoft/data-db/actions/workflows/pgsql.yml/badge.svg?branch=master)](https://github.com/yiisoft/data-db/actions/workflows/pgsql.yml?query=branch%3Amaster)Microsoft SQL Server[![Microsoft SQL Server status](https://github.com/yiisoft/data-db/actions/workflows/mssql.yml/badge.svg?branch=master)](https://github.com/yiisoft/data-db/actions/workflows/mssql.yml?query=branch%3Amaster)Oracle[![Oracle status](https://github.com/yiisoft/data-db/actions/workflows/oracle.yml/badge.svg?branch=master)](https://github.com/yiisoft/data-db/actions/workflows/oracle.yml?query=branch%3Amaster)Requirements
------------

[](#requirements)

- PHP 8.1 - 8.5.

Installation
------------

[](#installation)

The package could be installed with [Composer](https://getcomposer.org):

```
composer require yiisoft/data-db
```

General usage
-------------

[](#general-usage)

The `QueryDataReader` wraps a database query to provide a flexible data reading interface:

```
use Yiisoft\Data\Db\QueryDataReader;
use Yiisoft\Data\Reader\Filter\Equals;
use Yiisoft\Data\Reader\Filter\GreaterThan;
use Yiisoft\Data\Reader\Filter\Like;
use Yiisoft\Data\Reader\Filter\AndX;
use Yiisoft\Data\Reader\Sort;
use Yiisoft\Db\Query\Query;

$query = (new Query($db))->from('customer');
$dataReader = new QueryDataReader($query);

// Iterate through results
foreach ($dataReader->read() as $customer) {
    // ... process each customer ...
}

// Read a single record
$customer = $dataReader->readOne();

// Get total count
$total = $dataReader->count();

// Sorting
$sort = Sort::any(['name', 'email'])->withOrderString('-name,email');
$dataReader = $dataReader->withSort($sort);

// Filtering
$filter = new AndX(
    new Equals('status', 'active'),
    new GreaterThan('age', 18),
    new Like('name', 'John')
);
$dataReader = $dataReader->withFilter($filter);

// Pagination
$dataReader = $dataReader
    ->withOffset(20)
    ->withLimit(10);
```

### Field mapping

[](#field-mapping)

Map data reader field names to database columns:

```
use Yiisoft\Data\Db\QueryDataReader;
use Yiisoft\Data\Reader\Filter\Equals;

$dataReader = new QueryDataReader(
    query: $query,
    fieldMapper: [
        'userName' => 'user_name',
        'createdAt' => 'created_at',
    ]
);

// Now you can filter and sort by 'userName' and it will use 'user_name' column
$filter = new Equals('userName', 'admin');
```

### Batch processing

[](#batch-processing)

Process large datasets in batches to reduce memory usage:

```
use Yiisoft\Data\Db\QueryDataReader;

$dataReader = new QueryDataReader($query);
$dataReader = $dataReader->withBatchSize(100);

foreach ($dataReader->read() as $item) {
    // Items are fetched in batches of 100
}
```

Documentation
-------------

[](#documentation)

- [Internals](docs/internals.md)

If you need help or have a question, the [Yii Forum](https://forum.yiiframework.com/c/yii-3-0/63) is a good place for that. You may also check out other [Yii Community Resources](https://www.yiiframework.com/community).

License
-------

[](#license)

The Yii Data DB is free software. It is released under the terms of the BSD License. Please see [`LICENSE`](./LICENSE.md) for more information.

Maintained by [Yii Software](https://www.yiiframework.com/).

Support the project
-------------------

[](#support-the-project)

[![Open Collective](https://camo.githubusercontent.com/a2b15f8e2268d4e3842e00d41ff7a57cce2ad8bd8d8769c5dc4fa05a546a4f62/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4f70656e253230436f6c6c6563746976652d73706f6e736f722d3765616466313f6c6f676f3d6f70656e253230636f6c6c656374697665266c6f676f436f6c6f723d376561646631266c6162656c436f6c6f723d353535353535)](https://opencollective.com/yiisoft)

Follow updates
--------------

[](#follow-updates)

[![Official website](https://camo.githubusercontent.com/d6b0929173e28cc627430d2519ca1853466a70f37395877eaf4820cb3e1e1909/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f506f77657265645f62792d5969695f4672616d65776f726b2d677265656e2e7376673f7374796c653d666c6174)](https://www.yiiframework.com/)[![Twitter](https://camo.githubusercontent.com/d077c362ac639792171af8bc002ee827816733dfc0925f70b557e6d151022226/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f747769747465722d666f6c6c6f772d3144413146323f6c6f676f3d74776974746572266c6f676f436f6c6f723d314441314632266c6162656c436f6c6f723d3535353535353f7374796c653d666c6174)](https://twitter.com/yiiframework)[![Telegram](https://camo.githubusercontent.com/4e38dd12535575c39c65bea7119b95e663abb2d1f4e3d669a27bbda07ef603f0/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f74656c656772616d2d6a6f696e2d3144413146323f7374796c653d666c6174266c6f676f3d74656c656772616d)](https://t.me/yii3en)[![Facebook](https://camo.githubusercontent.com/48204e301b34b29b0815854544f04c337fc0692096cab35e9a1f8c53a42c2307/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f66616365626f6f6b2d6a6f696e2d3144413146323f7374796c653d666c6174266c6f676f3d66616365626f6f6b266c6f676f436f6c6f723d666666666666)](https://www.facebook.com/groups/yiitalk)[![Slack](https://camo.githubusercontent.com/1a3645ba1c97e6684d0349bc478201e1621ba0d3efad516d81035364d442bad7/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f736c61636b2d6a6f696e2d3144413146323f7374796c653d666c6174266c6f676f3d736c61636b)](https://yiiframework.com/go/slack)

###  Health Score

53

—

FairBetter than 96% of packages

Maintenance82

Actively maintained with recent releases

Popularity34

Limited adoption so far

Community29

Small or concentrated contributor base

Maturity60

Established project with proven stability

 Bus Factor2

2 contributors hold 50%+ of commits

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

Unknown

Total

1

Last Release

202d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/261a6249c6f605f3956a2fae40fbb813f6b2e1e6f2bf806180c851a965426e54?d=identicon)[cebe](/maintainers/cebe)

![](https://www.gravatar.com/avatar/fc29e4e7068a00fe9b9db37b8aadda1db6020adcacef810461e47b99c2b150e6?d=identicon)[samdark](/maintainers/samdark)

![](https://www.gravatar.com/avatar/ccb75e3312d6bd454ea445ea308139fd185a4ca906ca5df21cc66e6a35de25a3?d=identicon)[SilverFire](/maintainers/SilverFire)

![](https://www.gravatar.com/avatar/99106256c24a8cb23871b99fa90e48f37f1aa71608c185759b7d2a88683a5918?d=identicon)[hiqsol](/maintainers/hiqsol)

![](https://www.gravatar.com/avatar/53e5ee1dedd50f71e4aeeac2929f786cdfb400359d4776e6cd806388d0d5df2c?d=identicon)[vjik](/maintainers/vjik)

---

Top Contributors

[![vjik](https://avatars.githubusercontent.com/u/525501?v=4)](https://github.com/vjik "vjik (56 commits)")[![Tigrov](https://avatars.githubusercontent.com/u/8563175?v=4)](https://github.com/Tigrov "Tigrov (10 commits)")[![Gerych1984](https://avatars.githubusercontent.com/u/90403480?v=4)](https://github.com/Gerych1984 "Gerych1984 (10 commits)")[![samdark](https://avatars.githubusercontent.com/u/47294?v=4)](https://github.com/samdark "samdark (9 commits)")[![arogachev](https://avatars.githubusercontent.com/u/8326201?v=4)](https://github.com/arogachev "arogachev (7 commits)")[![devanych](https://avatars.githubusercontent.com/u/20116244?v=4)](https://github.com/devanych "devanych (7 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (7 commits)")[![StyleCIBot](https://avatars.githubusercontent.com/u/11048387?v=4)](https://github.com/StyleCIBot "StyleCIBot (5 commits)")[![luizcmarin](https://avatars.githubusercontent.com/u/67489841?v=4)](https://github.com/luizcmarin "luizcmarin (3 commits)")[![xepozz](https://avatars.githubusercontent.com/u/6815714?v=4)](https://github.com/xepozz "xepozz (2 commits)")[![sankaest](https://avatars.githubusercontent.com/u/21160342?v=4)](https://github.com/sankaest "sankaest (2 commits)")[![terabytesoftw](https://avatars.githubusercontent.com/u/42547589?v=4)](https://github.com/terabytesoftw "terabytesoftw (1 commits)")

---

Tags

datadatabasedbhacktoberfestyii3databasedbdata provider

###  Code Quality

TestsPHPUnit

Static AnalysisPsalm, Rector

Code StylePHP CS Fixer

Type Coverage Yes

### Embed Badge

![Health badge](/badges/yiisoft-data-db/health.svg)

```
[![Health](https://phpackages.com/badges/yiisoft-data-db/health.svg)](https://phpackages.com/packages/yiisoft-data-db)
```

###  Alternatives

[cakephp/database

Flexible and powerful Database abstraction library with a familiar PDO-like API

9826.4M47](/packages/cakephp-database)[yiisoft/active-record

Active record pattern implementation

12297.0k15](/packages/yiisoft-active-record)[yiisoft/db-mysql

MySQL/MariaDB driver for Yii Database

43184.0k24](/packages/yiisoft-db-mysql)[yiisoft/db-pgsql

PostgreSQL driver for Yii Database

42174.0k10](/packages/yiisoft-db-pgsql)[yiisoft/db-sqlite

SQLite driver for Yii Database

32198.2k22](/packages/yiisoft-db-sqlite)[yiisoft/db-oracle

Oracle driver for Yii Database

3464.7k7](/packages/yiisoft-db-oracle)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)