Feather - a highly performant SQLite Cache Driver for Kirby
- unzip master.zip as folder
site/plugins/kirby3-sqlite-cachedriveror git submodule add https://github.com/bnomei/kirby3-sqlite-cachedriver.git site/plugins/kirby3-sqlite-cachedriverorcomposer require bnomei/kirby3-sqlite-cachedriver
Kirby ships with built-in support for File, Memcached, and APCu Cache Drivers. I created a Redis Cache Driver, which is best suited for larger caches. If your hosting does not support Memcached, APCu, or Redis, then your next best choice is this SQLite Cache Driver.
Let's imagine this typical scenario: During a single pageview, you need to access 100 cached values. Some of them already exist, some don't, some need to be refreshed, and yet others need to be deleted. A File Cache would cause at least 100 filesystem operations in total. Using this SQLite Cache you will have only one file read and one file write per pageview no matter how many values you get, update or remove. ✌️ However, reading and writing data to SQLite is not instantaneous so that it will be at least 35% faster.
$cache = \Bnomei\SQLiteCache::singleton(); // or
$cache = feather();
$cache->set('key', 'value', $expireInMinutes);
$value = feather()->get('key', $default);
feather()->remove('key');
feather()->flush();feather()->benchmark(1000);sqlite : 0.075334072113037
file : 0.11837792396545ATTENTION: This will create and remove a lot of cache files and sqlite entries
When Kirby's global debug config is set to true, the complete plugin cache will be flushed, and no caches will be read. But entries will be created. This will make you live easier – trust me.
You must set the cache driver for the lapse plugin to sqlite.
site/config/config.php
<?php
return [
'bnomei.lapse.cache' => ['type' => 'sqlite'],
'bnomei.boost.cache' => ['type' => 'sqlite'],
//... other options
];Use Kirby Boost to set up a cache for content files.
The plugin comes with aggressive defaults for SQLite Pragmas to optimize for performance. You can change these in the settings if you need to.
| bnomei.sqlite-cachedriver. | Default | Description |
|---|---|---|
| store | true |
keep accessed cache items stored in PHP memory for faster recurring access |
| store-ignore | `` | if key contains that string then ignore |
| pragmas-construct | callback |
array of pragma statements |
| pragmas-destruct | callback |
array of pragma statements |
- PHP SQLite extension. version 3.7.x or better.
This plugin is provided "as is" with no guarantee. Use it at your own risk and always test it yourself before using it in a production environment. If you find any issues, please create a new issue.
It is discouraged to use this plugin in any project that promotes racism, sexism, homophobia, animal abuse, violence or any other form of hate speech.