flexihash / flexihash
Flexihash is a small PHP library which implements consistent hashing
Installs: 576 139
Dependents: 5
Suggesters: 0
Security: 0
Stars: 368
Watchers: 42
Forks: 84
Open Issues: 4
Requires
- php: >=7.2.0
Requires (Dev)
- php-coveralls/php-coveralls: ^2.2
- phpunit/phpunit: ^8
- squizlabs/php_codesniffer: 3.*
- symfony/config: ^5.1.3
- symfony/console: ^5.1.3
- symfony/filesystem: ^5.1.3
- symfony/stopwatch: ^5.1.3
- symfony/yaml: ^5.1.3
This package is not auto-updated.
Last update: 2024-04-19 02:02:42 UTC
README
Flexihash is a small PHP library which implements consistent hashing, which is most useful in distributed caching. It requires PHP5 and uses PHPUnit for unit testing.
Installation
Composer is the recommended installation technique. You can find flexihash on Packagist so installation is as easy as
composer require flexihash/flexihash
or in your composer.json
{
"require": {
"flexihash/flexihash": "^3.0.0"
}
}
Usage
$hash = new Flexihash(); // bulk add $hash->addTargets(['cache-1', 'cache-2', 'cache-3']); // simple lookup $hash->lookup('object-a'); // "cache-1" $hash->lookup('object-b'); // "cache-2" // add and remove $hash ->addTarget('cache-4') ->removeTarget('cache-1'); // lookup with next-best fallback (for redundant writes) $hash->lookupList('object', 2); // ["cache-2", "cache-4"] // remove cache-2, expect object to hash to cache-4 $hash->removeTarget('cache-2'); $hash->lookup('object'); // "cache-4"
Tests
Unit Test
% vendor/bin/phpunit
Benchmark Test
% vendor/bin/phpunit tests/BenchmarkTest.php