README

Elasticsearch for Eloquent Laravel Models

Elasticquent 通过将 Eloquent 模型映射到 Elasticsearch 类型，简化了与 Elasticsearch 和 Eloquent 模型的交互。您可以使用默认设置或在模型中直接定义 Elasticsearch 应如何索引和搜索您的 Eloquent 模型。

Elasticquent 使用官方 Elasticsearch PHP API。要开始使用，您应该对 Elasticsearch 的工作原理有一定的了解（索引、类型、映射等）。

Elasticsearch 要求

您必须运行至少 Elasticsearch 1.0。Elasticsearch 0.9 及以下版本将无法工作，也不受支持。

报告问题

如果您发现任何问题，请随时通过 GitHub 的 bug 追踪器报告此项目的问题。

或者，fork 项目并提交 pull request :)

概述

Elasticquent 允许您轻松地将 Eloquent 模型索引和搜索其内容。

    $books = Book::where('id', '<', 200)->get();
    $books->addToIndex();

当您搜索时，您将获得一个 Eloquent 集合，其中包含一些特殊的功能，而不是一个普通的搜索结果数组。

    $books = Book::search('Moby Dick');
    echo $books->totalHits();

此外，您仍然可以使用所有 Eloquent 集合功能

    $books = $books->filter(function ($book) {
        return $book->hasISBN();
    });

请查看其余的文档，了解如何开始使用 Elasticsearch 和 Elasticquent！

Elasticquent 的工作原理

当使用数据库时，Eloquent 模型是从数据库表中读取的数据填充的。使用 Elasticquent，模型是通过在 Elasticsearch 中索引的数据进行填充的。使用 Elasticsearch 进行搜索的整个想法是它快速且轻量级，因此您的模型功能将由已索引的文档数据决定。

设置

在开始使用 Elasticquent 之前，请确保您已安装 Elasticsearch。

要开始使用，将 Elasticquent 添加到您的 composer.json 文件中

"elasticquent/elasticquent": "dev-master"

一旦运行了 composer update，您需要在 config/app.php 中注册 Laravel 服务提供者

'providers' => [
    ...
    Elasticquent\ElasticquentServiceProvider::class,
],

我们还提供用于连接到 Elasticsearch 客户端的 facade（使用我们的设置连接），如果需要，请在 config/app.php 中添加以下内容。

'aliases' => [
    ...
    'Es' => Elasticquent\ElasticquentElasticsearchFacade::class,
],

然后，将 Elasticquent 特性添加到任何您想要在 Elasticsearch 中索引的 Eloquent 模型中

use Elasticquent\ElasticquentTrait;

class Book extends Eloquent
{
    use ElasticquentTrait;
}

现在，您的 Eloquent 模型有一些额外的功能，这些功能使您更容易使用 Elasticsearch 索引模型数据。

Elasticsearch 配置

默认情况下，Elasticquent 将连接到 localhost:9200 并使用 default 作为索引名称，您可以在配置文件中更改此设置和其他设置。您可以在 Laravel 4 中将 elasticquent.php 配置文件添加到 /app/config/elasticquent.php，或者使用以下 Artisan 命令将配置文件发布到您的配置目录（Laravel 5）

$ php artisan vendor:publish --provider="Elasticquent\ElasticquentServiceProvider"

<?php

return array(

    /*
    |--------------------------------------------------------------------------
    | Custom Elasticsearch Client Configuration
    |--------------------------------------------------------------------------
    |
    | This array will be passed to the Elasticsearch client.
    | See configuration options here:
    |
    | http://www.elasticsearch.org/guide/en/elasticsearch/client/php-api/current/_configuration.html
    */

    'config' => [
        'hosts'     => ['localhost:9200'],
        'retries'   => 1,
    ],

    /*
    |--------------------------------------------------------------------------
    | Default Index Name
    |--------------------------------------------------------------------------
    |
    | This is the index name that Elastiquent will use for all
    | Elastiquent models.
    */

    'default_index' => 'my_custom_index_name',

);

索引和映射

虽然您当然可以通过 Elasticsearch API 来构建索引和映射，但您也可以使用一些辅助方法从模型中直接构建索引和类型。

如果您想要一种简单的方式来创建索引，Elasticquent 模型为此提供了一个功能

Book::createIndex($shards = null, $replicas = null);

对于自定义分析器，您可以在模型中设置一个 indexSettings 属性并从那里定义分析器

    /**
     * The elasticsearch settings.
     *
     * @var array
     */
    protected $indexSettings = [
        'analysis' => [
            'char_filter' => [
                'replace' => [
                    'type' => 'mapping',
                    'mappings' => [
                        '&=> and '
                    ],
                ],
            ],
            'filter' => [
                'word_delimiter' => [
                    'type' => 'word_delimiter',
                    'split_on_numerics' => false,
                    'split_on_case_change' => true,
                    'generate_word_parts' => true,
                    'generate_number_parts' => true,
                    'catenate_all' => true,
                    'preserve_original' => true,
                    'catenate_numbers' => true,
                ]
            ],
            'analyzer' => [
                'default' => [
                    'type' => 'custom',
                    'char_filter' => [
                        'html_strip',
                        'replace',
                    ],
                    'tokenizer' => 'whitespace',
                    'filter' => [
                        'lowercase',
                        'word_delimiter',
                    ],
                ],
            ],
        ],
    ];

