gbprod / elasticsearch-dataprovider-bundle

此包已被放弃,不再维护。未建议替代包。

使用 Symfony 容易在 Elasticsearch 索引中提供数据的包

v0.1.0 2016-04-09 16:28 UTC

This package is auto-updated.

Last update: 2020-06-07 07:56:59 UTC


README

stability-deprecated

我将不再维护此包,建议使用 elastica-provider-bundle

使用 M6Web elasticsearch bundle 通过 Symfony 在 Elasticsearch 索引中轻松提供数据的包。

Build Status Code Coverage Scrutinizer Code Quality

Latest Stable Version Total Downloads Latest Unstable Version License

安装

使用 composer 下载包

composer require gbprod/elasticsearch-dataprovider-bundle

在您的 app/AppKernel.php 文件中声明

<?php
// app/AppKernel.php

public function registerBundles()
{
    $bundles = array(
        new M6Web\Bundle\ElasticsearchBundle\M6WebElasticsearchBundle(),
        new GBProd\ElasticsearchDataProviderBundle\ElasticsearchDataProviderBundle(),
    );
}

用法

配置 Elasticsearch 客户端

有关配置客户端的信息,请参阅 M6WebElasticsearchBundle

创建数据提供者

<?php

namespace GBProd\AcmeBundle\DataProvider;

use GBProd\ElasticsearchDataProviderBundle\DataProvider\BulkDataProvider;

class SuperHeroDataProvider extends BulkDataProvider
{
    protected function populate()
    {
        $this->index(
            'Spider-Man', // id of the document
            [
                "name" => "Spider-Man",
                "description" => "Bitten by a radioactive spider, high school student Peter Parker gained the speed, strength and powers of a spider. Adopting the name Spider-Man, Peter hoped to start a career using his new abilities. Taught that with great power comes great responsibility, Spidey has vowed to use his powers to help people.",
            ]
        );

        $this->update(
            'Hulk',
            [
                "name" => "Hulk",
                "description" => "Caught in a gamma bomb explosion while trying to save the life of a teenager, Dr. Bruce Banner was transformed into the incredibly powerful creature called the Hulk. An all too often misunderstood hero, the angrier the Hulk gets, the stronger the Hulk gets.",
            ]
        );

        $this->create(
            'Thor',
            [
                "name" => "Thor",
                "description" => "As the Norse God of thunder and lightning, Thor wields one of the greatest weapons ever made, the enchanted hammer Mjolnir. While others have described Thor as an over-muscled, oafish imbecile, he's quite smart and compassionate.  He's self-assured, and he would never, ever stop fighting for a worthwhile cause.",
            ]
        );

        $this->delete('Captain America');
    }

    public function count()
    {
        return 4;
    }
}

注册您的提供者

# AcmeBundle/Resources/config/services.yml

services:
    acme_bundle.superhero_dataprovider:
        class: GBProd\AcmeBundle\DataProvider\SuperHeroDataProvider
        tags:
            - { name: elasticsearch.dataprovider, index: app, type: superheros }

提供

php app/console elasticsearch:provide app superheros

您还可以提供一个完整的索引

php app/console elasticsearch:provide app

或运行所有提供者

php app/console elasticsearch:provide

您可以设置特定的客户端(如果不是默认的)来使用

php app/console elasticsearch:provide app superheros --client=my_client

使用 doctrine 的示例

<?php

namespace GBProd\AcmeBundle\DataProvider;

use GBProd\ElasticsearchDataProviderBundle\DataProvider\BulkDataProvider;
use Doctrine\ORM\EntityManager;

class SuperHeroDataProvider extends BulkDataProvider
{
    private $em;

    public function __construct(EntityManager $em)
    {
        $this->em = $em;
    }

    protected function populate()
    {
        $query = $this->em->createQuery('SELECT s FROM AcmeBundle\Model\SuperHero s');

        $results = $query->iterate();
        foreach ($results as $row) {
            $this->index(
                $row[0],
                [
                    "name" => $row[0],
                    "description" => $row[1],
                ]
            );

            $this->em->detach($row[0]);
        }
    }

    public function count()
    {
        $query = $this->em
            ->createQuery('SELECT COUNT(s.id) FROM AcmeBundle\Model\SuperHero s')
        ;

        return $query->getSingleScalarResult();
    }
}
# AcmeBundle/Resources/config/services.yml

services:
    acme_bundle.superhero_dataprovider:
        class: GBProd\AcmeBundle\DataProvider\SuperHeroDataProvider
        arguments:
            - '@doctrine.orm.entity_manager'
        tags:
            - { name: elasticsearch.dataprovider, index: app, type: superheros }

更改批量大小

当向 Elasticsearch 提供数据时,批量大小很重要。请确保您的节点设置了良好的批量大小。默认批量大小为 1000,您可以通过设置标签的批量条目来更改设置。

# AcmeBundle/Resources/config/services.yml

services:
    acme_bundle.superhero_dataprovider:
        class: GBProd\AcmeBundle\DataProvider\SuperHeroDataProvider
        calls:
            - ['changeBulkSize', 42]
        tags:
            - { name: elasticsearch.dataprovider, index: app, type: superheros }

或直接在提供者内部。

<?php

namespace GBProd\AcmeBundle\DataProvider;

use GBProd\ElasticsearchDataProviderBundle\DataProvider\BulkDataProvider;

class SuperHeroDataProvider extends BulkDataProvider
{
    public function __construct()
    {
        $this->changeBulkSize(42);
    }

    protected function populate()
    {
        // ...
    }
}

关于 count 方法

实现 count 方法不是强制性的,但它允许您在提供者运行时有一个漂亮的进度条。

<?php

namespace GBProd\AcmeBundle\DataProvider;

use GBProd\ElasticsearchDataProviderBundle\DataProvider\BulkDataProvider;

class SuperHeroDataProvider extends BulkDataProvider
{
    protected function populate()
    {
        // ...
    }

    public function count()
    {
        return 2;
    }
}