dox_cache 3.0.0-alpha.13

Cache for Dart and the Dox framework. Memory, file and Redis drivers, TTL, locks, tags and remember helpers.

dox_cache

Cache for Dart with memory, file and Redis drivers. It works like Laravel Cache.

Part of Dox, a web backend framework for Dart, like Laravel. Source code: github.com/dartondox/dox.

Install

dart pub add dox_cache

Dox 3.x is in alpha (3.0.0-alpha.x). The API can still change before the stable release.

Use it

import 'package:dox_cache/dox_cache.dart';

void main() async {
  CacheManager cache = CacheManager(CacheConfig(
    defaultStore: 'memory',
    stores: <String, Map<String, dynamic>>{
      'memory': <String, dynamic>{'driver': 'memory', 'max_size': 1000},
      'file': <String, dynamic>{'driver': 'file', 'path': 'storage/cache'},
      'redis': <String, dynamic>{'driver': 'redis', 'host': '127.0.0.1', 'prefix': 'app:'},
    },
  ));

  CacheStore store = cache.store(); // the default store
  await store.put('a', 1, Duration(minutes: 5));
  print(await store.get('a')); // 1

  List<dynamic> posts = await store.remember('posts', Duration(minutes: 10), () async {
    return <dynamic>['first post'];
  });
  print(posts);
}

In a Dox app you do not set this up yourself. Set the stores in config/cache.dart and use Cache().

Features

• Drivers: memory (with an optional LRU size limit), file, redis and null.
• get, put, add, forget, many, putMany, increment, pull, remember.
• Tags: store.tags(['users']).flush() removes only those items.
• Atomic locks with lock(name, ttl): get(), release(), block(timeout). Memory and Redis only.
• A key prefix per store. Redis flush deletes only keys with the prefix.
• Your own driver with cache.extend(name, factory).

Values must be JSON types: Map, List, String, num, bool, null. The memory store lives in one isolate. Use redis when isolates or servers must share data.

Documentation

• Cache package
• Cache in a Dox app
• API reference

License

MIT. See LICENSE.