README

Elasticsearch Bundle 的创建旨在满足企业级 Symfony 应用程序中专业 Elasticsearch 集成的需求。此组件是

• 使用官方的 elasticsearch-php 客户端。
• 确保与 Symfony 框架和 Symfony Flex 的完全集成。

技术亮点

• 提供了一种 DSL 查询构建器，以目标化的方式表示所有 ElasticSearch 端点。
• 通过 CLI 命令（ongr:es:document:generate）提供交互式文档对象生成器。
• 创建了一种类似于 Doctrine 的方式来处理文档（实体）文档对象映射，使用注解。
• 提供几个查询结果迭代器，方便您处理结果。
• 提供索引管理和数据导入/导出/重新索引的 CLI 命令行界面。
• Profiler 与 Symfony 调试栏集成，显示所有执行的查询。
• 以可扩展的方式设计，满足您的所有自定义需求。
• 支持 Symfony FLEX。

如果您需要任何帮助，stack overflow 是获取答案的首选方式。这是询问 ONGR 组件和库问题的首选和推荐方式。

如果您喜欢这个库，请通过购买一杯咖啡帮助我开发它。

版本矩阵

文档

该组件的在线文档可以在 http://docs.ongr.io 找到。文档源存储在 repo 中的 Resources/doc/ 目录下，所以如果您发现错别字或某些不准确之处，请提交 PR 或至少提交一个 issue 以修复它！

有关对文档的贡献，您可以在 contribute 主题中找到。

常见问题解答

• 索引映射
• 配置
• 控制台命令
• 如何执行简单的 CRUD 操作
• 快速查找功能
• 如何在索引中执行搜索
• 解析结果

设置组件

步骤 1：安装 Elasticsearch 组件

Elasticsearch 组件使用 Composer 安装。

php composer.phar require ongr/elasticsearch-bundle "~6.0"

有关安装和部署 Elasticsearch 的说明，请参阅 Elasticsearch 安装页面。

在 AppKernel 中启用 ElasticSearch 组件

<?php
// config/bundles.php

return [
    // ...
    ONGR\ElasticsearchBundle\ONGRElasticsearchBundle::class => ['all' => true],
];

(可选) 步骤 2：添加配置

添加 Elasticsearch 组件的最小配置。

# config/packages/ongr_elasticsearch.yaml
ongr_elasticsearch:
    analysis:
        filter:
            edge_ngram_filter: #-> your custom filter name to use in the analyzer below
                type: edge_ngram 
                min_gram: 1
                max_gram: 20
        analyzer:
            eNgramAnalyzer: #-> analyzer name to use in the document field
                type: custom
                tokenizer: standard
                filter:
                    - lowercase
                    - edge_ngram_filter #that's the filter defined earlier
    indexes:
        App\Document\Product:
            hosts: [elasticsearch:9200] # optional, the default is 127.0.0.1:9200

这只是一个非常基本的示例，有关更多信息，请参阅 配置 章节。

步骤 3：定义您的 Elasticsearch 类型为 Document 对象

此组件使用对象来表示 Elasticsearch 文档。让我们为 products 索引创建一个 Product 类。

// src/Document/Product.php

namespace App\Document;

use ONGR\ElasticsearchBundle\Annotation as ES;

/**
 * //alias and default parameters in the annotation are optional. 
 * @ES\Index(alias="products", default=true)
 */
class Product
{
    /**
     * @ES\Id()
     */
    public $id;

    /**
     * @ES\Property(type="text", analyzer="eNgramAnalyzer")
     */
    public $title;

    /**
     * @ES\Property(type="float")
     */
    public $price;
}

这只是一个基本示例，有关映射的更多信息，请参阅 映射章节。

步骤 4：创建索引和映射

Elasticsearch 组件提供了一些 CLI 命令。其中一个用于创建索引，在终端运行该命令

bin/console ongr:es:index:create

现在，应该已创建具有您文档字段的 products 索引。

关于其他命令的更多信息，可以在命令章节中找到。

第5步：享受Elasticsearch带来的乐趣

Elasticsearch bundle的完整文档在这里可供查阅。希望您能用它创造出令人惊叹的事物 😎。

请注意，将bundle的文档更新到6.0版本的过程仍在进行中。请阅读已经更新的配置和CRUD部分，这将使您能够使用bundle的基本功能。我们将尽快更新其余的文档

故障排除

• 如何升级到旧版本？
• 如何覆盖bundle的一些部分？

许可证

此bundle使用MIT许可证授权。请参阅bundle中的完整LICENSE文件。