Elasticsearch Class Reference

Public Member Functions
	__construct (\Magento\Elasticsearch\SearchAdapter\ConnectionManager $connectionManager, DataMapperInterface $documentDataMapper, FieldMapperInterface $fieldMapper, \Magento\Elasticsearch\Model\Config $clientConfig, \Magento\Elasticsearch\Model\Adapter\Index\BuilderInterface $indexBuilder, \Psr\Log\LoggerInterface $logger, \Magento\Elasticsearch\Model\Adapter\Index\IndexNameResolver $indexNameResolver, $options=[], BatchDataMapperInterface $batchDocumentDataMapper=null)
	ping ()
	prepareDocsPerStore (array $documentData, $storeId)
	addDocs (array $documents, $storeId, $mappedIndexerId)
	cleanIndex ($storeId, $mappedIndexerId)
	deleteDocs (array $documentIds, $storeId, $mappedIndexerId)
	checkIndex ( $storeId, $mappedIndexerId, $checkAlias=true)
	updateAlias ($storeId, $mappedIndexerId)

Data Fields
const	BULK_ACTION_INDEX = 'index'
const	BULK_ACTION_CREATE = 'create'
const	BULK_ACTION_DELETE = 'delete'
const	BULK_ACTION_UPDATE = 'update'

Protected Member Functions
	getDocsArrayInBulkIndexFormat ( $documents, $indexName, $action=self::BULK_ACTION_INDEX)
	prepareIndex ($storeId, $indexName, $mappedIndexerId)

Protected Attributes
	$connectionManager
	$documentDataMapper
	$indexNameResolver
	$fieldMapper
	$clientConfig
	$client
	$indexBuilder
	$logger
	$preparedIndex = []

Detailed Description

Elasticsearch adapter @SuppressWarnings(PHPMD.CouplingBetweenObjects)

Definition at line 15 of file Elasticsearch.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Elasticsearch\SearchAdapter\ConnectionManager	$connectionManager,
		DataMapperInterface	$documentDataMapper,
		FieldMapperInterface	$fieldMapper,
		\Magento\Elasticsearch\Model\Config	$clientConfig,
		\Magento\Elasticsearch\Model\Adapter\Index\BuilderInterface	$indexBuilder,
		\Psr\Log\LoggerInterface	$logger,
		\Magento\Elasticsearch\Model\Adapter\Index\IndexNameResolver	$indexNameResolver,
			$options = [],
		BatchDataMapperInterface	$batchDocumentDataMapper = null
	)

Constructor for Elasticsearch adapter.

Parameters

\Magento\Elasticsearch\SearchAdapter\ConnectionManager	$connectionManager
DataMapperInterface	$documentDataMapper
FieldMapperInterface	$fieldMapper
\Magento\Elasticsearch\Model\Config	$clientConfig
\Magento\Elasticsearch\Model\Adapter\Index\BuilderInterface	$indexBuilder
\Psr\Log\LoggerInterface	$logger
\Magento\Elasticsearch\Model\Adapter\Index\IndexNameResolver	$indexNameResolver
array	$options
BatchDataMapperInterface	$batchDocumentDataMapper

Exceptions

Definition at line 94 of file Elasticsearch.php.

      {
        $this->connectionManager = $connectionManager;
        $this->documentDataMapper = $documentDataMapper;
        $this->fieldMapper = $fieldMapper;
        $this->clientConfig = $clientConfig;
        $this->indexBuilder = $indexBuilder;
        $this->logger = $logger;
        $this->indexNameResolver = $indexNameResolver;
        $this->batchDocumentDataMapper = $batchDocumentDataMapper ?:
            ObjectManager::getInstance()->get(BatchDataMapperInterface::class);

        try {
            $this->client = $this->connectionManager->getConnection($options);
        } catch (\Exception $e) {
            $this->logger->critical($e);
            throw new \Magento\Framework\Exception\LocalizedException(
                __('The search failed because of a search engine misconfiguration.')
            );
        }
    }

Member Function Documentation

addDocs()

addDocs	(	array	$documents,
			$storeId,
			$mappedIndexerId
	)

Add prepared Elasticsearch documents to Elasticsearch index

Parameters

array	$documents
int	$storeId
string	$mappedIndexerId

Returns

$this

Exceptions

