Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
/cache/stores/mongodb/MongoDB/Operation/ -> ListIndexes.php (source)

[Source view]

Differences Between: [Versions 310 and 401] [Versions 311 and 401] [Versions 39 and 401] [Versions 400 and 401]

(no description)

File Size: 156 lines (5 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

ListIndexes:: (4 methods):
  __construct()
  execute()
  createOptions()
  executeCommand()


Class: ListIndexes  - X-Ref

Operation for the listIndexes command.

__construct(string $databaseName, string $collectionName, array $options = [])   X-Ref
Constructs a listIndexes command.

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.

param: string $databaseName   Database name
param: string $collectionName Collection name
param: array  $options        Command options

execute(Server $server)   X-Ref
Execute the operation.

return: IndexInfoIterator

createOptions()   X-Ref
Create options for executing the command.

Note: read preference is intentionally omitted, as the spec requires that
the command be executed on the primary.


executeCommand(Server $server)   X-Ref
Returns information for all indexes for this collection using the
listIndexes command.