README

Elasticsearch Bundle 是为了满足专业级 Elasticsearch 集成到企业级 Symfony 应用程序的需求而创建的。此包是

• 由 ONGR.io 开发团队支持。
• 使用官方 elasticsearch-php 客户端。
• 确保与 Symfony 框架的完全集成。

技术亮点

• 通过 CLI (ongr:es:document:generate) 提供交互式文档对象生成器。
• 提供 DSL 查询构建器，由类型仓库服务执行。
• 使用注解进行 Doctrine 类似的文档（实体）文档对象映射。
• 提供查询结果迭代器以方便使用。
• 提供索引和类型管理以及数据导入/导出的控制台 CLI 命令。
• 分析器与 Symfony 调试栏集成并显示所有执行的查询。
• 以可扩展的方式设计，以满足您的所有自定义需求。

如果您需要任何帮助，请通过 stack overflow 提问，这是首选和推荐的方式。

版本矩阵

文档

该包的在线文档可以在 http://docs.ongr.io 找到。文档源存储在代码库中的 Resources/doc/ 目录下，所以如果您看到错误或问题，请提交 PR 修复它！

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

常见问题解答

• 映射解释
• 使用元字段
• 配置
• 控制台命令
• 如何执行简单的 CRUD 操作
• 快速查找功能
• 如何搜索索引
• 遍历索引
• 解析结果

设置包

步骤 1：安装 Elasticsearch 扩展包

Elasticsearch 扩展包使用 Composer 安装。

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

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

在 AppKernel 中启用 Elasticsearch 扩展包

// app/AppKernel.php

public function registerBundles()
{
    $bundles = [
        // ...
        new ONGR\ElasticsearchBundle\ONGRElasticsearchBundle(),
    ];
    
    // ...
}

步骤 2：添加配置

添加 Elasticsearch 扩展包的最小配置。

# app/config/config.yml

ongr_elasticsearch:
    managers:
        default:
            index:
                index_name: acme
            mappings:
                - AppBundle

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

在此特定示例中，您应该了解两个要点。索引节点中的索引名称和映射。映射是存储文档的地方（更多信息请参阅 映射章节）。

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

此扩展包使用对象来表示 Elasticsearch 文档。让我们为客户文档创建一个 Customer 类。

// src/AppBundle/Document/Customer.php

namespace AppBundle\Document;

use ONGR\ElasticsearchBundle\Annotation as ES;

/**
 * @ES\Document()
 */
class Customer
{
    /**
     * @var string
     *
     * @ES\Id()
     */
    public $id;

    /**
     * @var string
     *
     * @ES\Property(type="text")
     */
    public $name;
}

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

步骤 4：创建索引和映射

Elasticsearch 扩展包提供了几个 CLI 命令。其中之一是用于创建索引，请在终端中运行命令

bin/console ongr:es:index:create

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

第5步：享受使用Elasticsearch的乐趣

我们建议您查看映射章节来配置索引。Elasticsearch bundle的搜索文档在此处可用。最后，您将决定要创建哪些令人惊叹的事物 😎。

故障排除

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

许可证

此bundle受MIT许可证许可。请参阅bundle中的完整许可证LICENSE文件。