Definition at line 171 of file Elasticsearch.php.

    {
        if (count($documents)) {
            try {
                $indexName = $this->indexNameResolver->getIndexName($storeId, $mappedIndexerId, $this->preparedIndex);
                $bulkIndexDocuments = $this->getDocsArrayInBulkIndexFormat($documents, $indexName);
                $this->client->bulkQuery($bulkIndexDocuments);
            } catch (\Exception $e) {
                $this->logger->critical($e);
                throw $e;
            }
        }

        return $this;
    }

checkIndex()

checkIndex	(		$storeId,
			$mappedIndexerId,
			$checkAlias = true
	)

Checks whether Elasticsearch index and alias exists.

Parameters

int	$storeId
string	$mappedIndexerId
bool	$checkAlias

Returns

$this

Definition at line 291 of file Elasticsearch.php.

      {
        // create new index for store
        $indexName = $this->indexNameResolver->getIndexName($storeId, $mappedIndexerId, $this->preparedIndex);
        if (!$this->client->indexExists($indexName)) {
            $this->prepareIndex($storeId, $indexName, $mappedIndexerId);
        }

        // add index to alias
        if ($checkAlias) {
            $namespace = $this->indexNameResolver->getIndexNameForAlias($storeId, $mappedIndexerId);
            if (!$this->client->existsAlias($namespace, $indexName)) {
                $this->client->updateAlias($namespace, $indexName);
            }
        }
        return $this;
    }

cleanIndex()

cleanIndex	(		$storeId,
			$mappedIndexerId
	)

Removes all documents from Elasticsearch index

Parameters

int	$storeId
string	$mappedIndexerId

Returns

$this

Definition at line 194 of file Elasticsearch.php.

    {
        $this->checkIndex($storeId, $mappedIndexerId, true);
        $indexName = $this->indexNameResolver->getIndexName($storeId, $mappedIndexerId, $this->preparedIndex);
        if ($this->client->isEmptyIndex($indexName)) {
            // use existing index if empty
            return $this;
        }

        // prepare new index name and increase version
        $indexPattern = $this->indexNameResolver->getIndexPattern($storeId, $mappedIndexerId);
        $version = intval(str_replace($indexPattern, '', $indexName));
        $newIndexName = $indexPattern . ++$version;

        // remove index if already exists
        if ($this->client->indexExists($newIndexName)) {
            $this->client->deleteIndex($newIndexName);
        }

        // prepare new index
        $this->prepareIndex($storeId, $newIndexName, $mappedIndexerId);

        return $this;
    }

deleteDocs()

deleteDocs	(	array	$documentIds,
			$storeId,
			$mappedIndexerId
	)

Delete documents from Elasticsearch index by Ids

Parameters

array	$documentIds
int	$storeId
string	$mappedIndexerId

Returns

$this

Exceptions

Definition at line 228 of file Elasticsearch.php.

    {
        try {
            $this->checkIndex($storeId, $mappedIndexerId, false);
            $indexName = $this->indexNameResolver->getIndexName($storeId, $mappedIndexerId, $this->preparedIndex);
            $bulkDeleteDocuments = $this->getDocsArrayInBulkIndexFormat(
                $documentIds,
                $indexName,
                self::BULK_ACTION_DELETE
            );
            $this->client->bulkQuery($bulkDeleteDocuments);
        } catch (\Exception $e) {
            $this->logger->critical($e);
            throw $e;
        }

        return $this;
    }

getDocsArrayInBulkIndexFormat()

getDocsArrayInBulkIndexFormat (   $documents,   $indexName,   $action = self::BULK_ACTION_INDEX  )

protected

Reformat documents array to bulk format

Parameters

array	$documents
string	$indexName
string	$action

Returns

array

Definition at line 255 of file Elasticsearch.php.

      {
        $bulkArray = [
            'index' => $indexName,
            'type' => $this->clientConfig->getEntityType(),
            'body' => [],
            'refresh' => true,
        ];

        foreach ($documents as $id => $document) {
            $bulkArray['body'][] = [
                $action => [
                    '_id' => $id,
                    '_type' => $this->clientConfig->getEntityType(),
                    '_index' => $indexName
                ]
            ];
            if ($action == self::BULK_ACTION_INDEX) {
                $bulkArray['body'][] = $document;
            }
        }

        return $bulkArray;
    }

ping()

ping

(

)

Retrieve Elasticsearch server status

Returns

