Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 3.11.x will end 14 Nov 2022 (12 months plus 6 months extension).
  • Bug fixes for security issues in 3.11.x will end 13 Nov 2023 (18 months plus 12 months extension).
  • PHP version: minimum PHP 7.3.0 Note: minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is supported too.
<?php
/*
 * Copyright 2015-2017 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
 *
 *   http://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\Command;
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 MongoDB\Model\IndexInput;
use function array_map;
use function is_array;
use function is_integer;
> use function is_string;
use function MongoDB\server_supports_feature; use function sprintf; /** * Operation for the createIndexes command. * * @api * @see \MongoDB\Collection::createIndex() * @see \MongoDB\Collection::createIndexes() * @see http://docs.mongodb.org/manual/reference/command/createIndexes/ */ class CreateIndexes implements Executable { /** @var integer */ private static $wireVersionForCollation = 5; /** @var integer */ private static $wireVersionForWriteConcern = 5;
> /** @var integer */ /** @var string */ > private static $wireVersionForCommitQuorum = 9; private $databaseName; >
/** @var string */ private $collectionName; /** @var array */ private $indexes = []; /** @var boolean */ private $isCollationUsed = false; /** @var array */ private $options = []; /** * Constructs a createIndexes command. * * Supported options: *
> * * commitQuorum (integer|string): Specifies how many data-bearing members * * maxTimeMS (integer): The maximum amount of time to allow the query to > * of a replica set, including the primary, must complete the index * run. > * builds successfully before the primary marks the indexes as ready. * > *
* * session (MongoDB\Driver\Session): Client session. * * Sessions are not supported for server versions < 3.6. * * * writeConcern (MongoDB\Driver\WriteConcern): Write concern. * * This is not supported for server versions < 3.4 and will result in an * exception at execution time if used. * * @param string $databaseName Database name * @param string $collectionName Collection name * @param array[] $indexes List of index specifications * @param array $options Command options * @throws InvalidArgumentException for parameter/option parsing errors */ public function __construct($databaseName, $collectionName, array $indexes, array $options = []) { if (empty($indexes)) { throw new InvalidArgumentException('$indexes is empty'); } $expectedIndex = 0; foreach ($indexes as $i => $index) { if ($i !== $expectedIndex) { throw new InvalidArgumentException(sprintf('$indexes is not a list (unexpected index: "%s")', $i)); } if (! is_array($index)) { throw InvalidArgumentException::invalidType(sprintf('$index[%d]', $i), $index, 'array'); }
< if (! isset($index['ns'])) { < $index['ns'] = $databaseName . '.' . $collectionName; < } <
if (isset($index['collation'])) { $this->isCollationUsed = true; } $this->indexes[] = new IndexInput($index); $expectedIndex += 1; }
> if (isset($options['commitQuorum']) && ! is_string($options['commitQuorum']) && ! is_integer($options['commitQuorum'])) { if (isset($options['maxTimeMS']) && ! is_integer($options['maxTimeMS'])) { > throw InvalidArgumentException::invalidType('"commitQuorum" option', $options['commitQuorum'], ['integer', 'string']); throw InvalidArgumentException::invalidType('"maxTimeMS" option', $options['maxTimeMS'], 'integer'); > } } >
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']); } $this->databaseName = (string) $databaseName; $this->collectionName = (string) $collectionName; $this->options = $options; } /** * Execute the operation. * * @see Executable::execute() * @param Server $server * @return string[] The names of the created indexes * @throws UnsupportedException if collation or write concern is used and unsupported * @throws DriverRuntimeException for other driver errors (e.g. connection errors) */ public function execute(Server $server) { if ($this->isCollationUsed && ! server_supports_feature($server, self::$wireVersionForCollation)) { throw UnsupportedException::collationNotSupported(); } if (isset($this->options['writeConcern']) && ! server_supports_feature($server, self::$wireVersionForWriteConcern)) { throw UnsupportedException::writeConcernNotSupported(); } $inTransaction = isset($this->options['session']) && $this->options['session']->isInTransaction(); if ($inTransaction && isset($this->options['writeConcern'])) { throw UnsupportedException::writeConcernNotSupportedInTransaction(); } $this->executeCommand($server); return array_map(function (IndexInput $index) { return (string) $index; }, $this->indexes); } /** * Create options for executing the command. * * @see http://php.net/manual/en/mongodb-driver-server.executewritecommand.php * @return array */ private function createOptions() { $options = []; if (isset($this->options['session'])) { $options['session'] = $this->options['session']; } if (isset($this->options['writeConcern'])) { $options['writeConcern'] = $this->options['writeConcern']; } return $options; } /** * Create one or more indexes for the collection using the createIndexes * command. * * @param Server $server * @throws DriverRuntimeException for other driver errors (e.g. connection errors) */ private function executeCommand(Server $server) { $cmd = [ 'createIndexes' => $this->collectionName, 'indexes' => $this->indexes, ];
> > if (isset($this->options['commitQuorum'])) { if (isset($this->options['maxTimeMS'])) { > /* Drivers MUST manually raise an error if this option is specified $cmd['maxTimeMS'] = $this->options['maxTimeMS']; > * when creating an index on a pre 4.4 server. */ } > if (! server_supports_feature($server, self::$wireVersionForCommitQuorum)) { > throw UnsupportedException::commitQuorumNotSupported(); $server->executeWriteCommand($this->databaseName, new Command($cmd), $this->createOptions()); > } } > } > $cmd['commitQuorum'] = $this->options['commitQuorum']; > }