对于映射，您可以在模型中设置一个 mappingProperties 属性并使用一些映射函数

protected $mappingProperties = array(
   'title' => array(
        'type' => 'string',
        'analyzer' => 'standard'
    )
);

如果您想根据映射属性设置模型类型映射，可以使用以下方法

    Book::putMapping($ignoreConflicts = true);

删除映射

    Book::deleteMapping();

重新构建（删除并重新添加，当您对映射进行重要更改时很有用）映射

    Book::rebuildMapping();

您还可以获取类型映射并检查它是否存在。

    Book::mappingExists();
    Book::getMapping();

设置自定义索引名称

默认情况下，Elasticquent 将在您的配置文件中查找 default_index 键（config/elasticquent.php）。要设置要使用的索引的默认值，您可以编辑此文件并设置 default_index 键

return array(

   // Other configuration keys ...
   
   /*
    |--------------------------------------------------------------------------
    | Default Index Name
    |--------------------------------------------------------------------------
    |
    | This is the index name that Elastiquent will use for all
    | Elastiquent models.
    */
    
   'default_index' => 'my_custom_index_name',
);

如果您想有一个更动态的索引，也可以在 Eloquent 模型内部使用 getIndexName 方法覆盖默认配置

function getIndexName()
{
    return 'custom_index_name';
}

注意：如果没有指定索引，Elasticquent 将使用值为 default 的硬编码字符串。

设置自定义类型名称

默认情况下，Elasticquent 将使用模型表的名称作为索引的类型名称。如果您想覆盖它，可以使用 getTypeName 函数。

function getTypeName()
{
    return 'custom_type_name';
}

要检查 Elasticquent 模型的类型是否存在，请使用 typeExists

    $typeExists = Book::typeExists();

索引文档

要索引 Eloquent 模型中的所有条目，请使用 addAllToIndex

    Book::addAllToIndex();

您还可以索引模型集合

    $books = Book::where('id', '<', 200)->get();
    $books->addToIndex();

您还可以索引单个条目

    $book = Book::find($id);
    $book->addToIndex();

您还可以重新索引整个模型

    Book::reindex();

搜索

Elasticquent 中有三种搜索方式。所有三种方法都返回一个搜索集合。

简单术语搜索

第一种方法是一个简单术语搜索，搜索所有字段。

    $books = Book::search('Moby Dick');

基于查询的搜索

第二种是基于查询的搜索，用于更复杂的搜索需求

    public static function searchByQuery($query = null, $aggregations = null, $sourceFields = null, $limit = null, $offset = null, $sort = null)

示例

    $books = Book::searchByQuery(array('match' => array('title' => 'Moby Dick')));

以下是可用参数的列表

query - 您的 ElasticSearch 查询
aggregations - 您希望返回的聚合。有关聚合的详细信息，请参阅聚合。
sourceFields - 仅将返回集限制为所选字段
limit - 要返回的记录数
offset - 设置记录偏移量（用于分页结果）
sort - 您的排序查询

原始查询

最后一种方法是发送到 Elasticsearch 的原始查询。此方法在搜索 Elasticsearch 内部的记录时提供了最大的灵活性

    $books = Book::complexSearch(array(
        'body' => array(
            'query' => array(
                'match' => array(
                    'title' => 'Moby Dick'
                )
            )
        )
    ));

这相当于

    $books = Book::searchByQuery(array('match' => array('title' => 'Moby Dick')));

搜索集合

当您在 Elasticquent 模型上搜索时，您会得到一个带有一些特殊功能的搜索集合。

您可以获取总命中数

    $books->totalHits();

访问碎片数组

    $books->shards();

访问最大分数

    $books->maxScore();

访问超时布尔属性

    $books->timedOut();

并访问 took 属性

    $books->took();

并访问搜索聚合 - 有关聚合的详细信息，请参阅聚合

    $books->getAggregations();

搜索集合文档

搜索结果集合中的项将包含来自 Elasticsearch 的某些额外数据。您可以使用 isDocument 函数始终检查模型是否是文档

    $book->isDocument();

您可以使用以下方式检查 Elasticsearch 分配给此文档的文档分数

    $book->documentScore();

从 Elastiquent 分块结果

类似于 Illuminate\Support\Collection，chunk 方法将 Elasticquent 集合拆分为多个给定大小的更小的集合

    $all_books = Book::searchByQuery(array('match' => array('title' => 'Moby Dick')));
    $books = $all_books->chunk(10);

在 Elasticquent 之外使用搜索集合

如果您正在处理 Elasticquent 外部的原始搜索数据，您可以使用 Elasticquent 搜索结果集合将那些数据转换为集合。

$client = new \Elasticsearch\Client();

$params = array(
    'index' => 'default',
    'type'  => 'books'
);

$params['body']['query']['match']['title'] = 'Moby Dick';

$collection = Book::hydrateElasticsearchResult($client->search($params));

路线图

弹性队列目前需要

模拟ES API调用的测试。
路由支持

yunmyo / elasticquent

维护者

详细信息