Skip to content

Latest commit

 

History

History
469 lines (313 loc) · 11.9 KB

overview-kv.md

File metadata and controls

469 lines (313 loc) · 11.9 KB

Overview

The RoadRunner KV (Key-Value) plugin is a powerful cache implementation written in Go language. It offers lightning-fast communication with cache drivers such as:

It is able to handle cache operations more efficiently than the same operations in PHP, leading to faster response times and improved application performance.

It provides the ability to store arbitrary data inside the RoadRunner between different requests (in case of HTTP application) or different types of applications. Thus, using Temporal, for example, you can transfer data inside the HTTP applicationand vice versa.

One of the key benefits of using the RoadRunner KV plugin is its RPC interface, which allows for seamless integration with your existing infrastructure.

kv-general-info

Opentelemetry tracing

All KV drivers support opentelemetry tracing. To enable tracing, you need to add otel section to your configuration file:

{% code title=".rr.yaml" %}

version: "3"

kv:
  example:
    driver: memory
    config: { }

otel:
  resources:
    service_name: "rr_test"
    service_version: "1.0.0"
    service_namespace: "RR-Shop"
    service_instance_id: "UUID"
  insecure: true
  compress: false
  exporter: otlp
  endpoint: 127.0.0.1:4317

{% endcode %}

After that, you can see traces in your Dash0, Jaeger, Uptrace, Zipkin or any other opentelemetry compatible tracing system.

Configuration

To use the RoadRunner KV plugin, you need to define multiple key-value storages with desired storage drivers in the configuration file. Each storage must have a driver that indicates the type of connection used by those storages. At the moment, four different types of drivers are available: boltdb, redis, memcached, and memory.

{% hint style="info" %} The memory and boltdb drivers do not require additional binaries and are available immediately, while the rest require additional setup. Please see the appropriate documentation for installing Redis Server and/or Memcached Server. {% endhint %}

Here is a simple configuration example:

{% code title=".rr.yaml" %}

version: "3"

rpc:
  listen: tcp://127.0.0.1:6001

kv:
  example:
    driver: memory
    config: { }

{% endcode %}

{% hint style="info" %} to interact with the RoadRunner KV plugin, you will need to have the RPC defined in the rpc configuration section. You can refer to the documentation page here to learn more about the configuration. {% endhint %}

PHP client

The RoadRunner KV plugin comes with a convenient PHP package that simplifies the process of integrating the plugin with your PHP application and store and request data from storages using RoadRunner PRC.

Installation

Requirements

  • PHP >= 8.1
  • ext-protobuf (optional)

You can install the package via Composer using the following command:

{% code %}

composer require spiral/roadrunner-kv

{% endcode %}

Usage

First, you need to create the RPC connection to the RoadRunner server.

{% code title="app.php" %}

use Spiral\RoadRunner\Environment;
use Spiral\Goridge\RPC\RPC;

// Manual configuration
$rpc = RPC::create('tcp://127.0.0.1:6001');

{% endcode %}

{% hint style="info" %} You can refer to the documentation page here to learn more about creating the RPC connection. {% endhint %}

To work with storages, you should create the Spiral\RoadRunner\KeyValue\Factory object after creating the RPC connection. It provides a method for selecting the storage.

  • Factory::select(string)- method receives the name of the storage as the first argument and returns the implementation of the PSR-16 Psr\SimpleCache\CacheInterface for interacting with the key-value RoadRunner storage.

Here is a simple example of using:

{% code title="app.php" %}

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

$factory = new Factory($rpc);

$storage = $factory->select('storage-name');

// Expected:
//  An instance of Psr\SimpleCache\CacheInterface interface

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

var_dump($storage->get('key'));
// Expected:
//  string(5) "string"

{% endcode %}

The RoadRunner KV API provides several additional methods, such as getTtl(string) and getMultipleTtl(string), which allow you to get information about the expiration of an item stored in a key-value storage.

{% hint style="info" %} Please note that the memcached driver does not support these methods. {% endhint %}

{% code title="app.php" %}

$ttl = $factory
    ->select('memory')
    ->getTtl('key');
    
// Expected:
//  - An instance of \DateTimeInterface if "key" expiration time is available
//  - Or null otherwise

$ttl = $factory
    ->select('memcached')
    ->getTtl('key');
    
// Expected:
//  Spiral\RoadRunner\KeyValue\Exception\KeyValueException: Storage "memcached"
//  does not support kv.TTL RPC method execution. Please use another driver for
//  the storage if you require this functionality.

{% endcode %}

Value Serialization

To save and receive data from the key-value store, the data serialization mechanism is used. This way you can store and receive arbitrary serializable objects.

{% code title="app.php" %}

$storage->set('test', (object)['key' => 'value']);

$item = $storage->set('test');
// Expected:
//  object(StdClass)#399 (1) {
//    ["key"] => string(5) "value"
//  }

{% endcode %}

