spiral / roadrunner-kv

v4.5.0 2026-10-10 13:16 UTC

Requires

• php: >=8.2
• ext-json: *
• psr/simple-cache: 2 - 3
• roadrunner/api-dto: ^2.1
• roadrunner/goridge: ^4.5
• spiral/roadrunner: ^3.0

Requires (Dev)

• spiral/code-style: ^2.3.1
• testo/testo: ^0.10.55
• vimeo/psalm: ^6 || ^7

Suggests

• ext-igbinary: (>3.1.6) Igbinary serializer support
• ext-sodium: Sodium serializer support

Replaces

• spiral/roadrunner-kv: v4.5.0

MIT

• Anton Titov
• Pavel Buchnev
• Aleksei Gagarin
• Maksim Smakouz
• Kirill Nesmeyanov
• RoadRunner Community

• redis
• cache
• memcached
• key-value
• kv
• simple-cache
• psr-16
• roadrunner
• boltdb

Published on Packagist.org on 2026-10-10 13:16 UTC

README

PSR-16 cache on top of the RoadRunner KV plugin

This package lets a PHP application use the storages of the RoadRunner KV plugin (memory, boltdb, redis, memcached and others) as a PSR-16 cache, talking to RoadRunner over RPC.

Get Started

Installation

composer require roadrunner/kv

You can use the convenient installer to download the latest available compatible version of RoadRunner server:

composer require roadrunner/cli --dev
vendor/bin/rr get

Configuration

First you need to add at least one kv plugin to your roadrunner configuration. For example, such a configuration would be quite feasible to run:

rpc:
  listen: tcp://127.0.0.1:6001

kv:
  test:
    driver: memory
    config:
        interval: 10

Note

Read more about all available drivers on the documentation page.

After starting the server with this configuration, one driver named "test" will be available to you.

Usage

The following code will allow writing and reading an arbitrary value from the RoadRunner server.

<?php

use Spiral\Goridge\RPC\RPC;
use Spiral\RoadRunner\KeyValue\Factory;

require __DIR__ . '/vendor/autoload.php';

$factory = new Factory(RPC::create('tcp://127.0.0.1:6001'));

$cache = $factory->select('test');

// After that you can write and read arbitrary values:

$cache->set('key', 'value');

echo $cache->get('key'); // string(5) "value"

Serialization

Values are serialized with PHP's native serialize() by default. Pass another serializer to the factory to change that:

• IgbinarySerializer — requires the igbinary extension;
• SodiumSerializer — encrypts values produced by an inner serializer with a keypair from sodium_crypto_box_keypair(), requires the sodium extension.

use Spiral\RoadRunner\KeyValue\Factory;
use Spiral\RoadRunner\KeyValue\Serializer\DefaultSerializer;
use Spiral\RoadRunner\KeyValue\Serializer\SodiumSerializer;

$factory = new Factory($rpc, new SodiumSerializer(new DefaultSerializer(), $key));