Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 3.10.x will end 8 November 2021 (12 months).
  • Bug fixes for security issues in 3.10.x will end 9 May 2022 (18 months).
  • PHP version: minimum PHP 7.2.0 Note: minimum PHP version has increased since Moodle 3.8. PHP 7.3.x and 7.4.x are supported too.

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

(no description)

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

Defines 1 class

ListDatabases:: (3 methods):
  __construct()
  execute()
  createOptions()


Class: ListDatabases  - X-Ref

Operation for the ListDatabases command.

__construct(array $options = [])   X-Ref
Constructs a listDatabases command.

Supported options:

* filter (document): Query by which to filter databases.

For servers < 3.6, this option is ignored.

* maxTimeMS (integer): The maximum amount of time to allow the query to
run.

* session (MongoDB\Driver\Session): Client session.

Sessions are not supported for server versions < 3.6.

param: array $options Command options

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

param: Server $server
return: DatabaseInfoIterator

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.

return: array