If you need to specify your custom serializer, you can do so by specifying it in the key-value factory constructor as a second argument, or by using the Factory::withSerializer(SerializerInterface): self method. This will allow you to use your own serialization mechanism and store more complex objects in the key-value store.

{% code title="app.php" %}

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

$storage = (new Factory($rpc))
    ->withSerializer(new CustomSerializer())
    ->select('storage');

{% endcode %}

If you require a specific serializer for a particular value stored in the key-value storage, you can use the withSerializer() method. This allows you to use a custom serializer for that particular value while still using the default serializer for other values.

{% code title="app.php" %}

// Using default serializer
$storage->set('key', 'value');

// Using custom serializer
$storage
    ->withSerializer(new CustomSerializer())
    ->set('key', 'value');

{% endcode %}

Igbinary Value Serialization

The serialization mechanism in PHP is not always efficient, which can impact the performance of your application. To increase the speed of serialization and deserialization, it is recommended to use the igbinary extension.

{% tabs %} {% tab title="Linux and macOS" %}

In a Linux and macOS environment, it may be installed with a simple command:

{% code %}

pecl install igbinary

{% endcode %}

{% endtab %}

{% tab title="Windows" %}

For the Windows OS, you can download it from the PECL website.

{% endtab %}

{% endtabs %}

{% hint style="info" %} More detailed installation instructions are available here. {% endhint %}

Here is an example of using the igbinary serializer:

{% code title="app.php" %}

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

$storage = (new Factory($rpc)
    ->withSerializer(new IgbinarySerializer())
    ->select('storage');

{% endcode %}

End-to-End Value Encryption

Some data may contain sensitive information, such as personal data of the user. In these cases, it is recommended to use data encryption.

{% hint style="info" %} To use encryption, you need to install the Sodium extension. {% endhint %}

Next, you should have an encryption key generated using sodium_crypto_box_keypair() function. You can do this using the following command:

{% code %}

php -r "echo sodium_crypto_box_keypair();" > keypair.key

{% endcode %}

{% hint style="warning" %} Do not store security keys in a control versioning system (like GIT)! {% endhint %}

After generating the keypair, you can use it to encrypt and decrypt the data.

{% code title="app.php" %}

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

$storage = new Factory($rpc);
    ->select('storage');

// Encrypted serializer
$key = file_get_contents(__DIR__ . '/path/to/keypair.key');
$encrypted = new SodiumSerializer($storage->getSerializer(), $key);

// Storing public data
$storage->set('user.login', 'test');

// Storing private data
$storage->withSerializer($encrypted)
    ->set('user.email', '[email protected]');

{% endcode %}

API

Protobuf API

To make it easy to use the KV proto API in PHP, we provide a GitHub repository, that contains all the generated PHP DTO classes proto files, making it easy to work with these files in your PHP application.

RPC API

RoadRunner provides an RPC API, which allows you to manage key-value in your applications using remote procedure calls. The RPC API provides a set of methods that map to the available methods of the Spiral\RoadRunner\KeyValue\Cache class in PHP.

Has

Checks for the presence of one or more keys in the specified storage.

{% code %}

func (r *rpc) Has(in *kvv1.Request, out *kvv1.Response) error {}

{% endcode %}

Set

Sets one or more key-value pairs in the specified storage.

{% code %}

func (r *rpc) Set(in *kvv1.Request, _ *kvv1.Response) error {}

{% endcode %}

MGet

Gets the values of one or more keys from the specified storage.

{% code %}

func (r *rpc) MGet(in *kvv1.Request, out *kvv1.Response) error {}

{% endcode %}

MExpire

Sets the expiration time for one or more keys in the specified storage.

{% code %}

func (r *rpc) MExpire(in *kvv1.Request, _ *kvv1.Response) error {}

{% endcode %}

TTL

Gets the expiration time of a single key in the specified storage.

{% code %}

func (r *rpc) TTL(in *kvv1.Request, out *kvv1.Response) error {}

{% endcode %}

Delete

Deletes one or more keys from the specified storage.

{% code %}

func (r *rpc) Delete(in *kvv1.Request, _ *kvv1.Response) error {}

{% endcode %}

Clear

Clears all keys from the specified storage.

{% code %}

func (r *rpc) Clear(in *kvv1.Request, _ *kvv1.Response) error {}

{% endcode %}

Example

To use the RPC API in PHP, you can create an RPC connection to the RoadRunner server and use the call() method to perform the desired operation. For example, to call the MGet method, you can use the following code:

{% code title="app.php" %}

use Spiral\Goridge\RPC\RPC;
use Spiral\Goridge\RPC\Codec\ProtobufCodec;
use RoadRunner\KV\DTO\V1\{Request, Response};

$response = RPC::create('tcp://127.0.0.1:6001')
    ->withServicePrefix('kv')
    ->withCodec(new ProtobufCodec())
    ->call('MGet', new Request([ ... ]), Response::class);

{% endcode %}