https://github.com/yiisoft/db-sphinx
Yii Framework Sphinx full text search engine extension
https://github.com/yiisoft/db-sphinx
fulltext-search hacktoberfest optionalforframeworkannounce sphinx yii3
Last synced: 6 months ago
JSON representation
Yii Framework Sphinx full text search engine extension
- Host: GitHub
- URL: https://github.com/yiisoft/db-sphinx
- Owner: yiisoft
- License: other
- Created: 2018-08-02T16:05:54.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-02-19T10:06:24.000Z (about 3 years ago)
- Last Synced: 2024-04-14T01:50:51.704Z (about 2 years ago)
- Topics: fulltext-search, hacktoberfest, optionalforframeworkannounce, sphinx, yii3
- Language: PHP
- Homepage: https://www.yiiframework.com/
- Size: 9.84 MB
- Stars: 9
- Watchers: 18
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
Yii Framework Sphinx full text search engine extension
This extension adds [Sphinx](https://sphinxsearch.com/docs) full text search engine extension for the [Yii framework](https://www.yiiframework.com).
It supports all Sphinx features including [Real-time Indexes](https://sphinxsearch.com/docs/current.html#rt-indexes).
For license information check the [LICENSE](LICENSE.md)-file.
Documentation is at [docs/guide/README.md](docs/guide/README.md).
[](https://packagist.org/packages/yiisoft/db-sphinx)
[](https://packagist.org/packages/yiisoft/db-sphinx)
[](https://travis-ci.org/yiisoft/db-sphinx)
Requirements
------------
At least Sphinx version 2.0 is required. However, in order to use all extension features, Sphinx version 2.2.3 or
higher is required.
Installation
------------
The preferred way to install this extension is through [composer](https://getcomposer.org/download/).
```shell
composer require --prefer-dist yiisoft/db-sphinx
```
Configuration
-------------
This extension interacts with Sphinx search daemon using MySQL protocol and [SphinxQL](https://sphinxsearch.com/docs/current.html#sphinxql) query language.
In order to setup Sphinx "searchd" to support MySQL protocol following configuration should be added:
```
searchd
{
listen = localhost:9306:mysql41
...
}
```
To use this extension, simply add the following code in your application configuration:
```php
return [
//....
'components' => [
'sphinx' => [
'class' => Yiisoft\Db\Sphinx\Connection::class,
'dsn' => 'mysql:host=127.0.0.1;port=9306;',
'username' => '',
'password' => '',
],
],
];
```