yiisoft/db-sphinx

This package is abandoned and no longer maintained. No replacement package was suggested.

Yii Framework Sphinx full text search engine extension

dev-master / 1.0.x-dev 2026-02-02 06:31 UTC

Requires

• ext-pdo: *
• ext-pdo_mysql: *
• yiisoft/active-record: ^3.0@dev
• yiisoft/db: ^3.0@dev
• yiisoft/strings: ^3.0@dev
• yiisoft/yii-core: ^3.0@dev

Requires (Dev)

• phpunit/phpunit: ^7.3
• yiisoft/arrays: ^3.0@dev
• yiisoft/cache: dev-master
• yiisoft/db-mysql: dev-master
• yiisoft/di: dev-master
• yiisoft/log: dev-master
• yiisoft/yii-console: dev-master
• yiisoft/yii-web: ^3.0@dev

BSD-3-Clause

• Paul Klimov

• search
• sphinx
• yii
• active-record
• fulltext

README

Warning

There is no official Sphinx support planned for Yii3 DB. Use either MySQL driver directly or any of the clients availabe.

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.

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' => '',
        ],
    ],
];