- Reference >
- MongoDB\Database Class >
- MongoDB\Database::modifyCollection()
MongoDB\Database::modifyCollection()
New in version 1.4.
On this page
Definition
-
MongoDB\Database::modifyCollection
Modifies a collection or view according to the specified
$collectionOptions
.This method has the following parameters:
Parameter Type Description $collectionName
string The name of the collection or view to modify. $collectionOptions
array Collection or view options to assign. $options
array Optional. An array specifying the desired options. The
$options
parameter supports the following options:Option Type Description comment
mixed Optional. Enables users to specify an arbitrary comment to help trace the operation through the database profiler, currentOp output, and logs.
This is not supported for server versions prior to 4.4 and will result in an exception at execution time if used.
New in version 1.13.
session
MongoDB\Driver\Session Optional. Client session to associate with the operation. 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.
This will be used for the returned command result document.
writeConcern
MongoDB\Driver\WriteConcern Optional. Write concern to use for the operation. Defaults to the database’s write concern.
Return Values
An array or object with the result document of the collMod command.
Errors/Exceptions
MongoDB\Exception\InvalidArgumentException
for errors related to
the parsing of parameters or options.
MongoDB\Driver\Exception\RuntimeException for other errors at the driver level (e.g. connection errors).
Example
The following example changes the expiration time of a TTL collection in the
test
database:
The output would then resemble:
See Also
- collMod command reference in the MongoDB manual