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