• Home
• yii
• sphinx
• Query

PHP Class yii\sphinx\Query

Query provides a set of methods to facilitate the specification of different clauses in a SELECT statement. These methods can be chained together. By calling Query::createCommand, we can get a Command instance which can be further used to perform/execute the Sphinx query. For example, php $query = new Query(); $query->select('id, group_id') ->from('idx_item') ->limit(10); build and execute the query $command = $query->createCommand(); $command->sql returns the actual SQL $rows = $command->queryAll(); Since Sphinx does not store the original indexed text, the snippets for the rows in query result should be build separately via another query. You can simplify this workflow using [[snippetCallback]]. Warning: even if you do not set any query limit, implicit LIMIT 0,20 is present by default! Show file Open project: yiisoft/yii2-sphinx Class Usage Examples

Public Properties

Property	Type	Description
$facets		facet search specifications. For example: php [ 'group_id', 'brand_id' => [ 'order' => ['COUNT(*)' => SORT_ASC], ], 'price' => [ 'select' => 'INTERVAL(price,200,400,600,800) AS price', 'order' => ['FACET()' => SORT_ASC], ], 'name_in_json' => [ 'select' => [new Expression('json_attr.name AS name_in_json')], ], ] You need to use Query::search method in order to fetch facet results. Note: if you specify custom select for the facet, ensure facet name has corresponding column inside it.
$groupLimit		groups limit: to return (no more than) N top matches for each group. This option will take effect only if [[groupBy]] is set.
$match		text, which should be searched in fulltext mode. This value will be composed into MATCH operator inside the WHERE clause. Note: this value will be processed by [[Connection::escapeMatchValue()]], if you need to compose complex match condition use [[Expression]], see Query::match for details.
$options		per-query options in format: optionName => optionValue They will compose OPTION clause. This is a Sphinx specific extension that lets you control a number of per-query options.
$showMeta		whether to automatically perform 'SHOW META' query against main one. You may set this value to be string or [[Expression]] instance, in this case its value will be used as 'LIKE' condition for 'SHOW META' statement. You need to use Query::search method in order to fetch 'meta' results.
$snippetCallback		PHP callback, which should be used to fetch source data for the snippets. Such callback will receive array of query result rows as an argument and must return the array of snippet source strings in the order, which match one of incoming rows. For example: php $query = new Query(); $query->from('idx_item') ->match('pencil') ->snippetCallback(function ($rows) { $result = []; foreach ($rows as $row) { $result[] = file_get_contents('/path/to/index/files/' . $row['id'] . '.txt'); } return $result; }) ->all();
$snippetOptions		query options for the call snippet.
$within		WITHIN GROUP ORDER BY clause. This is a Sphinx specific extension that lets you control how the best row within a group will to be selected. The possible value matches the [[orderBy]] one.

Public Methods

Method	Description
addFacets ( array $facets )	Adds additional FACET part of the query.
addOptions ( array $options )	Adds additional query options.
addWithin ( string | array $columns )	Adds additional WITHIN GROUP ORDER BY columns to the query.
create ( Query $from ) : Query	Creates a new Query object and copies its property values from an existing one.
createCommand ( Connection $db = null ) : Command	Creates a Sphinx command that can be used to execute this query.
facets ( array $facets )	Sets FACET part of the query.
getConnection ( ) : Connection
groupLimit ( integer $limit )	Sets groups limit: to return (no more than) N top matches for each group.
innerJoin ( $table, $on = '', $params = [] )
join ( $type, $table, $on = '', $params = [] )
leftJoin ( $table, $on = '', $params = [] )
match ( string | yii\db\Expression | MatchExpression $query )	Sets the fulltext query text. This text will be composed into MATCH operator inside the WHERE clause.
one ( $db = null )
options ( array $options )	Sets the query options.
populate ( $rows )
rightJoin ( $table, $on = '', $params = [] )
search ( Connection $db = null ) : array	Executes the query and returns the complete search result including e.g. hits, facets.
setConnection ( Connection $connection )
showMeta ( boolean | string | yii\db\Expression $showMeta )	Sets whether to automatically perform 'SHOW META' for the search query.
snippetCallback ( callable $callback )	Sets the PHP callback, which should be used to retrieve the source data for the snippets building.
snippetOptions ( array $options )	Sets the call snippets query options.
within ( string | array $columns )	Sets the WITHIN GROUP ORDER BY part of the query.

Protected Methods

Method	Description
callSnippets ( array $source ) : array	Builds a snippets from provided source data.
callSnippetsInternal ( array $source, string $from ) : array	Builds a snippets from provided source data by the given index.
defaultConnection ( ) : Connection
fillUpSnippets ( array $rows ) : array | ActiveRecord[]	Fills the query result rows with the snippets built from source determined by [[snippetCallback]] result.
queryScalar ( $selectExpression, $db )

Method Details

Property Details