schranz-search/seal-redisearch-adapter

An adapter to support RediSearch in schranz-search/seal search abstraction.

0.5.0 2024-09-24 11:30 UTC

Requires

• php: ^8.1
• ext-json: *
• ext-redis: ^5 || ^6.0
• 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

• redis
• redisearch
• schranz-search
• schranz-search-adapter
• seal-adapter
• search-client

README

Logo created by Meine Wilma

SEAL
RediSearch Adapter

The RediSearchAdapter write the documents into a RediSearch server instance. The Redis Server requires to run with the RedisSearch and JSON module.

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

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

Installation

Use composer for install the package:

composer require schranz-search/seal schranz-search/seal-redisearch-adapter

Usage.

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

<?php

use Redis;
use Schranz\Search\SEAL\Adapter\RediSearch\RediSearchAdapter;
use Schranz\Search\SEAL\Engine;

$redis = new Redis([
    'host' => '127.0.0.1',
    'port' => 6379,
    'auth' => ['phpredis', 'phpredis'],
]);

$engine = new Engine(
    new RediSearchAdapter($redis),
    $schema,
);

Via DSN for your favorite framework:

redis://127.0.0.1:6379
redis://supersecure@127.0.0.1:6379
redis://phpredis:phpredis@127.0.0.1:6379

The ext-redis and ext-json PHP extension is required for this adapter.
The Redisearch and RedisJson module is required for the Redis Server.

Authors

• Alexander Schranz
• The Community Contributors