Skip to content

Y
yii2
Commit e0fcecf2 by Carsten Brandt
Options

implemented base index and data manipulation api

parent 8341a597
Showing with 393 additions and 72 deletions
framework/yii/elasticsearch/ActiveRecord.php
...@@ -36,7 +36,7 @@ abstract class ActiveRecord extends \yii\db\ActiveRecord ...@@ -36,7 +36,7 @@ abstract class ActiveRecord extends \yii\db\ActiveRecord
*/ */
public static function getDb() public static function getDb()
{ {
return \Yii::$app->elasticsearch; return \Yii::$app->getComponent('elasticsearch');
} }
/** /**
......
framework/yii/elasticsearch/Command.php
...@@ -9,6 +9,16 @@ namespace yii\elasticsearch; ...@@ -9,6 +9,16 @@ namespace yii\elasticsearch;
use yii\base\Component; use yii\base\Component;
use yii\helpers\Json; use yii\helpers\Json;
// camelCase vs. _
// http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/common-options.html#_result_casing
/**
* Class Command
*
* http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/glossary.html
*
*/
class Command extends Component class Command extends Component
{ {
/** /**
...@@ -33,88 +43,398 @@ class Command extends Component ...@@ -33,88 +43,398 @@ class Command extends Component
*/ */
public $query; public $query;
private function createUrl($endPoint = null) // private function createUrl($endPoint = null)
// {
// if ($endPoint === null) {
// $endPoint = $this->api;
// }
// if ($this->index === null && $this->type === null) {
// return '/' . $endPoint;
// }
// $index = $this->index;
// if ($index === null) {
// $index = '_all';
// } elseif (is_array($index)) {
// $index = implode(',', $index);
// }
// $type = $this->type;
// if (is_array($type)) {
// $type = implode(',', $type);
// }
// return '/' . $index . '/' . (empty($type) ? '' : $type . '/') . $endPoint;
// }
//
// public function queryAll()
// {
// $query = $this->query;
// if (empty($query)) {
// $query = '{}';
// }
// if (is_array($query)) {
// $query = Json::encode($query);
// }
// $http = $this->db->http();
// $response = $http->post($this->createUrl(), null, $query)->send();
// $data = Json::decode($response->getBody(true));
// // TODO store query meta data for later use
// $docs = array();
// switch ($this->api) {
// default:
// case '_search':
// if (isset($data['hits']['hits'])) {
// $docs = $data['hits']['hits'];
// }
// break;
// case '_mget':
// if (isset($data['docs'])) {
// $docs = $data['docs'];
// }
// break;
// }
// $rows = array();
// foreach($docs as $doc) {
// // TODO maybe return type info
// if (isset($doc['exists']) && !$doc['exists']) {
// continue;
// }
// $row = $doc['_source'];
// $row['id'] = $doc['_id'];
// $rows[] = $row;
// }
// return $rows;
// }
//
// public function queryOne()
// {
// // TODO set limit
// $rows = $this->queryAll();
// return reset($rows);
// }
//
// public function queryCount()
// {
// //http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-count.html
// $query = $this->query;
// if (empty($query)) {
// $query = '';
// }
// if (is_array($query)) {
// $query = Json::encode($query);
// }
// $http = $this->db->http();
// $response = $http->post($this->createUrl('_count'), null, $query)->send();
// $data = Json::decode($response->getBody(true));
// // TODO store query meta data for later use
// return $data['count'];
// }
/**
* Inserts a document into an index
* @param string $index
* @param string $type
* @param string|array $data json string or array of data to store
* @param null $id the documents id. If not specified Id will be automatically choosen
* @param array $options
* @return mixed
* @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-index_.html
*/
public function insert($index, $type, $data, $id = null, $options = [])
{ {
if ($endPoint === null) { $body = is_array($data) ? Json::encode($data) : $data;
$endPoint = $this->api; if ($id !== null) {
} $response = $this->db->http()->put($this->createUrl([$index, $type, $id], $options), null, $body)->send();
if ($this->index === null && $this->type === null) { } else {
return '/' . $endPoint; $response = $this->db->http()->post($this->createUrl([$index, $type], $options), null, $body)->send();
} }
$index = $this->index; return Json::decode($response->getBody(true));
if ($index === null) {
$index = '_all';
} elseif (is_array($index)) {
$index = implode(',', $index);
}
$type = $this->type;
if (is_array($type)) {
$type = implode(',', $type);
}
return '/' . $index . '/' . (empty($type) ? '' : $type . '/') . $endPoint;
} }
public function queryAll() /**
* gets a document from the index
* @param $index
* @param $type
* @param $id
* @param array $options
* @return mixed
* @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-get.html
*/
public function get($index, $type, $id, $options = [])
{ {
$query = $this->query; $response = $this->db->http()->post($this->createUrl([$index, $type, $id], $options))->send();
if (empty($query)) { return Json::decode($response->getBody(true));
$query = '{}'; }
}
if (is_array($query)) { /**
$query = Json::encode($query); * gets a documents _source from the index (>=v0.90.1)
} * @param $index
$http = $this->db->http(); * @param $type
$response = $http->post($this->createUrl(), null, $query)->send(); * @param $id
$data = Json::decode($response->getBody(true)); * @return mixed
// TODO store query meta data for later use * @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-get.html#_source
$docs = array(); */
switch ($this->api) { public function getSource($index, $type, $id)
default: {
case '_search': $response = $this->db->http()->head($this->createUrl([$index, $type, $id]))->send();
if (isset($data['hits']['hits'])) { return Json::decode($response->getBody(true));
$docs = $data['hits']['hits']; }
}
break; // TODO mget http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-multi-get.html
case '_mget':
if (isset($data['docs'])) { /**
$docs = $data['docs']; * gets a document from the index
} * @param $index
break; * @param $type
} * @param $id
$rows = array(); * @return mixed
foreach($docs as $doc) { * @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-get.html
// TODO maybe return type info */
if (isset($doc['exists']) && !$doc['exists']) { public function exists($index, $type, $id)
continue; {
} $response = $this->db->http()->head($this->createUrl([$index, $type, $id]))->send();
$row = $doc['_source']; return $response->getStatusCode() == 200;
$row['id'] = $doc['_id'];
$rows[] = $row;
}
return $rows;
} }
public function queryOne() /**
* deletes a document from the index
* @param $index
* @param $type
* @param $id
* @param array $options
* @return mixed
* @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-delete.html
*/
public function delete($index, $type, $id, $options = [])
{ {
// TODO set limit $response = $this->db->http()->delete($this->createUrl([$index, $type, $id], $options))->send();
$rows = $this->queryAll(); return Json::decode($response->getBody(true));
return reset($rows);
} }
public function queryCount() /**
* updates a document
* @param $index
* @param $type
* @param $id
* @param array $options
* @return mixed
* @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-update.html
*/
public function update($index, $type, $id, $data, $options = [])
{ {
//http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-count.html // TODO
$query = $this->query; $response = $this->db->http()->delete($this->createUrl([$index, $type, $id], $options))->send();
if (empty($query)) { return Json::decode($response->getBody(true));
$query = ''; }
}
if (is_array($query)) { // TODO bulk http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-bulk.html
$query = Json::encode($query);
/**
* @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-create-index.html
*/
public function createIndex($index, $configuration = null)
{
$body = $configuration !== null ? Json::encode($configuration) : null;
$response = $this->db->http()->put($this->createUrl([$index]), null, $body)->send();
return Json::decode($response->getBody(true));
}
/**
* @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-delete-index.html
*/
public function deleteIndex($index)
{
$response = $this->db->http()->delete($this->createUrl([$index]))->send();
return Json::decode($response->getBody(true));
}
/**
* @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-delete-index.html
*/
public function deleteAllIndexes()
{
$response = $this->db->http()->delete($this->createUrl(['_all']))->send();
return Json::decode($response->getBody(true));
}
/**
* @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-exists.html
*/
public function indexExists($index)
{
$response = $this->db->http()->head($this->createUrl([$index]))->send();
return $response->getStatusCode() == 200;
}
/**
* @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-types-exists.html
*/
public function typeExists($index, $type)
{
$response = $this->db->http()->head($this->createUrl([$index, $type]))->send();
return $response->getStatusCode() == 200;
}
// TODO http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-aliases.html
// TODO http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-update-settings.html
// TODO http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-get-settings.html
// TODO http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-warmers.html
/**
* @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-open-close.html
*/
public function openIndex($index)
{
$response = $this->db->http()->post($this->createUrl([$index, '_open']))->send();
return $response->getStatusCode() == 200;
}
/**
* @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-open-close.html
*/
public function closeIndex($index)
{
$response = $this->db->http()->post($this->createUrl([$index, '_close']))->send();
return $response->getStatusCode() == 200;
}
/**
* @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-status.html
*/
public function getIndexStatus($index = '_all')
{
$response = $this->db->http()->get($this->createUrl([$index, '_status']))->send();
return Json::decode($response->getBody(true));
}
// TODO http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-stats.html
// http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-segments.html
/**
* @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-clearcache.html
*/
public function clearIndexCache($index)
{
$response = $this->db->http()->post($this->createUrl([$index, '_cache', 'clear']))->send();
return $response->getStatusCode() == 200;
}
/**
* @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-flush.html
*/
public function flushIndex($index)
{
$response = $this->db->http()->post($this->createUrl([$index, '_flush']))->send();
return $response->getStatusCode() == 200;
}
/**
* @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-refresh.html
*/
public function refreshIndex($index)
{
$response = $this->db->http()->post($this->createUrl([$index, '_refresh']))->send();
return $response->getStatusCode() == 200;
}
// TODO http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-optimize.html
// TODO http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-gateway-snapshot.html
/**
* http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-put-mapping.html
*/
public function setMapping($index, $type, $mapping)
{
$body = $mapping !== null ? Json::encode($mapping) : null;
$response = $this->db->http()->put($this->createUrl([$index, $type, '_mapping']), null, $body)->send();
return $response->getStatusCode() == 200;
}
/**
* http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-get-mapping.html
*/
public function getMapping($index = '_all', $type = '_all')
{
$response = $this->db->http()->get($this->createUrl([$index, $type, '_mapping']))->send();
return Json::decode($response->getBody(true));
}
/**
* http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-put-mapping.html
*/
public function deleteMapping($index, $type)
{
$response = $this->db->http()->delete($this->createUrl([$index, $type]))->send();
return $response->getStatusCode() == 200;
}
/**
* @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-get-field-mapping.html
*/
public function getFieldMapping($index, $type = '_all')
{
// TODO
$response = $this->db->http()->put($this->createUrl([$index, $type, '_mapping']))->send();
return Json::decode($response->getBody(true));
}
/**
* @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-analyze.html
*/
public function analyze($options, $index = null)
{
// TODO
$response = $this->db->http()->put($this->createUrl([$index, $type, '_mapping']))->send();
return Json::decode($response->getBody(true));
}
/**
* @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-templates.html
*/
public function createTemplate($name, $pattern, $settings, $mappings, $order = 0)
{
$body = Json::encode([
'template' => $pattern,
'order' => $order,
'settings' => (object) $settings,
'mappings' => (object) $settings,
]);
$response = $this->db->http()->put($this->createUrl(['_template', $name]), null, $body)->send();
return $response->getStatusCode() == 200;
}
/**
* @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-templates.html
*/
public function deleteTemplate($name)
{
$response = $this->db->http()->delete($this->createUrl(['_template', $name]))->send();
return $response->getStatusCode() == 200;
}
/**
* @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-templates.html
*/
public function getTemplate($name)
{
$response = $this->db->http()->get($this->createUrl(['_template', $name]))->send();
return Json::decode($response->getBody(true));
}
private function createUrl($path, $options = [])
{
$url = implode('/', array_map(function($a) {
return urlencode(is_array($a) ? implode(',', $a) : $a);
}, $path));
if (!empty($options)) {
$url .= '?' . http_build_query($options);
} }
$http = $this->db->http();
$response = $http->post($this->createUrl('_count'), null, $query)->send(); return $url;
$data = Json::decode($response->getBody(true));
// TODO store query meta data for later use
return $data['count'];
} }
} }
\ No newline at end of file
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