MongoDB\Database::selectCollection()

On this page

Definition

Parameters
Return Values
Errors/Exceptions
Behavior
Example
See Also

Definition

MongoDB\Database::selectCollection()

Selects a collection within the database.

function selectCollection(
    string $collectionName,
    array $options = []
): MongoDB\Collection

Parameters

$collectionName : string

The name of the collection to select.

$options : array

An array specifying the desired options.

Name	Type	Description
codec	MongoDB\Codec\DocumentCodec	The default codec to use for collection operations. New in version 1.17.
readConcern	MongoDB\Driver\ReadConcern	The default read concern to use for collection operations. Defaults to the database's read concern.
readPreference	MongoDB\Driver\ReadPreference	The default read preference to use for collection operations. Defaults to the database's read preference.
typeMap	array	The default type map to use for collection operations. Defaults to the database's type map.
writeConcern	MongoDB\Driver\WriteConcern	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:

<?php
$db = (new MongoDB\Client)->test;
$collection = $db->selectCollection('users');

The following example selects the users collection in the test database with a custom read preference:

<?php
$db = (new MongoDB\Client)->test;
$users = $db->selectCollection(
    'users',
    [
        'readPreference' => new MongoDB\Driver\ReadPreference('primaryPreferred'),
    ]
);