bool

Exceptions

Definition at line 131 of file Elasticsearch.php.

    {
        try {
            $response = $this->client->ping();
        } catch (\Exception $e) {
            throw new \Magento\Framework\Exception\LocalizedException(
                __('Could not ping search engine: %1', $e->getMessage())
            );
        }
        return $response;
    }

prepareDocsPerStore()

prepareDocsPerStore	(	array	$documentData,
			$storeId
	)

Create Elasticsearch documents by specified data

Parameters

array	$documentData
int	$storeId

Returns

array

Definition at line 150 of file Elasticsearch.php.

    {
        $documents = [];
        if (count($documentData)) {
            $documents = $this->batchDocumentDataMapper->map(
                $documentData,
                $storeId
            );
        }
        return $documents;
    }

prepareIndex()

prepareIndex (   $storeId,   $indexName,   $mappedIndexerId  )

protected

Create new index with mapping.

Parameters

int	$storeId
string	$indexName
string	$mappedIndexerId

Returns

$this

Definition at line 352 of file Elasticsearch.php.

    {
        $this->indexBuilder->setStoreId($storeId);
        $settings = $this->indexBuilder->build();
        $allAttributeTypes = $this->fieldMapper->getAllAttributesTypes([
            'entityType' => $mappedIndexerId,
            // Use store id instead of website id from context for save existing fields mapping.
            // In future websiteId will be eliminated due to index stored per store
            'websiteId' => $storeId
        ]);
        $settings['index']['mapping']['total_fields']['limit'] = $this->getMappingTotalFieldsLimit($allAttributeTypes);
        $this->client->createIndex($indexName, ['settings' => $settings]);
        $this->client->addFieldsMapping(
            $allAttributeTypes,
            $indexName,
            $this->clientConfig->getEntityType()
        );
        $this->preparedIndex[$storeId] = $indexName;
        return $this;
    }

updateAlias()

updateAlias	(		$storeId,
			$mappedIndexerId
	)

Update Elasticsearch alias for new index.

Parameters

int	$storeId
string	$mappedIndexerId

Returns

$this

Definition at line 319 of file Elasticsearch.php.

    {
        if (!isset($this->preparedIndex[$storeId])) {
            return $this;
        }

        $oldIndex = $this->indexNameResolver->getIndexFromAlias($storeId, $mappedIndexerId);
        if ($oldIndex == $this->preparedIndex[$storeId]) {
            $oldIndex = '';
        }

        $this->client->updateAlias(
            $this->indexNameResolver->getIndexNameForAlias($storeId, $mappedIndexerId),
            $this->preparedIndex[$storeId],
            $oldIndex
        );

        // remove obsolete index
        if ($oldIndex) {
            $this->client->deleteIndex($oldIndex);
        }

        return $this;
    }

Field Documentation

$client

$client

protected

Definition at line 58 of file Elasticsearch.php.

$clientConfig

$clientConfig

protected

Definition at line 53 of file Elasticsearch.php.

$connectionManager

$connectionManager

protected

#-

Definition at line 32 of file Elasticsearch.php.

$documentDataMapper

$documentDataMapper

protected

Definition at line 38 of file Elasticsearch.php.

$fieldMapper

$fieldMapper

protected

Definition at line 48 of file Elasticsearch.php.

$indexBuilder

$indexBuilder

protected

Definition at line 63 of file Elasticsearch.php.

$indexNameResolver

$indexNameResolver

protected

Definition at line 43 of file Elasticsearch.php.

$logger

$logger

protected

Definition at line 68 of file Elasticsearch.php.

$preparedIndex

$preparedIndex = []

protected

Definition at line 73 of file Elasticsearch.php.

BULK_ACTION_CREATE

const BULK_ACTION_CREATE = 'create'

Definition at line 21 of file Elasticsearch.php.

BULK_ACTION_DELETE

const BULK_ACTION_DELETE = 'delete'

Definition at line 22 of file Elasticsearch.php.

BULK_ACTION_INDEX

const BULK_ACTION_INDEX = 'index'

#+ Text flags for Elasticsearch bulk actions

Definition at line 20 of file Elasticsearch.php.

BULK_ACTION_UPDATE

const BULK_ACTION_UPDATE = 'update'

Definition at line 23 of file Elasticsearch.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/module-elasticsearch/Model/Adapter/Elasticsearch.php