CreateQueryIndexOptions
in package
Table of Contents
- $collectionName : string|null
- $condition : string|null
- $deferred : bool|null
- $ignoreIfExists : bool|null
- $numberOfReplicas : int|null
- $scopeName : string|null
- $timeoutMilliseconds : int|null
- build() : CreateQueryIndexOptions
- Static helper to keep code more readable
- collectionName() : CreateQueryIndexOptions
- condition() : CreateQueryIndexOptions
- deferred() : CreateQueryIndexOptions
- ignoreIfExists() : CreateQueryIndexOptions
- numReplicas() : CreateQueryIndexOptions
- scopeName() : CreateQueryIndexOptions
- timeout() : CreateQueryIndexOptions
- Sets the operation timeout in milliseconds.
Properties
$collectionName
private
string|null
$collectionName
= null
$condition
private
string|null
$condition
= null
$deferred
private
bool|null
$deferred
= null
$ignoreIfExists
private
bool|null
$ignoreIfExists
= null
$numberOfReplicas
private
int|null
$numberOfReplicas
= null
$scopeName
private
string|null
$scopeName
= null
$timeoutMilliseconds
private
int|null
$timeoutMilliseconds
= null
Methods
build()
Static helper to keep code more readable
public
static build() : CreateQueryIndexOptions
Tags
Return values
CreateQueryIndexOptions —collectionName()
public
collectionName(string $collectionName) : CreateQueryIndexOptions
Parameters
- $collectionName : string
Tags
Return values
CreateQueryIndexOptions —condition()
public
condition(string $condition) : CreateQueryIndexOptions
Parameters
- $condition : string
Tags
Return values
CreateQueryIndexOptions —deferred()
public
deferred(bool $isDeferred) : CreateQueryIndexOptions
Parameters
- $isDeferred : bool
Tags
Return values
CreateQueryIndexOptions —ignoreIfExists()
public
ignoreIfExists(bool $shouldIgnore) : CreateQueryIndexOptions
Parameters
- $shouldIgnore : bool
Tags
Return values
CreateQueryIndexOptions —numReplicas()
public
numReplicas(int $numberOfReplicas) : CreateQueryIndexOptions
Parameters
- $numberOfReplicas : int
Tags
Return values
CreateQueryIndexOptions —scopeName()
public
scopeName(string $scopeName) : CreateQueryIndexOptions
Parameters
- $scopeName : string
Tags
Return values
CreateQueryIndexOptions —timeout()
Sets the operation timeout in milliseconds.
public
timeout(int $milliseconds) : CreateQueryIndexOptions
Parameters
- $milliseconds : int
-
the operation timeout to apply