ListIndexes
in package
FinalYes
Operation for the listIndexes command.
Tags
Table of Contents
Constants
Properties
- $collectionName : string
- $databaseName : string
- $options : array<string|int, mixed>
Methods
- __construct() : mixed
- Constructs a listIndexes command.
- execute() : Iterator<int, IndexInfo>
- Execute the operation.
- createOptions() : array<string|int, mixed>
- Create options for executing the command.
Constants
ERROR_CODE_DATABASE_NOT_FOUND
private
mixed
ERROR_CODE_DATABASE_NOT_FOUND
= 60
ERROR_CODE_NAMESPACE_NOT_FOUND
private
mixed
ERROR_CODE_NAMESPACE_NOT_FOUND
= 26
Properties
$collectionName
private
string
$collectionName
$databaseName
private
string
$databaseName
$options
private
array<string|int, mixed>
$options
= []
Methods
__construct()
Constructs a listIndexes command.
public
__construct(string $databaseName, string $collectionName[, array<string|int, mixed> $options = [] ]) : mixed
Supported options:
-
comment (mixed): BSON value to attach as a comment to this command.
This is not supported for servers versions < 4.4.
-
maxTimeMS (integer): The maximum amount of time to allow the query to run.
-
session (MongoDB\Driver\Session): Client session.
Parameters
- $databaseName : string
-
Database name
- $collectionName : string
-
Collection name
- $options : array<string|int, mixed> = []
-
Command options
Tags
execute()
Execute the operation.
public
execute(Server $server) : Iterator<int, IndexInfo>
Parameters
- $server : Server
Tags
Return values
Iterator<int, IndexInfo>createOptions()
Create options for executing the command.
private
createOptions() : array<string|int, mixed>
Note: read preference is intentionally omitted, as the spec requires that the command be executed on the primary.