Yii Framework Sphinx full text search engine extension

dev-master / 1.0.x-dev 2023-02-19 10:06 UTC

This package is auto-updated.

Last update: 2024-02-19 12:07:52 UTC



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


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.


The preferred way to install this extension is through composer.

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


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:

    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=;port=9306;',
            'username' => '',
            'password' => '',