#27345 new Lock\MongoDbStore construction options

Author: Joe Bennett

components/lock.rst

@@ -293,29 +293,51 @@ The MongoDbStore saves locks on a MongoDB server ``>=2.2``, it requires a
 This store does not support blocking and expects a TTL to
 avoid stalled locks::
 
-    use MongoDB\Client;
     use Symfony\Component\Lock\Store\MongoDbStore;
 
-    $client = new Client('mongo://localhost/');
-
+    $mongo = 'mongodb://localhost/database?collection=lock';
     $options = [
-        'database' => 'my-app',
+        'gcProbablity' => 0.001,
+        'database' => 'myapp',
         'collection' => 'lock',
+        'uriOptions' => [],
+        'driverOptions' => [],
     ];
+    $store = new MongoDbStore($mongo, $options);
+
+The ``MongoDbStore`` takes the following ``$options`` (depending on the first parameter type):
+
+=============  ================================================================================================
+Option         Description
+=============  ================================================================================================
+gcProbablity   Should a TTL Index be created expressed as a probability from 0.0 to 1.0 (Defaults to ``0.001``)
+database       The name of the database
+collection     The name of the collection
+uriOptions     Array of uri options for `MongoDBClient::__construct`_
+driverOptions  Array of driver options for `MongoDBClient::__construct`_
+=============  ================================================================================================
+
+When the first parameter is a:
+
+``MongoDB\Collection``:
 
-    $store = new MongoDbStore($client, $options);
+- ``$options['database']`` is ignored
+- ``$options['collection']`` is ignored
 
-The ``MongoDbStore`` takes the following options (depending on the first parameter type):
+``MongoDB\Client``:
+
+- ``$options['database']`` is mandatory
+- ``$options['collection']`` is mandatory
+
+`MongoDB Connection String`_:
+
+- ``/path`` is used otherwise ``$options['database']``, at least one is mandatory
+- ``?collection=`` is used otherwise ``$options['collection']``, at least one is mandatory
+
+.. note::
 
-=============  =================================  =========  ========================================================================
-Option         First Parameter Type               Default    Description
-=============  =================================  =========  ========================================================================
-gcProbablity   any                                ``0.001``  Should a TTL Index be created expressed as a probability from 0.0 to 1.0
-database       ``\MongoDB\Client`` or ``string``             The name of the database [Mandatory]
-collection     ``\MongoDB\Client`` or ``string``  ``lock``   The name of the collection
-uriOptions     ``string``                         ``[]``     Array of uri options for `MongoDBClient::__construct`_
-driverOptions  ``string``                         ``[]``     Array of driver options for `MongoDBClient::__construct`_
-=============  =================================  =========  ========================================================================
+    The ``collection`` querystring parameter is not part of the `MongoDB Connection String`_ definition.
+    It is simply used to allow constructing a ``MongoDbStore`` using a `Data Source Name (DSN)`_ without ``$options``.
 
 .. _lock-store-pdo: