CreateQueryPrimaryIndexOptions
in package
Table of Contents
- $collectionName : string|null
- $deferred : bool|null
- $ignoreIfExists : bool|null
- $indexName : string|null
- $numberOfReplicas : int|null
- $scopeName : string|null
- $timeoutMilliseconds : int|null
- build() : CreateQueryPrimaryIndexOptions
- Static helper to keep code more readable
- collectionName() : CreateQueryPrimaryIndexOptions
- deferred() : CreateQueryPrimaryIndexOptions
- ignoreIfExists() : CreateQueryPrimaryIndexOptions
- indexName() : CreateQueryPrimaryIndexOptions
- numReplicas() : CreateQueryPrimaryIndexOptions
- scopeName() : CreateQueryPrimaryIndexOptions
- timeout() : CreateQueryPrimaryIndexOptions
- Sets the operation timeout in milliseconds.
Properties
$collectionName
private
string|null
$collectionName
= null
$deferred
private
bool|null
$deferred
= null
$ignoreIfExists
private
bool|null
$ignoreIfExists
= null
$indexName
private
string|null
$indexName
= 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() : CreateQueryPrimaryIndexOptions
Tags
Return values
CreateQueryPrimaryIndexOptions —collectionName()
public
collectionName(string $collectionName) : CreateQueryPrimaryIndexOptions
Parameters
- $collectionName : string
Tags
Return values
CreateQueryPrimaryIndexOptions —deferred()
public
deferred(bool $isDeferred) : CreateQueryPrimaryIndexOptions
Parameters
- $isDeferred : bool
Tags
Return values
CreateQueryPrimaryIndexOptions —ignoreIfExists()
public
ignoreIfExists(bool $shouldIgnore) : CreateQueryPrimaryIndexOptions
Parameters
- $shouldIgnore : bool
Tags
Return values
CreateQueryPrimaryIndexOptions —indexName()
public
indexName(string $name) : CreateQueryPrimaryIndexOptions
Parameters
- $name : string
Tags
Return values
CreateQueryPrimaryIndexOptions —numReplicas()
public
numReplicas(int $numberOfReplicas) : CreateQueryPrimaryIndexOptions
Parameters
- $numberOfReplicas : int
Tags
Return values
CreateQueryPrimaryIndexOptions —scopeName()
public
scopeName(string $scopeName) : CreateQueryPrimaryIndexOptions
Parameters
- $scopeName : string
Tags
Return values
CreateQueryPrimaryIndexOptions —timeout()
Sets the operation timeout in milliseconds.
public
timeout(int $milliseconds) : CreateQueryPrimaryIndexOptions
Parameters
- $milliseconds : int
-
the operation timeout to apply