@@ -460,7 +460,7 @@ avoid stalled locks::
460
460
461
461
$mongo = 'mongodb://localhost/database?collection=lock';
462
462
$options = [
463
- 'gcProbablity ' => 0.001,
463
+ 'gcProbability ' => 0.001,
464
464
'database' => 'myapp',
465
465
'collection' => 'lock',
466
466
'uriOptions' => [],
@@ -470,16 +470,22 @@ avoid stalled locks::
470
470
471
471
The ``MongoDbStore `` takes the following ``$options `` (depending on the first parameter type):
472
472
473
- ============= ================================================================================================
474
- Option Description
475
- ============= ================================================================================================
476
- gcProbablity Should a TTL Index be created expressed as a probability from 0.0 to 1.0 (Defaults to ``0.001 ``)
473
+ ============== ================================================================================================
474
+ Option Description
475
+ ============== ================================================================================================
476
+ gcProbability Should a TTL Index be created expressed as a probability from 0.0 to 1.0 (Defaults to ``0.001 ``)
477
+ gcProbablity Same as ``gcProbability ``, see the deprecation note below
477
478
database The name of the database
478
479
collection The name of the collection
479
480
uriOptions Array of URI options for `MongoDBClient::__construct `_
480
481
driverOptions Array of driver options for `MongoDBClient::__construct `_
481
482
============= ================================================================================================
482
483
484
+ .. deprecated :: 6.3
485
+
486
+ The "gcProbablity" option (notice the typo in its name) is deprecated since
487
+ Symfony 6.3, use the "gcProbability" option instead.
488
+
483
489
When the first parameter is a:
484
490
485
491
``MongoDB\Collection ``:
@@ -879,7 +885,7 @@ about `Expire Data from Collections by Setting TTL`_ in MongoDB.
879
885
.. tip ::
880
886
881
887
``MongoDbStore `` will attempt to automatically create a TTL index. It's
882
- recommended to set constructor option ``gcProbablity `` to ``0.0 `` to
888
+ recommended to set constructor option ``gcProbability `` to ``0.0 `` to
883
889
disable this behavior if you have manually dealt with TTL index creation.
884
890
885
891
.. caution ::
0 commit comments