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 year 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
- Host: GitHub
- URL: https://github.com/php-cmsig/seal-redisearch-adapter
- Owner: PHP-CMSIG
- License: mit
- Created: 2023-02-11T19:56:53.000Z (over 3 years ago)
- Default Branch: 0.7
- Last Pushed: 2025-03-19T16:36:05.000Z (about 1 year ago)
- Last Synced: 2025-04-15T19:54:05.412Z (about 1 year ago)
- Topics: cmsig, php, redis, redis-php, redisearch, seal-adapter, seal-php-adapter, search-client
- Language: PHP
- Homepage:
- Size: 104 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
> **Note**:
> This is part of the `cmsig/search` project create issues in the [main repository](https://github.com/php-cmsig/search).
---
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 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://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.
## Limitation
- [No GeoBoundingBox support](https://github.com/PHP-CMSIG/search/issues/422)
- [No HIGHLIGHT support](https://github.com/PHP-CMSIG/search/issues/491)
## Authors
- [Alexander Schranz](https://github.com/alexander-schranz/)
- [The Community Contributors](https://github.com/php-cmsig/search/graphs/contributors)