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