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