https://github.com/bnomei/kirby3-sqlite-cachedriver
Kirby 3 SQLite Cache-Driver
https://github.com/bnomei/kirby3-sqlite-cachedriver
cache key key-value kirby3 kirby3-cms kirby3-plugin performance pragma sqlite transactions value wal
Last synced: about 1 year ago
JSON representation
Kirby 3 SQLite Cache-Driver
- Host: GitHub
- URL: https://github.com/bnomei/kirby3-sqlite-cachedriver
- Owner: bnomei
- License: mit
- Created: 2020-09-05T09:27:47.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-07-17T14:54:58.000Z (almost 4 years ago)
- Last Synced: 2024-10-11T03:05:05.237Z (over 1 year ago)
- Topics: cache, key, key-value, kirby3, kirby3-cms, kirby3-plugin, performance, pragma, sqlite, transactions, value, wal
- Language: PHP
- Homepage:
- Size: 85.9 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# đĒļ Kirby SQLite Cache-Driver
[](https://discordapp.com/users/bnomei)
[](https://www.buymeacoffee.com/bnomei)
Feather - a highly performant SQLite Cache Driver for Kirby
## Installation
- unzip [master.zip](https://github.com/bnomei/kirby3-sqlite-cachedriver/archive/master.zip) as folder `site/plugins/kirby3-sqlite-cachedriver` or
- `git submodule add https://github.com/bnomei/kirby3-sqlite-cachedriver.git site/plugins/kirby3-sqlite-cachedriver` or
- `composer require bnomei/kirby3-sqlite-cachedriver`
## Why
### Memcached < File < Redis < SQLite < APCu
Kirby ships with built-in support for File, Memcached, and APCu Cache Drivers. I created a [Redis Cache Driver](https://github.com/bnomei/kirby3-redis-cachedriver), 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.
### 2 is enough and about 35% faster
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](https://www.hwaci.com/sw/sqlite/fasterthanfs.html).
## Usage
### Cache methods
```php
$cache = \Bnomei\SQLiteCache::singleton(); // or
$cache = feather();
$cache->set('key', 'value', $expireInMinutes);
$value = feather()->get('key', $default);
feather()->remove('key');
feather()->flush();
```
### Benchmark
```php
feather()->benchmark(1000);
```
```shell script
sqlite : 0.075334072113037
file : 0.11837792396545
```
> ATTENTION: This will create and remove a lot of cache files and sqlite entries
### No cache when debugging
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.
### How to use Feather with Lapse or Boost
You must set the cache driver for the [lapse plugin](https://github.com/bnomei/kirby3-lapse) to `sqlite`.
**site/config/config.php**
```php
['type' => 'sqlite'],
'bnomei.boost.cache' => ['type' => 'sqlite'],
//... other options
];
```
### Setup Content-File Cache
Use [Kirby Boost](https://github.com/bnomei/kirby3-boost) to set up a cache for content files.
### Pragmas
The plugin comes with aggressive defaults for SQLite Pragmas to optimize for performance. You can change these in the settings if you need to.
## Settings
| 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 |
## Dependencies
- PHP SQLite extension. version 3.7.x or better.
## Disclaimer
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](https://github.com/bnomei/kirby3-sqlite-cachedriver/issues/new).
## License
[MIT](https://opensource.org/licenses/MIT)
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.