# cache-db
**Repository Path**: mirrors_yiisoft/cache-db
## Basic Information
- **Project Name**: cache-db
- **Description**: Yiisoft database adapter for cache
- **Primary Language**: Unknown
- **License**: BSD-3-Clause
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-19
- **Last Updated**: 2026-02-14
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
Yii Cache Library - DB Handler
[](https://packagist.org/packages/yiisoft/cache-db)
[](https://packagist.org/packages/yiisoft/cache-db)
[](https://codecov.io/gh/yiisoft/cache-db)
[](https://dashboard.stryker-mutator.io/reports/github.com/yiisoft/cache-db/master)
[](https://github.com/yiisoft/cache-db/actions?query=workflow%3A%22static+analysis%22)
[](https://shepherd.dev/github/yiisoft/cache-db)
This package implements database-based [PSR-16](https://www.php-fig.org/psr/psr-16/) cache.
## Supported databases
| Packages | PHP | Versions | CI-Actions |
|-------------------------------------------------------------|---------------|------------------|------------|
| [[db-mssql]](https://github.com/yiisoft/db-mssql) | **8.1 - 8.5** | **2017 - 2025** | [](https://github.com/yiisoft/cache-db/actions/workflows/mssql.yml) | |
| [[db-mysql]](https://github.com/yiisoft/db-mysql) (MySQL) | **8.1 - 8.5** | **5.7 - 9.5** | [](https://github.com/yiisoft/cache-db/actions/workflows/mysql.yml) |
| [[db-mysql]](https://github.com/yiisoft/db-mysql) (MariaDB) | **8.1 - 8.5** | **10.4 - 12.10** | [](https://github.com/yiisoft/cache-db/actions/workflows/mariadb.yml) |
| [[db-oracle]](https://github.com/yiisoft/db-oracle) | **8.1 - 8.5** | **11C - 21C** | [](https://github.com/yiisoft/cache-db/actions/workflows/oracle.yml) |
| [[db-pgsql]](https://github.com/yiisoft/db-pgsql) | **8.1 - 8.5** | **9.0 - 18.0** | [](https://github.com/yiisoft/cache-db/actions/workflows/pgsql.yml) |
| [[db-sqlite]](https://github.com/yiisoft/db-sqlite) | **8.1 - 8.5** | **3:latest** | [](https://github.com/yiisoft/cache-db/actions/workflows/sqlite.yml) |
## Requirements
- PHP 8.1 - 8.5.
- `PDO` PHP extension.
## Installation
The package could be installed with [Composer](https://getcomposer.org):
```shell
composer require yiisoft/cache-db
```
## Create database connection
For more information see [yiisoft/db](https://github.com/yiisoft/db/tree/master/docs/guide/en#create-connection).
## Database Preparing
Package provides two way for preparing database:
1. Raw SQL. You can use it with the migration package used in your application.
- Ensure tables:
- [MSSQL](sql/sqlsrv-up.sql),
- [MySQL / MariaDB](sql/mysql-up.sql),
- [Oracle](sql/oci-up.sql),
- [PostgreSQL](sql/pgsql-up.sql)
- [SQLite](sql/sqlite-up.sql)
- Ensure no tables:
- [MSSQL](sql/sqlsrv-down.sql),
- [MySQL / MariaDB](sql/mysql-down.sql),
- [Oracle](sql/oci-down.sql),
- [PostgreSQL](sql/pgsql-down.sql)
- [SQLite](sql/sqlite-down.sql)
2. `DbSchemaManager` for `ensureTable()`, `ensureNoTable()` methods for cache table (by default `{{%yii_cache}}`).
```php
// Create db schema manager
$dbSchemaManager = new DbSchemaManager($db);
// Ensure table with default name
$dbSchemaManager->ensureTable();
// Ensure table with custom name
$dbSchemaManager->ensureTable('{{%custom_cache_table}}');
// Ensure no table with default name
$dbSchemaManager->ensureNoTable();
// Ensure no table with custom name
$dbSchemaManager->ensureNoTable('{{%custom_cache_table}}');
```
## Configuration
When creating an instance of `\Yiisoft\Cache\Db\DbCache`, you must pass an instance of the database connection.
```php
$cache = new \Yiisoft\Cache\Db\DbCache($db, $table, $gcProbability);
```
- `$db (\Yiisoft\Db\Connection\ConnectionInterface)` - The database connection instance.
- `$table (string)` - The name of the database table to store the cache data. Defaults to "cache".
- `$gcProbability (int)` - The probability (parts per million) that garbage collection (GC) should
be performed when storing a piece of data in the cache. Defaults to 100, meaning 0.01% chance.
This number should be between 0 and 1000000. A value 0 meaning no GC will be performed at all.
## General usage
The package does not contain any additional functionality for interacting with the cache,
except those defined in the [PSR-16](https://www.php-fig.org/psr/psr-16/) interface.
```php
$cache = new \Yiisoft\Cache\Db\DbCache($db);
$parameters = ['user_id' => 42];
$key = 'demo';
// try retrieving $data from cache
$data = $cache->get($key);
if ($data === null) {
// $data is not found in cache, calculate it from scratch
$data = calculateData($parameters);
// store $data in cache for an hour so that it can be retrieved next time
$cache->set($key, $data, 3600);
}
// $data is available here
```
In order to delete value you can use:
```php
$cache->delete($key);
// Or all cache
$cache->clear();
```
To work with values in a more efficient manner, batch operations should be used:
- `getMultiple()`
- `setMultiple()`
- `deleteMultiple()`
This package can be used as a cache handler for the [Yii Caching Library](https://github.com/yiisoft/cache).
## Additional logging
In order to log details about failures you may set a logger instance. It should be `Psr\Log\LoggerInterface::class`. For example, you can use [yiisoft\Log](https://github.com/yiisoft/log):
```php
$cache = new \Yiisoft\Cache\Db\DbCache($db, $table, $gcProbability);
$cache->setLogger(new \Yiisoft\Log\Logger());
```
This allows you to log cache operations, when ocurring errors, etc.
## 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 Cache Library - DB Handler 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)