webmozart/key-value-store

A key-value store API with implementations for different backends.

Webmozart Key-Value-Store

, _(*1)

Latest release: 1.0.0, _(*2)

A key-value store API with implementations for different backends., _(*3)

API Documentation, _(*4)

All contained key-value stores implement the interface [KeyValueStore]. The following stores are currently supported:, _(*5)

• [ArrayStore]
• [DbalStore]
• [JsonFileStore]
• [MongoDbStore]
• [NullStore]
• [PhpRedisStore]
• [PredisStore]
• [RiakStore]

The interface [CountableStore] is supported by the following classes:, _(*6)

• [ArrayStore]
• [JsonFileStore]
• [NullStore]
• [CountableDecorator]

The interface [SortableStore] is supported by the following classes:, _(*7)

• [ArrayStore]
• [JsonFileStore]
• [NullStore]
• [SortableDecorator]

The decorator [CachingDecorator] exists for caching another store instance in a Doctrine cache., _(*8)

FAQ

Why not use Doctrine Cache?, _(*9)

Caching is not key-value storage. When you use a cache, you accept that keys may disappear for various reasons:, _(*10)

• Keys may expire.
• Keys may be overwritten when the cache is full.
• Keys may be lost after shutdowns.
• ...

In another word, caches are volatile. This is not a problem, since the cached data is usually stored safely somewhere else. The point of a cache is to provide high-performance access to frequently needed data., _(*11)

Key-value stores, on the other hand, are persistent. When you write a key to a key-value store, you expect it to be there until you delete it. It would be a disaster if data would silently disappear from a key-value store (or any other kind of database)., _(*12)

Hence the two libraries fulfill two very different purposes, even if their interfaces and implementations are often similar., _(*13)

The [CachingDecorator] actually uses a Doctrine Cache object to cache the data of a persistent [KeyValueStore]., _(*14)

Authors

• Bernhard Schussek a.k.a. @webmozart
• The Community Contributors

Installation

Use Composer to install the package:, _(*15)

$ composer require webmozart/key-value-store

Contribute

Contributions to the package are always welcome!, _(*16)

• Report any bugs or issues you find on the issue tracker.
• You can grab the source code at the package's Git repository.

Support

If you are having problems, send a mail to bschussek@gmail.com or shout out to @webmozart on Twitter., _(*17)

License

All contents of this package are licensed under the MIT license., _(*18)