Elasticsearch Class Reference

Inheritance diagram for Elasticsearch:

Public Member Functions
	__construct ( $options=[], $elasticsearchClient=null)
	ping ()
	testConnection ()
	bulkQuery ($query)
	createIndex ($index, $settings)
	deleteIndex ($index)
	isEmptyIndex ($index)
	updateAlias ($alias, $newIndex, $oldIndex='')
	indexExists ($index)
	existsAlias ($alias, $index='')
	getAlias ($alias)
	addFieldsMapping (array $fields, $index, $entityType)
	deleteMapping ($index, $entityType)
	query ($query)
	suggest ($query)

Detailed Description

Elasticsearch client

Definition at line 14 of file Elasticsearch.php.

Constructor & Destructor Documentation

__construct()

__construct	(		$options = [],
			$elasticsearchClient = null
	)

Initialize Elasticsearch Client

Parameters

array	$options
\Elasticsearch\Client | null	$elasticsearchClient

Exceptions

LocalizedException

Definition at line 45 of file Elasticsearch.php.

      {
        if (empty($options['hostname']) || ((!empty($options['enableAuth']) &&
                    ($options['enableAuth'] == 1)) && (empty($options['username']) || empty($options['password'])))) {
            throw new LocalizedException(
                __('The search failed because of a search engine misconfiguration.')
            );
        }

        if (!($elasticsearchClient instanceof \Elasticsearch\Client)) {
            $config = $this->buildConfig($options);
            $elasticsearchClient = \Elasticsearch\ClientBuilder::fromConfig($config, true);
        }
        $this->client[getmypid()] = $elasticsearchClient;
        $this->clientOptions = $options;
    }

Member Function Documentation

addFieldsMapping()

addFieldsMapping	(	array	$fields,
			$index,
			$entityType
	)

Add mapping to Elasticsearch index

Parameters

array	$fields
string	$index
string	$entityType

Returns

void

Definition at line 246 of file Elasticsearch.php.

    {
        $params = [
            'index' => $index,
            'type' => $entityType,
            'body' => [
                $entityType => [
                    '_all' => $this->prepareFieldInfo([
                        'enabled' => true,
                        'type' => 'text',
                    ]),
                    'properties' => [],
                    'dynamic_templates' => [
                        [
                            'price_mapping' => [
                                'match' => 'price_*',
                                'match_mapping_type' => 'string',
                                'mapping' => [
                                    'type' => 'float',
                                    'store' => true,
                                ],
                            ],
                        ],
                        [
                            'string_mapping' => [
                                'match' => '*',
                                'match_mapping_type' => 'string',
                                'mapping' => $this->prepareFieldInfo([
                                    'type' => 'text',
                                    'index' => false,
                                ]),
                            ],
                        ],
                        [
                            'position_mapping' => [
                                'match' => 'position_*',
                                'match_mapping_type' => 'string',
                                'mapping' => [
                                    'type' => 'int',
                                ],
                            ],
                        ],
                    ],
                ],
            ],
        ];
        foreach ($fields as $field => $fieldInfo) {
            $params['body'][$entityType]['properties'][$field] = $this->prepareFieldInfo($fieldInfo);
        }

        $this->getClient()->indices()->putMapping($params);
    }

bulkQuery()

bulkQuery

(

$query

)

Performs bulk query over Elasticsearch index

Parameters

array

$query

Returns

void

Definition at line 133 of file Elasticsearch.php.

    {
        $this->getClient()->bulk($query);
    }

createIndex()

createIndex	(		$index,
			$settings
	)

Creates an Elasticsearch index.

Parameters

string	$index
array	$settings

Returns

void

Definition at line 145 of file Elasticsearch.php.

    {
        $this->getClient()->indices()->create([
            'index' => $index,
            'body' => $settings,
        ]);
    }

deleteIndex()

deleteIndex

(

$index

)

Delete an Elasticsearch index.

Parameters

string

$index

Returns

void

Definition at line 159 of file Elasticsearch.php.

    {
        $this->getClient()->indices()->delete(['index' => $index]);
    }

deleteMapping()

deleteMapping	(		$index,
			$entityType
	)

Delete mapping in Elasticsearch index

Parameters

string	$index
string	$entityType

Returns

void

Definition at line 330 of file Elasticsearch.php.

    {
        $this->getClient()->indices()->deleteMapping([
            'index' => $index,
            'type' => $entityType,
        ]);
    }

existsAlias()

existsAlias	(		$alias,
			$index = ''
	)

Exists alias.

Parameters

string	$alias
string	$index

Returns

bool

Definition at line 218 of file Elasticsearch.php.

    {
        $params = ['name' => $alias];
        if ($index) {
            $params['index'] = $index;
        }
        return $this->getClient()->indices()->existsAlias($params);
    }

getAlias()

getAlias

(

$alias

)

Get alias.

Parameters

string

$alias

Returns

array

Definition at line 233 of file Elasticsearch.php.

    {
        return $this->getClient()->indices()->getAlias(['name' => $alias]);
    }

indexExists()

indexExists

(

$index

)

Checks whether Elasticsearch index exists

Parameters

string

$index

Returns

bool

Definition at line 206 of file Elasticsearch.php.

    {
        return $this->getClient()->indices()->exists(['index' => $index]);
    }

isEmptyIndex()

isEmptyIndex

(

$index

)

Check if index is empty.

Parameters

string

$index

Returns

bool

Definition at line 170 of file Elasticsearch.php.

    {
        $stats = $this->getClient()->indices()->stats(['index' => $index, 'metric' => 'docs']);
        if ($stats['indices'][$index]['primaries']['docs']['count'] == 0) {
            return true;
        }
        return false;
    }

ping()

ping

(

)

Ping the Elasticsearch client

Returns

bool

Definition at line 84 of file Elasticsearch.php.

    {
        if ($this->pingResult === null) {
            $this->pingResult = $this->getClient()->ping(['client' => ['timeout' => $this->clientOptions['timeout']]]);
        }

        return $this->pingResult;
    }

query()

query

(

$query

)

Execute search by $query

Parameters

array

$query

Returns

array

Definition at line 344 of file Elasticsearch.php.

    {
        $query = $this->prepareSearchQuery($query);

        return $this->getClient()->search($query);
    }

suggest()

suggest

(

$query

)

Execute suggest query

Parameters

array

$query

Returns

array

Definition at line 376 of file Elasticsearch.php.

    {
        return $this->getClient()->suggest($query);
    }

testConnection()

testConnection

(

)

Validate connection params

Returns

bool

Implements ClientInterface.

Definition at line 98 of file Elasticsearch.php.

    {
        return $this->ping();
    }

updateAlias()

updateAlias	(		$alias,
			$newIndex,
			$oldIndex = ''
	)

Updates alias.

Parameters

string	$alias
string	$newIndex
string	$oldIndex

Returns

void

Definition at line 187 of file Elasticsearch.php.

    {
        $params['body'] = ['actions' => []];
        if ($oldIndex) {
            $params['body']['actions'][] = ['remove' => ['alias' => $alias, 'index' => $oldIndex]];
        }
        if ($newIndex) {
            $params['body']['actions'][] = ['add' => ['alias' => $alias, 'index' => $newIndex]];
        }

        $this->getClient()->indices()->updateAliases($params);
    }

---

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

• vendor/magento/module-elasticsearch/Elasticsearch5/Model/Client/Elasticsearch.php