spiral/roadrunner-kv

RoadRunner kv plugin bridge

v4.3.0 2024-07-25 09:15 UTC

Requires

• php: >=8.1
• ext-json: *
• psr/simple-cache: 2 - 3
• roadrunner-php/roadrunner-api-dto: ^1.0
• spiral/goridge: ^4.2
• spiral/roadrunner: ^2023.1 || ^2024.1

Requires (Dev)

• phpunit/phpunit: ^10.0
• roave/security-advisories: dev-master
• vimeo/psalm: >=5.8

Suggests

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

MIT

• Wolfy-J
• Pavel Buchnev (butschster)
• Aleksei Gagarin (roxblnfk)
• Maksim Smakouz (msmakouz)
• Kirill Nesmeyanov (SerafimArts)
• RoadRunner Community

README

RoadRunner KV Plugin Bridge

Documentation | Framework Bundle

This repository contains the codebase PSR-16 PHP cache bridge using kv RoadRunner plugin.

Installation

To install application server and KV codebase

composer require spiral/roadrunner-kv

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

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

Usage

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.

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"

License:

MIT License (MIT). Please see LICENSE for more information. Maintained by Spiral Scout.