cmsig/seal-read-write-adapter

An adapter to support to split read and write operations for the cmsig/seal package.

0.5.0 2024-09-24 11:30 UTC

Requires

• php: ^8.1
• psr/container: ^1.0 || ^2.0
• schranz-search/seal: ^0.5

Requires (Dev)

• php-cs-fixer/shim: ^3.51
• phpstan/extension-installer: ^1.2
• phpstan/phpstan: ^1.10
• phpstan/phpstan-phpunit: ^1.3
• phpunit/phpunit: ^10.3
• rector/rector: ^1.0

MIT

• Alexander Schranz

• schranz-search
• schranz-search-adapter
• seal-adapter
• search-client

README

Note: This is part of the cmsig/search project create issues in the main repository.

Logo created by Meine Wilma

SEAL
Read Write Adapter

The ReadWriteAdapter allows to use one adapter instance for reading and one for writing. This is useful if you want to reindex something without a downtime.

Note: This project is heavily under development and any feedback is greatly appreciated.

Installation

Use composer for install the package:

composer require cmsig/seal cmsig/seal-read-write-adapter

Usage

To use the adapter an instance of ReadWriteAdapter need to be created which get a $readAdapter and $writeAdapter which are instances of the AdapterInterface.

The following code shows how to create an Engine using this Adapter:

<?php

use CmsIg\Seal\Adapter\Elasticsearch\ElasticsearchAdapter;
use CmsIg\Seal\Adapter\ReadWrite\ReadWriteAdapter;
use CmsIg\Seal\Engine;

$readAdapter = new ElasticsearchAdapter(/* .. */); // can be any adapter
$writeAdapter = new ElasticsearchAdapter(/* .. */); // can be any adapter

$engine = new Engine(
    new ReadWriteAdapter(
        $readAdapter,
        $writeAdapter
    ),
    $schema,
);

Via DSN for your favorite framework:

multi://readAdapter?adapters[]=writeAdapter
read-write://readAdapter?write=multiAdapter

Note Read a document and partial update it based on the read document should be avoided when using this adapter, as the read document could already be outdated. So always fully update the document and never do based on read documents. Have a look at the MultiAdapter to write into read and write adapter.

Authors

• Alexander Schranz
• The Community Contributors