Merge pull request #1910 from alcaeus/drop-index-options

Separate index creation options from index options

Author: alcaeus

UPGRADE-2.0.md

@@ -29,6 +29,8 @@
 
 * The `--depth` option in the `odm:query` command was dropped without
   replacement.
+* The `--timeout` option for all schema commands was dropped. You should use the
+  `--maxTimeMs` option instead.
 
 ## Aggregation builder
 * The `debug` method in `Doctrine\ODM\MongoDB\Aggregation\Stage\Match` was dropped
@@ -111,6 +113,8 @@ are no longer possible:
   `dbRefWithDB`. This omits the `$db` key in the `DBRef` object when possible.
   This only has implications if you consume documents outside of ODM and require
   the `$db` key to be set or if you are using multiple databases to store data.
+* The `dropDups` option on indexes has been dropped without replacement since it
+  is no longer respected by MongoDB.
 
 ### YAML mapping
 

docs/en/reference/indexes.rst

@@ -40,9 +40,6 @@ You can customize the index with some additional options:
    **name** - The name of the index. This can be useful if you are
    indexing many keys and Mongo complains about the index name being
    too long.
--
-   **dropDups** - If a unique index is being created and duplicate
-   values exist, drop all but one duplicate value.
 -
    **background** - Create indexes in the background while other
    operations are taking place. By default, index creation happens

docs/en/reference/xml-mapping.rst

@@ -114,7 +114,7 @@ of several common elements:
             <field field-name="email" type="string" unique="true" order="desc" />
             <field field-name="createdAt" type="date" />
             <indexes>
-                <index unique="true" dropDups="true">
+                <index unique="true">
                     <key name="username" order="desc" />
                     <option name="safe" value="true" />
                 </index>

lib/Doctrine/ODM/MongoDB/Mapping/Annotations/AbstractIndex.php

@@ -14,9 +14,6 @@ abstract class AbstractIndex extends Annotation
     /** @var string */
     public $name;
 
-    /** @var bool|null */
-    public $dropDups;
-
     /** @var bool|null */
     public $background;
 

lib/Doctrine/ODM/MongoDB/Mapping/Driver/AnnotationDriver.php

@@ -237,7 +237,7 @@ private function addIndex(ClassMetadata $class, AbstractIndex $index, array $key
     {
         $keys    = array_merge($keys, $index->keys);
         $options = [];
-        $allowed = ['name', 'dropDups', 'background', 'unique', 'sparse', 'expireAfterSeconds'];
+        $allowed = ['name', 'background', 'unique', 'sparse', 'expireAfterSeconds'];
         foreach ($allowed as $name) {
             if (! isset($index->$name)) {
                 continue;

lib/Doctrine/ODM/MongoDB/Mapping/Driver/XmlDriver.php

@@ -286,9 +286,6 @@ private function addFieldMapping(ClassMetadata $class, array $mapping) : void
         if (isset($mapping['background'])) {
             $options['background'] = (bool) $mapping['background'];
         }
-        if (isset($mapping['drop-dups'])) {
-            $options['dropDups'] = (bool) $mapping['drop-dups'];
-        }
         if (isset($mapping['index-name'])) {
             $options['name'] = (string) $mapping['index-name'];
         }
@@ -424,9 +421,6 @@ private function addIndex(ClassMetadata $class, SimpleXMLElement $xmlIndex) : vo
         if (isset($attributes['background'])) {
             $options['background'] = ((string) $attributes['background'] === 'true');
         }
-        if (isset($attributes['drop-dups'])) {
-            $options['dropDups'] = ((string) $attributes['drop-dups'] === 'true');
-        }
         if (isset($attributes['name'])) {
             $options['name'] = (string) $attributes['name'];
         }