# data-db
**Repository Path**: mirrors_yiisoft/data-db
## Basic Information
- **Project Name**: data-db
- **Description**: Database adapter for data interfaces
- **Primary Language**: Unknown
- **License**: BSD-3-Clause
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-10-22
- **Last Updated**: 2026-02-07
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
Yii Data DB
[](https://packagist.org/packages/yiisoft/data-db)
[](https://packagist.org/packages/yiisoft/data-db)
[](https://codecov.io/gh/yiisoft/data-db)
[](https://dashboard.stryker-mutator.io/reports/github.com/yiisoft/data-db/master)
[](https://github.com/yiisoft/data-db/actions/workflows/static.yml?query=branch%3Amaster)
[](https://shepherd.dev/github/yiisoft/data-db)
[](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:
| RDBMS | Status |
|----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| SQLite | [](https://github.com/yiisoft/data-db/actions/workflows/sqlite.yml?query=branch%3Amaster) |
| MySQL | [](https://github.com/yiisoft/data-db/actions/workflows/mysql.yml?query=branch%3Amaster) |
| PostgreSQL | [](https://github.com/yiisoft/data-db/actions/workflows/pgsql.yml?query=branch%3Amaster) |
| Microsoft SQL Server | [](https://github.com/yiisoft/data-db/actions/workflows/mssql.yml?query=branch%3Amaster) |
| Oracle | [](https://github.com/yiisoft/data-db/actions/workflows/oracle.yml?query=branch%3Amaster) |
## Requirements
- PHP 8.1 - 8.5.
## Installation
The package could be installed with [Composer](https://getcomposer.org):
```shell
composer require yiisoft/data-db
```
## General usage
The `QueryDataReader` wraps a database query to provide a flexible data reading interface:
```php
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
Map data reader field names to database columns:
```php
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
Process large datasets in batches to reduce memory usage:
```php
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
- [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
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
[](https://opencollective.com/yiisoft)
## Follow updates
[](https://www.yiiframework.com/)
[](https://twitter.com/yiiframework)
[](https://t.me/yii3en)
[](https://www.facebook.com/groups/yiitalk)
[](https://yiiframework.com/go/slack)