Interfaces, Classes, Traits and Enums
- CollectionQueryIndexManagerInterface
Table of Contents
-
$bucketName
: string
-
$client
: Client
-
$collectionName
: string
-
$scopeName
: string
-
__construct()
: mixed
-
buildDeferredIndexes()
: mixed
-
createIndex()
: mixed
-
createPrimaryIndex()
: mixed
-
dropIndex()
: mixed
-
dropPrimaryIndex()
: mixed
-
getAllIndexes()
: array<string|int, mixed>
-
watchIndexes()
: mixed
-
checkOptions()
: mixed
$bucketName
private
string
$bucketName
$client
private
Client
$client
$collectionName
private
string
$collectionName
$scopeName
private
string
$scopeName
__construct()
public
__construct(string $collectionName, string $scopeName, string $bucketName, Client $client) : mixed
Parameters
-
$collectionName
: string
-
-
$scopeName
: string
-
-
$bucketName
: string
-
-
$client
: Client
-
Return values
mixed
—
buildDeferredIndexes()
public
buildDeferredIndexes([BuildQueryIndexesOptions $options = null ]) : mixed
Parameters
-
$options
: BuildQueryIndexesOptions
= null
-
-
throws
-
InvalidArgumentException
Return values
mixed
—
createIndex()
public
createIndex(string $indexName, array<string|int, mixed> $fields[, CreateQueryIndexOptions $options = null ]) : mixed
Parameters
-
$indexName
: string
-
-
$fields
: array<string|int, mixed>
-
-
$options
: CreateQueryIndexOptions
= null
-
-
throws
-
InvalidArgumentException
Return values
mixed
—
createPrimaryIndex()
public
createPrimaryIndex([CreateQueryPrimaryIndexOptions $options = null ]) : mixed
Parameters
-
$options
: CreateQueryPrimaryIndexOptions
= null
-
-
throws
-
InvalidArgumentException
Return values
mixed
—
dropIndex()
public
dropIndex(string $indexName[, DropQueryIndexOptions $options = null ]) : mixed
Parameters
-
$indexName
: string
-
-
$options
: DropQueryIndexOptions
= null
-
-
throws
-
InvalidArgumentException
Return values
mixed
—
dropPrimaryIndex()
public
dropPrimaryIndex([DropQueryPrimaryIndexOptions $options = null ]) : mixed
Parameters
-
$options
: DropQueryPrimaryIndexOptions
= null
-
-
throws
-
InvalidArgumentException
Return values
mixed
—
getAllIndexes()
public
getAllIndexes([GetAllQueryIndexesOptions $options = null ]) : array<string|int, mixed>
Parameters
-
$options
: GetAllQueryIndexesOptions
= null
-
-
throws
-
DecodingFailureException
-
throws
-
InvalidArgumentException
Return values
array<string|int, mixed>
—
watchIndexes()
public
watchIndexes(array<string|int, mixed> $indexNames, int $timeoutMilliseconds[, WatchQueryIndexesOptions $options = null ]) : mixed
Parameters
-
$indexNames
: array<string|int, mixed>
-
-
$timeoutMilliseconds
: int
-
-
$options
: WatchQueryIndexesOptions
= null
-
-
throws
-
UnambiguousTimeoutException
-
throws
-
InvalidArgumentException
Return values
mixed
—
checkOptions()
private
checkOptions(array<string|int, mixed> $exportedOpts) : mixed
Parameters
-
$exportedOpts
: array<string|int, mixed>
-
-
throws
-
InvalidArgumentException
Return values
mixed
—