CollectionQueryIndexManager
in package
implements
CollectionQueryIndexManagerInterface
Interfaces, Classes, Traits and Enums
Table of Contents
- $bucketName : string
- $collectionName : string
- $core : resource
- $scopeName : string
- buildDeferredIndexes() : mixed
- Build Deferred builds all indexes which are currently in deferred state.
- createIndex() : mixed
- Creates a new index
- createPrimaryIndex() : mixed
- Creates a new primary index
- dropIndex() : mixed
- Drops an index
- dropPrimaryIndex() : mixed
- Drops a primary index
- getAllIndexes() : array<string|int, mixed>
- Fetches all indexes from the server.
- watchIndexes() : mixed
- Watch polls indexes until they are online.
- checkOptions() : mixed
Properties
$bucketName
private
string
$bucketName
$collectionName
private
string
$collectionName
$core
private
resource
$core
$scopeName
private
string
$scopeName
Methods
buildDeferredIndexes()
Build Deferred builds all indexes which are currently in deferred state.
public
buildDeferredIndexes([BuildQueryIndexesOptions|null $options = null ]) : mixed
Parameters
- $options : BuildQueryIndexesOptions|null = null
Tags
Return values
mixed —createIndex()
Creates a new index
public
createIndex(string $indexName, array<string|int, mixed> $keys[, CreateQueryIndexOptions|null $options = null ]) : mixed
Parameters
- $indexName : string
- $keys : array<string|int, mixed>
- $options : CreateQueryIndexOptions|null = null
Tags
Return values
mixed —createPrimaryIndex()
Creates a new primary index
public
createPrimaryIndex([CreateQueryPrimaryIndexOptions|null $options = null ]) : mixed
Parameters
- $options : CreateQueryPrimaryIndexOptions|null = null
Tags
Return values
mixed —dropIndex()
Drops an index
public
dropIndex(string $indexName[, DropQueryIndexOptions|null $options = null ]) : mixed
Parameters
- $indexName : string
- $options : DropQueryIndexOptions|null = null
Tags
Return values
mixed —dropPrimaryIndex()
Drops a primary index
public
dropPrimaryIndex([DropQueryPrimaryIndexOptions|null $options = null ]) : mixed
Parameters
- $options : DropQueryPrimaryIndexOptions|null = null
Tags
Return values
mixed —getAllIndexes()
Fetches all indexes from the server.
public
getAllIndexes([GetAllQueryIndexesOptions|null $options = null ]) : array<string|int, mixed>
Parameters
- $options : GetAllQueryIndexesOptions|null = null
Tags
Return values
array<string|int, mixed> —watchIndexes()
Watch polls indexes until they are online.
public
watchIndexes(array<string|int, mixed> $indexNames, int $timeoutMilliseconds[, WatchQueryIndexesOptions|null $options = null ]) : mixed
Parameters
- $indexNames : array<string|int, mixed>
- $timeoutMilliseconds : int
- $options : WatchQueryIndexesOptions|null = null
Tags
Return values
mixed —checkOptions()
private
checkOptions(array<string|int, mixed> $exportedOpts) : mixed
Parameters
- $exportedOpts : array<string|int, mixed>