Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/php-cmsig/seal-redisearch-adapter

An adapter to support RediSearch in CMS-IG SEAL search abstraction. Part of the https://github.com/php-cmsig/search project. READ-ONLY Repository
https://github.com/php-cmsig/seal-redisearch-adapter

cmsig php redis redis-php redisearch seal-adapter seal-php-adapter search-client

Last synced: about 1 month ago
JSON representation

An adapter to support RediSearch in CMS-IG SEAL search abstraction. Part of the https://github.com/php-cmsig/search project. READ-ONLY Repository

Awesome Lists containing this project

README

        


SEAL Logo with an abstract seal sitting on a telescope.

Logo created by Meine Wilma

SEAL
RediSearch Adapter




The `RediSearchAdapter` write the documents into a [RediSearch](https://redis.io/docs/stack/search/) server instance. The Redis Server requires to run with the RedisSearch and JSON module.

> **Note**:
> This is part of the `cmsig/search` project create issues in the [main repository](https://github.com/php-cmsig/search).

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

## Installation

Use [composer](https://getcomposer.org/) for install the package:

```bash
composer require cmsig/seal cmsig/seal-redisearch-adapter
```

## Usage.

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

```php
'127.0.0.1',
'port' => 6379,
'auth' => ['phpredis', 'phpredis'],
]);

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

Via DSN for your favorite framework:

```env
redis://127.0.0.1:6379
redis://[email protected]:6379
redis://phpredis:[email protected]: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](https://github.com/alexander-schranz/)
- [The Community Contributors](https://github.com/php-cmsig/search/graphs/contributors)