1ff/laravel-mongodb-cache

A mongodb cache driver for laravel

7.0.0 2024-03-14 12:09 UTC

Requires

• php: ^8.2|^8.3
• illuminate/cache: ^11.0
• mongodb/laravel-mongodb: ^4.1

Requires (Dev)

• orchestra/testbench: ^9.0

MIT

• Vihren Ganev
• 1FF Team

README

A MongoDB cache driver for Laravel

Laravel Version	Package Version	Install using this command
11.x	7.x.x	composer require 1ff/laravel-mongodb-cache:^7.0
10.x	6.x.x	composer require 1ff/laravel-mongodb-cache:^6.0
9.x	5.x.x	composer require 1ff/laravel-mongodb-cache:^5.0
8.x	4.x.x	composer require 1ff/laravel-mongodb-cache:^4.1
7.x	3.x.x	composer require 1ff/laravel-mongodb-cache:^3.1
5.8.x, 6.x	2.12.x	composer require 1ff/laravel-mongodb-cache:~2.12.0
5.7.x	2.11.x	composer require 1ff/laravel-mongodb-cache:~2.11.0

Installation

Install using composer:

composer require 1ff/laravel-mongodb-cache

If you are using Laravel older than 5.5 add the service provider in config/app.php:

'ForFit\Mongodb\Cache\ServiceProvider::class',

Add the mongodb cache store in config/cache.php

'stores' => [
    ...

    'mongodb' => [
        'driver' => 'mongodb',
        'table' => 'cache', // name it as you wish
        'connection' => 'mongodb',
    ],
],

Add the mongodb database connection in config/database.php

'connections' => [
    ...

    'mongodb' => [
        'driver' => 'mongodb',
        'dsn' => env('MONGODB_DSN'),
        'database' => env('MONGODB_DATABASE'),
    ],
],

Update your .env file and change the CACHE_DRIVER to mongodb

CACHE_DRIVER=mongodb
MONGODB_DSN=mongodb://localhost:27017/laravel
MONGODB_DATABASE=laravel

Advantages

• This driver uses the MongoDB TTL indexes meaning when a cache key expires it will be automatically deleted.

• This way, the collection's size will remain around the size you expect and won't get falsely filled with unused data.

• The package automatically adds a migration which creates the index by running a mongodb command.

• This package also registers two new commands:

    php artisan mongodb:cache:index
  

  and

    php artisan mongodb:cache:dropindex
  

Warning

This cache driver is not compatible with other cache drivers because it encodes the data differently. If you are using another mongodb cache driver at the moment make sure you set a new collection for this one.

Enjoy!