Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dwightwatson/rememberable
Query caching for Laravel
https://github.com/dwightwatson/rememberable
caching eloquent laravel php
Last synced: 27 days ago
JSON representation
Query caching for Laravel
- Host: GitHub
- URL: https://github.com/dwightwatson/rememberable
- Owner: dwightwatson
- License: mit
- Created: 2015-03-08T23:56:11.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2024-06-13T22:18:01.000Z (5 months ago)
- Last Synced: 2024-10-01T14:04:46.671Z (about 1 month ago)
- Topics: caching, eloquent, laravel, php
- Language: PHP
- Homepage:
- Size: 47.9 KB
- Stars: 1,120
- Watchers: 29
- Forks: 96
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
- laravel-awesome - Rememberable - Query caching for Laravel 5 (eloquent) (Popular Packages)
- awesome-laravel - Rememberable - Query caching for Eloquent (Popular Packages)
README
Rememberable, Laravel 5 query cache
===================================
[](https://packagist.org/packages/watson/rememberable)
[](https://packagist.org/packages/watson/rememberable)
[](https://packagist.org/packages/watson/rememberable)
[](https://packagist.org/packages/watson/rememberable)
Rememberable is an Eloquent trait for Laravel that adds `remember()` query methods. This makes it super easy to cache your query results for an adjustable amount of time.
```php
// Get a the first user's posts and remember them for a day.
User::first()->remember(now()->addDay())->posts()->get();
// You can also pass the number of seconds if you like (before Laravel 5.8 this will be interpreted as minutes).
User::first()->remember(60 * 60 * 24)->posts()->get();
```
It works by simply remembering the SQL query that was used and storing the result. If the same query is attempted while the cache is persisted it will be retrieved from the store instead of hitting your database again.
## Installation
Install using Composer, just as you would anything else.
```sh
composer require watson/rememberable
```
The easiest way to get started with Eloquent is to create an abstract `App\Model` which you can extend your application models from. In this base model you can import the rememberable trait which will extend the same caching functionality to any queries you build off your model.
```php
count();
```
### Cache tags
If you want to tag certain queries you can add `cacheTags('tag_name')` to your query. Please notice that cache tags are not supported by all cache drivers.
```php
// Remember the number of users for an hour and tag it with 'user_queries'
User::remember(60 * 60)->cacheTags('user_queries')->count();
```
### Cache prefix
If you want a unique prefix added to the cache key for each of your queries (say, if your cache doesn't support tagging), you can add `prefix('prefix')` to your query.
```php
// Remember the number of users for an hour and prefix the key with 'users'
User::remember(60 * 60)->prefix('users')->count();
```
Alternatively, you can add the `$rememberCachePrefix` property to your model to always use that cache prefix.
### Cache driver
If you want to use a custom cache driver (defined in config/cache.php) you can add `cacheDriver('cacheDriver')` to your query.
```php
// Remember the number of users for an hour using redis as cache driver
User::remember(60 * 60)->cacheDriver('redis')->count();
```
Alternatively, you can add the `$rememberCacheDriver` property to your model to always use that cache driver.
#### Model wide cache tag
You can set a cache tag for all queries of a model by setting the `$rememberCacheTag` property with an unique string that should be used to tag the queries.
### Relationships
Validating works by caching queries on a query-by-query basis. This means that when you perform eager-loading those additional queries will not be cached as well unless explicitly specified. You can do that by using a callback with your eager-loads.
```php
$users = User::where("id", ">", "1")
->with(['posts' => function ($q) { $q->remember(60 * 60); }])
->remember(60 * 60)
->take(5)
->get();
```
### Always enable
You can opt-in to cache all queries of a model by setting the `$rememberFor` property with the number of seconds you want to cache results for. Use this feature with caution as it could lead to unexpected behaviour and stale data in your app if you're not familiar with how it works.
### Cache flushing
Based on the architecture of the package it's not possible to delete the cache for a single query. But if you tagged any queries using cache tags, you are able to flush the cache for the tag:
```php
User::flushCache('user_queries');
```
If you used the `$rememberCacheTag` property you can use the method without a parameter and the caches for the tag set by `$rememberCacheTag` are flushed:
```php
User::flushCache();
```
### Skipping cache
If you need to disable cache for a particular query, you can use the `dontRemember` method:
```php
User::latest()->dontRemember()->get();
```