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/Command/ -> ListDatabases.php (source)

[Source view]

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

(no description)

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

Defines 1 class

ListDatabases:: (4 methods):
  __construct()
  execute()
  createCommand()
  createOptions()


Class: ListDatabases  - X-Ref

Wrapper for the ListDatabases command.

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

Supported options:

* authorizedDatabases (boolean): Determines which databases are returned
based on the user privileges.

For servers < 4.0.5, this option is ignored.

* comment (mixed): BSON value to attach as a comment to this command.

This is not supported for servers versions < 4.4.

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

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

* nameOnly (boolean): A flag to indicate whether the command should
return just the database names, or return both database names and size
information.

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

param: array $options Command options

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

return: array An array of database info structures

createCommand()   X-Ref
Create the listDatabases command.


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.