yiisoft/cache-db

Yii Caching Library - DB Handler

dev-master / 3.0.x-dev 2022-01-12 15:41 UTC

This package is auto-updated.

Last update: 2022-01-12 15:43:30 UTC


README

68747470733a2f2f796969736f66742e6769746875622e696f2f646f63732f696d616765732f7969695f6c6f676f2e737667

Yii Cache Library - DB Handler


Latest Stable Version Total Downloads Scrutinizer Code Quality Code Coverage Mutation testing badge static analysis type-coverage

This package implements database-based PSR-16 cache.

Support databases:

Packages PHP Versions CI-Actions
[db-mssql] 7.4 - 8.0 2017 - 2019 mssql
[db-mysql] 7.4 - 8.0 5.7 - 8.0 mysql
[db-oracle] 7.4 - 8.0 11c - 12c oracle
[db-pgsql] 7.4 - 8.0 9.0 - 14.0 pgsql
[db-sqlite] 7.4 - 8.0 3:latest sqlite

Installation

The package could be installed with composer:

composer require yiisoft/cache-db

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

The package does not contain any additional functionality for interacting with the cache, except those defined in the 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.

Unit testing

The package is tested with PHPUnit. To run tests:

./vendor/bin/phpunit

Mutation testing

The package tests are checked with Infection mutation framework. To run it:

./vendor/bin/infection

Static analysis

The code is statically analyzed with Psalm. To run static analysis:

./vendor/bin/psalm

Support the project

Open Collective

Follow updates

Official website Twitter Telegram Facebook Slack

License

The Yii Cache Library - DB Handler is free software. It is released under the terms of the BSD License. Please see LICENSE for more information.

Maintained by Yii Software.