Class

eZ\Publish\Core\Search\Elasticsearch\Content\Gateway

abstract class Gateway

The Gateway provides the implementation to retrieve the desired documents from Elasticsearch index storage.

Methods

index(Document $document)

Indexes a given $document.

bulkIndex(array $documents)

Performs bulk index of a given array of documents.

mixed find(Query $query, string $type, array $languageFilter = array())

Finds and returns documents of a given $type for a given $query object.

Message findRaw(string $query, string $type)

Finds and returns documents of a given $type for a given $query string.

purgeIndex(string $type)

Deletes all documents of a given $type from the index.

delete(int|string $id, string $type)

Deletes a single document of the given $type by given document $id.

deleteByQuery(string $query, string $type)

Deletes a document(s) of the given $type by given $query string.

flush()

Flushes data from memory to the index storage.

Details

at line 24
abstract public index(Document $document)

Indexes a given $document.

Parameters

Document $document

at line 31
abstract public bulkIndex(array $documents)

Performs bulk index of a given array of documents.

Parameters

array $documents

at line 42
abstract public mixed find(Query $query, string $type, array $languageFilter = array())

Finds and returns documents of a given $type for a given $query object.

Parameters

Query $query
string $type
array $languageFilter

Return Value

mixed

at line 52
abstract public Message findRaw(string $query, string $type)

Finds and returns documents of a given $type for a given $query string.

Parameters

string $query
string $type

Return Value

Message

at line 59
abstract public purgeIndex(string $type)

Deletes all documents of a given $type from the index.

Parameters

string $type

at line 67
abstract public delete(int|string $id, string $type)

Deletes a single document of the given $type by given document $id.

Parameters

int|string $id
string $type

at line 75
abstract public deleteByQuery(string $query, string $type)

Deletes a document(s) of the given $type by given $query string.

Parameters

string $query
string $type

at line 80
abstract public flush()

Flushes data from memory to the index storage.