- API Documentation >
- MongoDB\Database Class >
- MongoDB\Database::selectCollection()
MongoDB\Database::selectCollection()
On this page
Definition
-
MongoDB\Database::selectCollection
Selects a collection within the database.
This method has the following parameters:
Parameter Type Description $collectionName
string The name of the collection to select. $options
array Optional. An array specifying the desired options. The
$options
parameter supports the following options:Option Type Description readConcern
MongoDB\Driver\ReadConcern Optional. The default read concern to use for collection operations. Defaults to the database’s read concern. readPreference
MongoDB\Driver\ReadPreference Optional. The default read preference to use for collection operations. Defaults to the database’s read preference. typeMap
array Optional. The type map to apply to cursors, which determines how BSON documents are converted to PHP values. Defaults to the database’s type map. writeConcern
MongoDB\Driver\WriteConcern Optional. The default write concern to use for collection operations. Defaults to the database’s write concern.
Return Values
A MongoDB\Collection
object.
Errors/Exceptions
MongoDB\Exception\InvalidArgumentException
for errors related to
the parsing of parameters or options.
Behavior
The selected collection inherits options such as read preference and type
mapping from the Database
object. Options may be
overridden via the $options
parameter.
Example
The following example selects the users
collection in the test
database:
The following example selects the users
collection in the test
database with a custom read preference: