yiisoft/db-sphinx

Yii Framework Sphinx full text search engine extension

dev-master / 1.0.x-dev 2019-05-23 16:10 UTC

README

687474703a2f2f737068696e787365617263682e636f6d2f696d616765732f6c6f676f2e706e67

Yii Framework Sphinx full text search engine extension


This extension adds Sphinx full text search engine extension for the Yii framework. It supports all Sphinx features including Real-time Indexes.

For license information check the LICENSE-file.

Documentation is at docs/guide/README.md.

Latest Stable Version Total Downloads Build Status

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.

composer require --prefer-dist yiisoft/db-sphinx

Configuration

This extension interacts with Sphinx search daemon using MySQL protocol and 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:

return [
    //....
    'components' => [
        'sphinx' => [
            'class' => Yiisoft\Db\Sphinx\Connection::class,
            'dsn' => 'mysql:host=127.0.0.1;port=9306;',
            'username' => '',
            'password' => '',
        ],
    ],
];