Facet search ¶

Since version 2.2.3 Sphinx provides ability of the facet searching via FACET clause:

SELECT * FROM idx_item FACET brand_id FACET categories;

yii\sphinx\Query supports composition of this clause as well as fetching facet results. You may specify facets via yii\sphinx\Query::facets. In order to fetch results with facets you need to use yii\sphinx\Query::search() method. For example:

use yii\sphinx\Query;

$query = new Query();
$results = $query->from('idx_item')
    ->facets([
        'brand_id',
        'categories',
    ])
    ->search($connection); // retrieve all rows and facets

$items = $results['hits'];
$facets = $results['facets'];

foreach ($results['facets']['brand_id'] as $frame) {
    $brandId = $frame['value'];
    $count = $frame['count'];
    ...
}

Note: make sure you are using Sphinx server version 2.2.3 or higher before attempting to use facet feature.

You may specify additional facet options like select or order using an array format:

use yii\db\Expression;
use yii\sphinx\Query;

$query = new Query();
$results = $query->from('idx_item')
    ->facets([
        'price' => [
            'select' => 'INTERVAL(price,200,400,600,800) AS price', // using function
            'order' => ['FACET()' => SORT_ASC],
        ],
        'name_in_json' => [
            'select' => [new Expression('json_attr.name AS name_in_json')], // have to use `Expression` to avoid unnecessary quoting
        ],
    ])
    ->search($connection);

Note: if you specify a custom select for a facet, ensure the facet name has the corresponding column inside the select statement. For example, if you have specified a facet named 'my_facet', its select statement should contain 'my_facet' attribute or an expression aliased as 'my_facet' ('expr() AS my_facet').