Skip to content

Y
yii2
Commit 679da533 by Carsten Brandt
Options

polished Query API

parent c6347d6d
Showing with 123 additions and 78 deletions
framework/yii/db/Query.php
...@@ -42,7 +42,7 @@ class Query extends Component implements QueryInterface ...@@ -42,7 +42,7 @@ class Query extends Component implements QueryInterface
/** /**
* @var array the columns being selected. For example, `['id', 'name']`. * @var array the columns being selected. For example, `['id', 'name']`.
* This is used to construct the SELECT clause in a SQL statement. If not set, if means selecting all columns. * This is used to construct the SELECT clause in a SQL statement. If not set, it means selecting all columns.
* @see select() * @see select()
*/ */
public $select; public $select;
......
framework/yii/elasticsearch/ActiveQuery.php
...@@ -85,7 +85,7 @@ class ActiveQuery extends Query implements ActiveQueryInterface ...@@ -85,7 +85,7 @@ class ActiveQuery extends Query implements ActiveQueryInterface
{ {
$command = $this->createCommand($db); $command = $this->createCommand($db);
$result = $command->queryAll(); $result = $command->queryAll();
if ($result['total'] == 0) { if (empty($result['hits'])) {
return []; return [];
} }
$models = $this->createModels($result['hits']); $models = $this->createModels($result['hits']);
...@@ -111,19 +111,16 @@ class ActiveQuery extends Query implements ActiveQueryInterface ...@@ -111,19 +111,16 @@ class ActiveQuery extends Query implements ActiveQueryInterface
*/ */
public function one($db = null) public function one($db = null)
{ {
$command = $this->createCommand($db); if (($result = parent::one($db)) === false) {
$result = $command->queryOne();
if ($result['total'] == 0 || empty($result['hits'])) {
return null; return null;
} }
if ($this->asArray) { if ($this->asArray) {
$first = reset($result['hits']); $model = $result['_source'];
$model = $first['_source']; $model['primaryKey'] = $result['_id'];
$model['primaryKey'] = $first['_id'];
} else { } else {
/** @var ActiveRecord $class */ /** @var ActiveRecord $class */
$class = $this->modelClass; $class = $this->modelClass;
$model = $class::create(reset($result['hits'])); $model = $class::create($result);
} }
if (!empty($this->with)) { if (!empty($this->with)) {
$models = [$model]; $models = [$model];
...@@ -132,24 +129,4 @@ class ActiveQuery extends Query implements ActiveQueryInterface ...@@ -132,24 +129,4 @@ class ActiveQuery extends Query implements ActiveQueryInterface
} }
return $model; return $model;
} }
/**
* Returns the query result as a scalar value.
* The value returned will be the specified attribute in the first record of the query results.
* @param string $attribute name of the attribute to select
* @param Connection $db the database connection used to execute the query.
* If this parameter is not given, the `db` application component will be used.
* @return string the value of the specified attribute in the first record of the query result.
* Null is returned if the query result is empty.
*/
public function scalar($attribute, $db = null)
{
$record = $this->one($db);
if ($record !== null) {
return $record->$attribute;
} else {
return null;
}
}
} }
framework/yii/elasticsearch/ActiveRecord.php
...@@ -64,7 +64,6 @@ class ActiveRecord extends \yii\db\ActiveRecord ...@@ -64,7 +64,6 @@ class ActiveRecord extends \yii\db\ActiveRecord
* @param mixed $primaryKey the primaryKey value * @param mixed $primaryKey the primaryKey value
* @param array $options options given in this parameter are passed to elasticsearch * @param array $options options given in this parameter are passed to elasticsearch
* as request URI parameters. * as request URI parameters.
*
* Please refer to the [elasticsearch documentation](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-get.html) * Please refer to the [elasticsearch documentation](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-get.html)
* for more details on these options. * for more details on these options.
* @return static|null The record instance or null if it was not found. * @return static|null The record instance or null if it was not found.
......
framework/yii/elasticsearch/Command.php
...@@ -59,12 +59,6 @@ class Command extends Component ...@@ -59,12 +59,6 @@ class Command extends Component
return Json::decode($response->getBody(true))['hits']; return Json::decode($response->getBody(true))['hits'];
} }
public function queryOne($options = [])
{
$options['size'] = 1;
return $this->queryAll($options);
}
public function queryCount($options = []) public function queryCount($options = [])
{ {
$options['search_type'] = 'count'; $options['search_type'] = 'count';
......
framework/yii/elasticsearch/Query.php
...@@ -23,19 +23,36 @@ class Query extends Component implements QueryInterface ...@@ -23,19 +23,36 @@ class Query extends Component implements QueryInterface
use QueryTrait; use QueryTrait;
/** /**
* @var array the columns being selected. For example, `array('id', 'name')`. * @var array the fields being retrieved from the documents. For example, `['id', 'name']`.
* This is used to construct the SELECT clause in a SQL statement. If not set, if means selecting all columns. * If not set, it means retrieving all fields. An empty array will result in no fields being
* @see select() * retrieved. This means that only the primaryKey of a record will be available in the result.
* @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-request-fields.html#search-request-fields
* @see fields()
*/
public $fields;
/**
* @var string|array The index to retrieve data from. This can be a string representing a single index
* or a an array of multiple indexes. If this is not set, indexes are being queried.
* @see from()
*/ */
public $select; // TODO fields
public $index; public $index;
/**
* @var string|array The type to retrieve data from. This can be a string representing a single type
* or a an array of multiple types. If this is not set, all types are being queried.
* @see from()
*/
public $type; public $type;
/**
* @var integer A search timeout, bounding the search request to be executed within the specified time value
* and bail with the hits accumulated up to that point when expired. Defaults to no timeout.
* @see timeout()
* @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-request-body.html#_parameters_3
*/
public $timeout;
/** /**
* Creates a DB command that can be used to execute this query. * Creates a DB command that can be used to execute this query.
* @param Connection $db the database connection used to generate the SQL statement. * @param Connection $db the database connection used to execute the query.
* If this parameter is not given, the `elasticsearch` application component will be used. * If this parameter is not given, the `elasticsearch` application component will be used.
* @return Command the created DB command instance. * @return Command the created DB command instance.
*/ */
...@@ -51,23 +68,29 @@ class Query extends Component implements QueryInterface ...@@ -51,23 +68,29 @@ class Query extends Component implements QueryInterface
/** /**
* Executes the query and returns all results as an array. * Executes the query and returns all results as an array.
* @param Connection $db the database connection used to generate the SQL statement. * @param Connection $db the database connection used to execute the query.
* If this parameter is not given, the `db` application component will be used. * If this parameter is not given, the `elasticsearch` application component will be used.
* @return array the query results. If the query results in nothing, an empty array will be returned. * @return array the query results. If the query results in nothing, an empty array will be returned.
*/ */
public function all($db = null) public function all($db = null)
{ {
$rows = $this->createCommand($db)->queryAll(); $rows = $this->createCommand($db)->queryAll()['hits'];
if ($this->indexBy === null) { if ($this->indexBy === null && $this->fields === null) {
return $rows; return $rows;
} }
$result = []; $result = [];
foreach ($rows as $row) { foreach ($rows as $key => $row) {
if ($this->fields !== null) {
$row['_source'] = isset($row['fields']) ? $row['fields'] : [];
unset($row['fields']);
}
if ($this->indexBy !== null) {
if (is_string($this->indexBy)) { if (is_string($this->indexBy)) {
$key = $row[$this->indexBy]; $key = $row['_source'][$this->indexBy];
} else { } else {
$key = call_user_func($this->indexBy, $row); $key = call_user_func($this->indexBy, $row);
} }
}
$result[$key] = $row; $result[$key] = $row;
} }
return $result; return $result;
...@@ -75,30 +98,40 @@ class Query extends Component implements QueryInterface ...@@ -75,30 +98,40 @@ class Query extends Component implements QueryInterface
/** /**
* Executes the query and returns a single row of result. * Executes the query and returns a single row of result.
* @param Connection $db the database connection used to generate the SQL statement. * @param Connection $db the database connection used to execute the query.
* If this parameter is not given, the `db` application component will be used. * If this parameter is not given, the `elasticsearch` application component will be used.
* @return array|boolean the first row (in terms of an array) of the query result. False is returned if the query * @return array|boolean the first row (in terms of an array) of the query result. False is returned if the query
* results in nothing. * results in nothing.
*/ */
public function one($db = null) public function one($db = null)
{ {
return $this->createCommand($db)->queryOne(); $options['size'] = 1;
$result = $this->createCommand($db)->queryAll($options);
if (empty($result['hits'])) {
return false;
}
$record = reset($result['hits']);
if ($this->fields !== null) {
$record['_source'] = isset($record['fields']) ? $record['fields'] : [];
unset($record['fields']);
}
return $record;
} }
/** /**
* Returns the query result as a scalar value. * Returns the query result as a scalar value.
* The value returned will be the specified attribute in the first record of the query results. * The value returned will be the specified field in the first document of the query results.
* @param string $attribute name of the attribute to select * @param string $field name of the attribute to select
* @param Connection $db the database connection used to execute the query. * @param Connection $db the database connection used to execute the query.
* If this parameter is not given, the `db` application component will be used. * If this parameter is not given, the `elasticsearch` application component will be used.
* @return string the value of the specified attribute in the first record of the query result. * @return string the value of the specified attribute in the first record of the query result.
* Null is returned if the query result is empty. * Null is returned if the query result is empty or the field does not exist.
*/ */
public function scalar($attribute, $db = null) public function scalar($field, $db = null)
{ {
$record = $this->one($db); $record = self::one($db);
if ($record !== null) { if ($record !== false && isset($record['_source'][$field])) {
return $record->$attribute; return $record['_source'][$field];
} else { } else {
return null; return null;
} }
...@@ -106,20 +139,27 @@ class Query extends Component implements QueryInterface ...@@ -106,20 +139,27 @@ class Query extends Component implements QueryInterface
/** /**
* Executes the query and returns the first column of the result. * Executes the query and returns the first column of the result.
* @param Connection $db the database connection used to generate the SQL statement. * @param string $field the field to query over
* If this parameter is not given, the `db` application component will be used. * @param Connection $db the database connection used to execute the query.
* If this parameter is not given, the `elasticsearch` application component will be used.
* @return array the first column of the query result. An empty array is returned if the query results in nothing. * @return array the first column of the query result. An empty array is returned if the query results in nothing.
*/ */
public function column($db = null) public function column($field, $db = null)
{ {
return $this->createCommand($db)->queryColumn(); $query = clone $this;
$rows = $query->fields([$field])->createCommand($db)->queryAll()['hits'];
$result = [];
foreach ($rows as $row) {
$result[] = $row['fields'][$field];
}
return $result;
} }
/** /**
* Returns the number of records. * Returns the number of records.
* @param string $q the COUNT expression. This parameter is ignored by this implementation. * @param string $q the COUNT expression. This parameter is ignored by this implementation.
* @param Connection $db the database connection used to generate the SQL statement. * @param Connection $db the database connection used to execute the query.
* If this parameter is not given (or null), the `db` application component will be used. * If this parameter is not given, the `elasticsearch` application component will be used.
* @return integer number of records * @return integer number of records
*/ */
public function count($q = '*', $db = null) public function count($q = '*', $db = null)
...@@ -138,8 +178,8 @@ class Query extends Component implements QueryInterface ...@@ -138,8 +178,8 @@ class Query extends Component implements QueryInterface
* Returns the sum of the specified column values. * Returns the sum of the specified column values.
* @param string $q the column name or expression. * @param string $q the column name or expression.
* Make sure you properly quote column names in the expression. * Make sure you properly quote column names in the expression.
* @param Connection $db the database connection used to generate the SQL statement. * @param Connection $db the database connection used to execute the query.
* If this parameter is not given, the `db` application component will be used. * If this parameter is not given, the `elasticsearch` application component will be used.
* @return integer the sum of the specified column values * @return integer the sum of the specified column values
*/ */
public function sum($q, $db = null) public function sum($q, $db = null)
...@@ -152,8 +192,8 @@ class Query extends Component implements QueryInterface ...@@ -152,8 +192,8 @@ class Query extends Component implements QueryInterface
* Returns the average of the specified column values. * Returns the average of the specified column values.
* @param string $q the column name or expression. * @param string $q the column name or expression.
* Make sure you properly quote column names in the expression. * Make sure you properly quote column names in the expression.
* @param Connection $db the database connection used to generate the SQL statement. * @param Connection $db the database connection used to execute the query.
* If this parameter is not given, the `db` application component will be used. * If this parameter is not given, the `elasticsearch` application component will be used.
* @return integer the average of the specified column values. * @return integer the average of the specified column values.
*/ */
public function average($q, $db = null) public function average($q, $db = null)
...@@ -166,8 +206,8 @@ class Query extends Component implements QueryInterface ...@@ -166,8 +206,8 @@ class Query extends Component implements QueryInterface
* Returns the minimum of the specified column values. * Returns the minimum of the specified column values.
* @param string $q the column name or expression. * @param string $q the column name or expression.
* Make sure you properly quote column names in the expression. * Make sure you properly quote column names in the expression.
* @param Connection $db the database connection used to generate the SQL statement. * @param Connection $db the database connection used to execute the query.
* If this parameter is not given, the `db` application component will be used. * If this parameter is not given, the `elasticsearch` application component will be used.
* @return integer the minimum of the specified column values. * @return integer the minimum of the specified column values.
*/ */
public function min($q, $db = null) public function min($q, $db = null)
...@@ -180,8 +220,8 @@ class Query extends Component implements QueryInterface ...@@ -180,8 +220,8 @@ class Query extends Component implements QueryInterface
* Returns the maximum of the specified column values. * Returns the maximum of the specified column values.
* @param string $q the column name or expression. * @param string $q the column name or expression.
* Make sure you properly quote column names in the expression. * Make sure you properly quote column names in the expression.
* @param Connection $db the database connection used to generate the SQL statement. * @param Connection $db the database connection used to execute the query.
* If this parameter is not given, the `db` application component will be used. * If this parameter is not given, the `elasticsearch` application component will be used.
* @return integer the maximum of the specified column values. * @return integer the maximum of the specified column values.
*/ */
public function max($q, $db = null) public function max($q, $db = null)
...@@ -193,7 +233,7 @@ class Query extends Component implements QueryInterface ...@@ -193,7 +233,7 @@ class Query extends Component implements QueryInterface
/** /**
* Returns a value indicating whether the query result contains any row of data. * Returns a value indicating whether the query result contains any row of data.
* @param Connection $db the database connection used to execute the query. * @param Connection $db the database connection used to execute the query.
* If this parameter is not given, the `db` application component will be used. * If this parameter is not given, the `elasticsearch` application component will be used.
* @return boolean whether the query result contains any row of data. * @return boolean whether the query result contains any row of data.
*/ */
public function exists($db = null) public function exists($db = null)
...@@ -213,9 +253,43 @@ class Query extends Component implements QueryInterface ...@@ -213,9 +253,43 @@ class Query extends Component implements QueryInterface
// TODO http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-delete-by-query.html // TODO http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-delete-by-query.html
} }
/**
* Sets the index and type to retrieve documents from.
* @param string|array $index The index to retrieve data from. This can be a string representing a single index
* or a an array of multiple indexes. If this is `null` it means that all indexes are being queried.
* @param string|array $type The type to retrieve data from. This can be a string representing a single type
* or a an array of multiple types. If this is `null` it means that all types are being queried.
* @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-search.html#search-multi-index-type
*/
public function from($index, $type = null) public function from($index, $type = null)
{ {
$this->index = $index; $this->index = $index;
$this->type = $type; $this->type = $type;
} }
/**
* Sets the fields to retrieve from the documents.
* @param array $fields the fields to be selected.
* @return static the query object itself
* @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-request-fields.html
*/
public function fields($fields)
{
$this->fields = $fields;
return $this;
}
/**
* Sets the search timeout.
* @param integer $timeout A search timeout, bounding the search request to be executed within the specified time value
* and bail with the hits accumulated up to that point when expired. Defaults to no timeout.
* @return static the query object itself
* @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-request-body.html#_parameters_3
*/
public function timeout($timeout)
{
$this->timeout = $timeout;
return $this;
}
} }
\ No newline at end of file
framework/yii/elasticsearch/QueryBuilder.php
...@@ -45,7 +45,7 @@ class QueryBuilder extends \yii\base\Object ...@@ -45,7 +45,7 @@ class QueryBuilder extends \yii\base\Object
public function build($query) public function build($query)
{ {
$searchQuery = array(); $searchQuery = array();
$this->buildSelect($searchQuery, $query->select); $this->buildFields($searchQuery, $query->fields);
// $this->buildFrom($searchQuery, $query->from); // $this->buildFrom($searchQuery, $query->from);
$this->buildCondition($searchQuery, $query->where); $this->buildCondition($searchQuery, $query->where);
$this->buildOrderBy($searchQuery, $query->orderBy); $this->buildOrderBy($searchQuery, $query->orderBy);
...@@ -113,9 +113,9 @@ class QueryBuilder extends \yii\base\Object ...@@ -113,9 +113,9 @@ class QueryBuilder extends \yii\base\Object
* @param string $selectOption * @param string $selectOption
* @return string the SELECT clause built from [[query]]. * @return string the SELECT clause built from [[query]].
*/ */
public function buildSelect(&$query, $columns) public function buildFields(&$query, $columns)
{ {
if (empty($columns)) { if ($columns === null) {
return; return;
} }
foreach ($columns as $i => $column) { foreach ($columns as $i => $column) {
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment