README

为了满足企业级 Symfony 应用与专业 Elasticsearch 集成的需求，创建了 Elasticsearch Bundle。这个扩展包是

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

技术亮点

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

如果您需要任何帮助，stack overflow 是询问 ONGR 扩展包和库的首选和推荐方式。

版本矩阵

文档

该扩展包的在线文档可以在 http://docs.ongr.io 找到。文档源存储在 repo 下的 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 扩展程序的搜索文档在这里可用。最后，您将决定要创建哪些令人惊叹的事物 😎。

故障排除

• 如何从旧版本升级？
• 如何覆盖扩展程序的一些部分？

许可证

此扩展程序根据 MIT 许可证授权。请参阅扩展程序中的完整许可证LICENSE文件。