Navigation

MongoDB\Collection::withOptions()

On this page

Definition

MongoDB\Collection::withOptions

Returns a clone of the Collection object, but with different options.

copy 
function withOptions(array $options = []): MongoDB\Collection

This method has the following parameters:

Parameter Type Description
$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 original collection’s read concern.
readPreference MongoDB\Driver\ReadPreference Optional. The default read preference to use for collection operations. Defaults to the original collection’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 original collection’s type map.
writeConcern MongoDB\Driver\WriteConcern Optional. The default write concern to use for collection operations. Defaults to the original collection’s write concern.

Return Values

A MongoDB\Collection object.

Errors/Exceptions

MongoDB\Exception\InvalidArgumentException for errors related to the parsing of parameters or options.

Example

The following example clones an existing Collection object with a new read preference:

copy 
<?php

$collection = (new MongoDB\Client)->selectCollection('test', 'restaurants');

$newCollection = $sourceCollection->withOptions([
    'readPreference' => new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::RP_SECONDARY),
]);

© MongoDB, Inc 2008-present. MongoDB, Mongo, and the leaf logo are registered trademarks of MongoDB, Inc.