aqamarine/laravel-query-cache

Based on 'miradnan/laravel-model-caching' package which stores cache for database query and automatically cleans it after Creating or Updating Laravel model.

dev-master 2022-04-09 09:27 UTC

Requires

• php: ^7.3|^8.0
• illuminate/database: ^6.0|^7.30|^8.0|^9.0
• illuminate/support: ^6.0|^7.30|^8.0|^9.0

MIT

• Aqamarine228

README

Based on miradnan/laravel-model-caching package which stores cache for database query and automatically cleans it after Creating or Updating Laravel model.

Installation

Using the package manager composer.

$ composer require aqamarine/laravel-query-cache

Usage

for package to work your cache driver has to support 'tags'

Add QueryCacheable trait to make model cachable.

use Aqamarine228\LaravelQueryCache\QueryCacheable;

class Categories extends Model
{
    use QueryCacheable;

    ...
}

In order to cache all model queries you need to set '$cacheFor' model property.

public $cacheFor = 3600;

Or you can cache only specific queries as in example below.

$category = Category::cacheFor(60 * 60)->first();
// or
$category = Category::cacheForever()->first();

// Using a DateTime instance like Carbon works perfectly fine!
$category = Category::cacheFor(now()->addDays(1))->first();

Cache Tags

This package automatically adds table name tag to every caching query, but you can customise this behavior by setting 'cacheTags' model property.

public $cacheTags = ['customTag'];

It will replace every caching query default tag with property value.

Alternately you can use tags as it says in miradnan/laravel-model-caching README

if used in builder query, as in example below, cache won't be cleaned automatically

$shelfOneBooks = Book::whereShelf(1)->cacheFor(60)->cacheTags(['shelf:1'])->get();

so you need to clean it manually

Book::flushQueryCache(['shelf:1']);

Relationship Caching, Cache Keys, Cache Drivers, Disable caching & Equivalent Methods and Variables

Topics are the same as in miradnan/laravel-model-caching README.

Customisation

Because in this package is used only some parts of miradnan/laravel-model-caching package all customisation possibilities are cut off.

Possible conflicts

Package QueryCacheable Trait rewrites deleted and saved model events and uses custom CacheBuilder. So every package that does the same thing will conflict. In order to avoid conflict you should use miradnan/laravel-model-caching package because of it's better flexibility.

License

MIT