SearchIndexManager
in package
implements
SearchIndexManagerInterface
Interfaces, Classes, Traits and Enums
Table of Contents
- $core : resource
- allowQuerying() : mixed
- Allows querying against the index
- analyzeDocument() : array<string|int, mixed>
- Fetches the analysis of a document against a specific index
- disallowQuerying() : mixed
- Disallows querying against the index
- dropIndex() : mixed
- Drops an index from the server
- freezePlan() : mixed
- Freezes the assigment of index partitions to nodes
- getAllIndexes() : array<string|int, mixed>
- Fetches all indexes from the server
- getIndex() : SearchIndex
- Fetches index with the specified name from the server
- getIndexedDocumentsCount() : int
- Retrieves the number of documents that have been indexed for the index
- pauseIngest() : mixed
- Pauses updates and maintenance for the index
- resumeIngest() : mixed
- Resumes updates and maintenance for the index
- unfreezePlan() : mixed
- Unfreezes the assignment of index partitions to nodes
- upsertIndex() : mixed
- Upserts index to the server
Properties
$core
private
resource
$core
Methods
allowQuerying()
Allows querying against the index
public
allowQuerying(string $indexName[, AllowQueryingSearchIndexOptions|null $options = null ]) : mixed
Parameters
- $indexName : string
- $options : AllowQueryingSearchIndexOptions|null = null
Tags
Return values
mixed —analyzeDocument()
Fetches the analysis of a document against a specific index
public
analyzeDocument(string $indexName, mixed $document[, AnalyzeDocumentOptions|null $options = null ]) : array<string|int, mixed>
Parameters
- $indexName : string
- $document : mixed
- $options : AnalyzeDocumentOptions|null = null
Tags
Return values
array<string|int, mixed> —disallowQuerying()
Disallows querying against the index
public
disallowQuerying(string $indexName[, DisallowQueryingSearchIndexOptions|null $options = null ]) : mixed
Parameters
- $indexName : string
- $options : DisallowQueryingSearchIndexOptions|null = null
Tags
Return values
mixed —dropIndex()
Drops an index from the server
public
dropIndex(string $name[, DropSearchIndexOptions|null $options = null ]) : mixed
Parameters
- $name : string
- $options : DropSearchIndexOptions|null = null
Tags
Return values
mixed —freezePlan()
Freezes the assigment of index partitions to nodes
public
freezePlan(string $indexName[, FreezePlanSearchIndexOptions|null $options = null ]) : mixed
Parameters
- $indexName : string
- $options : FreezePlanSearchIndexOptions|null = null
Tags
Return values
mixed —getAllIndexes()
Fetches all indexes from the server
public
getAllIndexes([GetAllSearchIndexesOptions|null $options = null ]) : array<string|int, mixed>
Parameters
- $options : GetAllSearchIndexesOptions|null = null
Tags
Return values
array<string|int, mixed> —getIndex()
Fetches index with the specified name from the server
public
getIndex(string $indexName[, GetSearchIndexOptions|null $options = null ]) : SearchIndex
Parameters
- $indexName : string
- $options : GetSearchIndexOptions|null = null
Tags
Return values
SearchIndex —getIndexedDocumentsCount()
Retrieves the number of documents that have been indexed for the index
public
getIndexedDocumentsCount(string $indexName[, GetIndexedSearchIndexOptions|null $options = null ]) : int
Parameters
- $indexName : string
- $options : GetIndexedSearchIndexOptions|null = null
Tags
Return values
int —pauseIngest()
Pauses updates and maintenance for the index
public
pauseIngest(string $indexName[, PauseIngestSearchIndexOptions|null $options = null ]) : mixed
Parameters
- $indexName : string
- $options : PauseIngestSearchIndexOptions|null = null
Tags
Return values
mixed —resumeIngest()
Resumes updates and maintenance for the index
public
resumeIngest(string $indexName[, ResumeIngestSearchIndexOptions|null $options = null ]) : mixed
Parameters
- $indexName : string
- $options : ResumeIngestSearchIndexOptions|null = null
Tags
Return values
mixed —unfreezePlan()
Unfreezes the assignment of index partitions to nodes
public
unfreezePlan(string $indexName[, UnfreezePlanSearchIndexOptions|null $options = null ]) : mixed
Parameters
- $indexName : string
- $options : UnfreezePlanSearchIndexOptions|null = null
Tags
Return values
mixed —upsertIndex()
Upserts index to the server
public
upsertIndex(SearchIndex $indexDefinition[, UpsertSearchIndexOptions|null $options = null ]) : mixed
Parameters
- $indexDefinition : SearchIndex
- $options : UpsertSearchIndexOptions|null = null