Support for updates with aggregation pipeline

[timwhitlock]

Description

I'm unable to execute an update with a pipeline such as using the new (upcoming) aggregate $set operator. This fails before the command is executed as shown below.

I presume that support simply hasn't been added yet, but can you say if/when it will be supported, or if there's a workaround I can use to execute this?

Thank you.

Environment

PHP 7.2.16 on Mac OS X

Tried with latest stable driver 1.5.5 and also 1.6.0alpha2.

Test Script

<?php
$batch = new MongoDB\Driver\BulkWrite(['ordered'=>true]);
$batch->update(
    [ ],
    [ [ '$set' => ['foo'=>'bar'] ] ], // <- aggregate pipeline
    [ 'limit' => 0 ]
);

Expected and Actual Behavior

Fails with MongoDB\Driver\Exception\InvalidArgumentException:

invalid argument for replace: keys cannot begin with "$": "$set"

[jmikola]

This feature is being tracked by PHPC-1355 and is scheduled for 1.6.0, which will be the 4.2-compatible release.

If you need an immediate work-around, you can craft the update command yourself and execute it with Manager::executeWriteCommand().

Unlike executeCommand(), executeWriteCommand() will inherit any write concern you may have set via the connection string (or options). If you need to specify a write concern at the operation level, you can also pass it as an option to executeWriteCommand() (preferable to putting it directly into the command document).

[timwhitlock]

Thank you!