PHPackages yiisoft/cache-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/cache-db ActiveLibrary[Framework](/categories/framework) yiisoft/cache-db ================ Yii Caching Library - DB Handler 1.1.0(5mo ago)136.6k↓15%7[1 PRs](https://github.com/yiisoft/cache-db/pulls)BSD-3-ClausePHPPHP 8.1 - 8.5CI passing Since Apr 22Pushed 3mo ago14 watchersCompare [ Source](https://github.com/yiisoft/cache-db)[ Packagist](https://packagist.org/packages/yiisoft/cache-db)[ Docs](https://www.yiiframework.com/)[ GitHub Sponsors](https://github.com/sponsors/yiisoft)[ OpenCollective](https://opencollective.com/yiisoft)[ RSS](/packages/yiisoft-cache-db/feed)WikiDiscussions master Synced 1mo ago READMEChangelog (2)Dependencies (12)Versions (6)Used By (0) [ ![Yii](https://camo.githubusercontent.com/8317c17418b39410a660f5149071d26c5023c0d5fb2b7ebb771324812f666d73/68747470733a2f2f796969736f66742e6769746875622e696f2f646f63732f696d616765732f7969695f6c6f676f2e737667) ](https://github.com/yiisoft) Yii Cache Library - DB Handler ============================== [](#yii-cache-library---db-handler) [![Latest Stable Version](https://camo.githubusercontent.com/46ee908fc5df63790be6eeece231e1fe08e9071a6590b745be495d0e5940331a/68747470733a2f2f706f7365722e707567782e6f72672f796969736f66742f63616368652d64622f762f737461626c652e706e67)](https://packagist.org/packages/yiisoft/cache-db)[![Total Downloads](https://camo.githubusercontent.com/1785b9574c6cfbb382277294264f85e2339403c7857746d35f33d973c9171c0b/68747470733a2f2f706f7365722e707567782e6f72672f796969736f66742f63616368652d64622f646f776e6c6f6164732e706e67)](https://packagist.org/packages/yiisoft/cache-db)[![codecov](https://camo.githubusercontent.com/1b6c1ceb64eb104318299367cc96ffa98028642f954ca23bea72a4779a79fdc6/68747470733a2f2f636f6465636f762e696f2f67682f796969736f66742f63616368652d64622f6272616e63682f6d61737465722f67726170682f62616467652e7376673f746f6b656e3d483759414c4d4b31594e)](https://codecov.io/gh/yiisoft/cache-db)[![Mutation testing badge](https://camo.githubusercontent.com/cee11822ea80f6fa3be0b202760d0e3574e2f76725daafd5cd2ce84a74a1b0a1/68747470733a2f2f696d672e736869656c64732e696f2f656e64706f696e743f7374796c653d666c61742675726c3d687474707325334125324625324662616467652d6170692e737472796b65722d6d757461746f722e696f2532466769746875622e636f6d253246796969736f667425324663616368652d64622532466d6173746572)](https://dashboard.stryker-mutator.io/reports/github.com/yiisoft/cache-db/master)[![static analysis](https://github.com/yiisoft/cache-db/workflows/static%20analysis/badge.svg)](https://github.com/yiisoft/cache-db/actions?query=workflow%3A%22static+analysis%22)[![type-coverage](https://camo.githubusercontent.com/570f62d0c6c3591af115bb0006c63596429c0b13717cfcc4bf3dada6b255ca63/68747470733a2f2f73686570686572642e6465762f6769746875622f796969736f66742f63616368652d64622f636f7665726167652e737667)](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 ------------------- [](#supported-databases) PackagesPHPVersionsCI-Actions[\[db-mssql\]](https://github.com/yiisoft/db-mssql)**8.1 - 8.5****2017 - 2025**[![mssql](https://github.com/yiisoft/cache-db/actions/workflows/mssql.yml/badge.svg)](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**[![mysql](https://github.com/yiisoft/cache-db/actions/workflows/mysql.yml/badge.svg)](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**[![mariadb](https://github.com/yiisoft/cache-db/actions/workflows/mariadb.yml/badge.svg)](https://github.com/yiisoft/cache-db/actions/workflows/mariadb.yml)[\[db-oracle\]](https://github.com/yiisoft/db-oracle)**8.1 - 8.5****11C - 21C**[![oracle](https://github.com/yiisoft/cache-db/actions/workflows/oracle.yml/badge.svg)](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**[![pgsql](https://github.com/yiisoft/cache-db/actions/workflows/pgsql.yml/badge.svg)](https://github.com/yiisoft/cache-db/actions/workflows/pgsql.yml)[\[db-sqlite\]](https://github.com/yiisoft/db-sqlite)**8.1 - 8.5****3:latest**[![sqlite](https://github.com/yiisoft/cache-db/actions/workflows/sqlite.yml/badge.svg)](https://github.com/yiisoft/cache-db/actions/workflows/sqlite.yml)Requirements ------------ [](#requirements) - PHP 8.1 - 8.5. - `PDO` PHP extension. Installation ------------ [](#installation) The package could be installed with [Composer](https://getcomposer.org): ``` composer require yiisoft/cache-db ``` Create database connection -------------------------- [](#create-database-connection) For more information see [yiisoft/db](https://github.com/yiisoft/db/tree/master/docs/guide/en#create-connection). Database Preparing ------------------ [](#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}}`). ``` // 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 ------------- [](#configuration) When creating an instance of `\Yiisoft\Cache\Db\DbCache`, you must pass an instance of the database connection. ``` $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 ------------- [](#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. ``` $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: ``` $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 ------------------ [](#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): ``` $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 ------------- [](#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 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 ------------------- [](#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 97% of packages Maintenance77 Regular maintenance activity Popularity34 Limited adoption so far Community26 Small or concentrated contributor base Maturity66 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 Every ~952 days Total 2 Last Release 153d ago PHP version history (2 changes)1.0.0PHP ^8.0 1.1.0PHP 8.1 - 8.5 ### 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) --- Top Contributors [![samdark](https://avatars.githubusercontent.com/u/47294?v=4)](https://github.com/samdark "samdark (25 commits)")[![terabytesoftw](https://avatars.githubusercontent.com/u/42547589?v=4)](https://github.com/terabytesoftw "terabytesoftw (22 commits)")[![devanych](https://avatars.githubusercontent.com/u/20116244?v=4)](https://github.com/devanych "devanych (11 commits)")[![vjik](https://avatars.githubusercontent.com/u/525501?v=4)](https://github.com/vjik "vjik (11 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (7 commits)")[![xepozz](https://avatars.githubusercontent.com/u/6815714?v=4)](https://github.com/xepozz "xepozz (5 commits)")[![batyrmastyr](https://avatars.githubusercontent.com/u/9303221?v=4)](https://github.com/batyrmastyr "batyrmastyr (4 commits)")[![mspirkov](https://avatars.githubusercontent.com/u/63721828?v=4)](https://github.com/mspirkov "mspirkov (2 commits)")[![luizcmarin](https://avatars.githubusercontent.com/u/67489841?v=4)](https://github.com/luizcmarin "luizcmarin (2 commits)")[![sankaest](https://avatars.githubusercontent.com/u/21160342?v=4)](https://github.com/sankaest "sankaest (1 commits)")[![darkdef](https://avatars.githubusercontent.com/u/8342004?v=4)](https://github.com/darkdef "darkdef (1 commits)") --- Tags cachedatabasehacktoberfestyii3frameworkcachepsr-16dbyii ### Code Quality TestsPHPUnit Static AnalysisPsalm, Rector Type Coverage Yes ### Embed Badge ![Health badge](/badges/yiisoft-cache-db/health.svg) ``` [![Health](https://phpackages.com/badges/yiisoft-cache-db/health.svg)](https://phpackages.com/packages/yiisoft-cache-db) ``` ### Alternatives [laravel/framework The Laravel Framework. 34.7k509.9M17.0k](/packages/laravel-framework)[cakephp/cakephp The CakePHP framework 8.8k18.5M1.6k](/packages/cakephp-cakephp)[shopware/platform The Shopware e-commerce core 3.3k1.5M3](/packages/shopware-platform)[nutgram/nutgram The Telegram bot library that doesn't drive you nuts 714214.9k8](/packages/nutgram-nutgram)[yiisoft/cache-file Yii Caching Library - File Handler 13685.3k9](/packages/yiisoft-cache-file)[yiisoft/cache Yii Caching Library 48887.6k21](/packages/yiisoft-cache) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)