Client::bulkWrite() and ClientBulkWrite operation

Author: jmikola

src/Client.php

@@ -24,6 +24,8 @@
 use MongoDB\Builder\BuilderEncoder;
 use MongoDB\Builder\Pipeline;
 use MongoDB\Codec\Encoder;
+use MongoDB\Driver\BulkWriteCommand;
+use MongoDB\Driver\BulkWriteCommandResult;
 use MongoDB\Driver\ClientEncryption;
 use MongoDB\Driver\Exception\InvalidArgumentException as DriverInvalidArgumentException;
 use MongoDB\Driver\Exception\RuntimeException as DriverRuntimeException;
@@ -39,6 +41,7 @@
 use MongoDB\Model\BSONArray;
 use MongoDB\Model\BSONDocument;
 use MongoDB\Model\DatabaseInfo;
+use MongoDB\Operation\ClientBulkWrite;
 use MongoDB\Operation\DropDatabase;
 use MongoDB\Operation\ListDatabaseNames;
 use MongoDB\Operation\ListDatabases;
@@ -189,6 +192,32 @@ final public function addSubscriber(Subscriber $subscriber): void
         $this->manager->addSubscriber($subscriber);
     }
 
+    /**
+     * Executes multiple write operations.
+     *
+     * @see ClientBulkWrite::__construct() for supported options
+     * @param string $databaseName Database name
+     * @param array  $options      Additional options
+     * @throws UnsupportedException if options are unsupported on the selected server
+     * @throws InvalidArgumentException for parameter/option parsing errors
+     * @throws DriverRuntimeException for other driver errors (e.g. connection errors)
+     */
+    public function bulkWrite(BulkWriteCommand|BulkWriteCommandBuilder $bulk, array $options = []): ?BulkWriteCommandResult
+    {
+        if (! isset($options['writeConcern']) && ! is_in_transaction($options)) {
+            $options['writeConcern'] = $this->writeConcern;
+        }
+
+        if ($bulk instanceof BulkWriteCommandBuilder) {
+            $bulk = $bulk->bulkWriteCommand;
+        }
+
+        $operation = new ClientBulkWrite($bulk, $options);
+        $server = select_server_for_write($this->manager, $options);
+
+        return $operation->execute($server);
+    }
+
     /**
      * Returns a ClientEncryption instance for explicit encryption and decryption
      *

src/Operation/ClientBulkWrite.php

@@ -0,0 +1,92 @@
+<?php
+/*
+ * Copyright 2015-present MongoDB, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+namespace MongoDB\Operation;
+
+use MongoDB\Driver\BulkWriteCommand;
+use MongoDB\Driver\BulkWriteCommandResult;
+use MongoDB\Driver\Exception\RuntimeException as DriverRuntimeException;
+use MongoDB\Driver\Server;
+use MongoDB\Driver\Session;
+use MongoDB\Driver\WriteConcern;
+use MongoDB\Exception\InvalidArgumentException;
+use MongoDB\Exception\UnsupportedException;
+
+use function array_filter;
+use function count;
+
+/**
+ * Operation for executing multiple write operations via the bulkWrite command.
+ *
+ * @see \MongoDB\Client::bulkWrite()
+ */
+final class ClientBulkWrite
+{
+    /**
+     * Constructs a client-level bulk write operation.
+     *
+     * Most options for the bulkWrite command and its write operations are
+     * specified when building the extension's BulkWriteCommand object. This
+     * operation only accepts options for Server::executeBulkWriteCommand().
+     *
+     * Supported options:
+     *
+     *  * session (MongoDB\Driver\Session): Client session.
+     *
+     *  * writeConcern (MongoDB\Driver\WriteConcern): Write concern.
+     *
+     * @param BulkWriteCommand $bulkWriteCommand Assembled bulk write command
+     * @param array            $options          Command options
+     * @throws InvalidArgumentException for parameter/option parsing errors
+     */
+    public function __construct(private BulkWriteCommand $bulkWriteCommand, private array $options = [])
+    {
+        if (count($bulkWriteCommand) === 0) {
+            throw new InvalidArgumentException('$bulkWriteCommand is empty');
+        }
+
+        if (isset($options['session']) && ! $options['session'] instanceof Session) {
+            throw InvalidArgumentException::invalidType('"session" option', $options['session'], Session::class);
+        }
+
+        if (isset($options['writeConcern']) && ! $options['writeConcern'] instanceof WriteConcern) {
+            throw InvalidArgumentException::invalidType('"writeConcern" option', $options['writeConcern'], WriteConcern::class);
+        }
+
+        if (isset($options['writeConcern']) && $options['writeConcern']->isDefault()) {
+            unset($options['writeConcern']);
+        }
+    }
+
+    /**
+     * Execute the operation.
+     *
+     * @throws UnsupportedException if write concern is used and unsupported
+     * @throws DriverRuntimeException for other driver errors (e.g. connection errors)
+     */
+    public function execute(Server $server): ?BulkWriteCommandResult
+    {
+        $inTransaction = isset($this->options['session']) && $this->options['session']->isInTransaction();
+        if ($inTransaction && isset($this->options['writeConcern'])) {
+            throw UnsupportedException::writeConcernNotSupportedInTransaction();
+        }
+
+        $options = array_filter($this->options, fn ($value) => isset($value));
+
+        return $server->executeBulkWriteCommand($this->bulkWriteCommand, $options);
+    }
+}