Skip to content

[Lock] Mention gcProbability option and deprecation #18524

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 6, 2023
Merged

[Lock] Mention gcProbability option and deprecation #18524

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 12 additions & 6 deletions components/lock.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -460,7 +460,7 @@ avoid stalled locks::

$mongo = 'mongodb://localhost/database?collection=lock';
$options = [
'gcProbablity' => 0.001,
'gcProbability' => 0.001,
'database' => 'myapp',
'collection' => 'lock',
'uriOptions' => [],
Expand All @@ -470,16 +470,22 @@ avoid stalled locks::

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``)
============== ================================================================================================
Option Description
============== ================================================================================================
gcProbability Should a TTL Index be created expressed as a probability from 0.0 to 1.0 (Defaults to ``0.001``)
gcProbablity Same as ``gcProbability``, see the deprecation note below
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`_
============= ================================================================================================

.. deprecated:: 6.3

The "gcProbablity" option (notice the typo in its name) is deprecated since
Symfony 6.3, use the "gcProbability" option instead.

When the first parameter is a:

``MongoDB\Collection``:
Expand Down Expand Up @@ -879,7 +885,7 @@ about `Expire Data from Collections by Setting TTL`_ in MongoDB.
.. tip::

``MongoDbStore`` will attempt to automatically create a TTL index. It's
recommended to set constructor option ``gcProbablity`` to ``0.0`` to
recommended to set constructor option ``gcProbability`` to ``0.0`` to
disable this behavior if you have manually dealt with TTL index creation.

.. caution::
Expand Down