Skip to content

DOCSP-44703: thread local variable getter/setter #119

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 2 commits into from
Mar 25, 2025
Merged

DOCSP-44703: thread local variable getter/setter #119

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c3e46c5
DOCSP-44703: thread local variable getter/setter
rustagir Mar 25, 2025
c76be2c
wording fix
rustagir Mar 25, 2025
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
3 changes: 2 additions & 1 deletion snooty.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ toc_landing_pages = [
"/quick-start-rails",
"/quick-start-sinatra",
"/interact-data/specify-query",
"/issues-and-help"
"/issues-and-help",
]

[constants]
Expand All @@ -31,5 +31,6 @@ server-manual = "Server manual"
api = "https://www.mongodb.com/docs/mongoid/current/api"
ruby-api = "https://www.mongodb.com/docs/ruby-driver/current/api"
active-record-docs = "https://guides.rubyonrails.org"
ruby-lang-api = "https://docs.ruby-lang.org/en/3.4"
shared-library = "Automatic Encryption Shared Library"
mdb-server = "MongoDB Server"
19 changes: 19 additions & 0 deletions source/data-modeling/callbacks.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -162,6 +162,25 @@ instance:
:emphasize-lines: 6, 10-15
:dedent:

.. _mongoid-callbacks-thread-local-vars:

Thread-Local Variables
~~~~~~~~~~~~~~~~~~~~~~

If you have embedded child documents in an association that has
``cascade_callbacks: true`` configured, then the embedded child
callbacks are executed within a {+language+} `Fiber
<{+ruby-lang-api+}/Fiber.html>`__. This means that if you are using the
``Thread#[]`` and ``Thread#[]=`` methods to get and set fiber-local
variables, those callbacks are not reading or setting the values you expect.

We recommend that you use the ``Thread#thread_variable_get`` and
``Thread#thread_variable_set`` methods to get and set true
thread-local variables. For convenience, {+odm+} v9.0.3 introduces
the `Mongoid::Threaded.get <{+api+}/Mongoid/Threaded.html#get-instance_method>`__
and `Mongoid::Threaded.set <{+api+}/Mongoid/Threaded.html#set-instance_method>`__
methods to implement this functionality.

Additional Information
----------------------

Expand Down
11 changes: 11 additions & 0 deletions source/whats-new.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -178,6 +178,17 @@
- The deprecated class ``{+odm+}::Errors::InvalidStorageParent`` has
been removed.

Get and Set Thread-Local Variables
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. versionadded:: 9.0.3

Check failure on line 185 in source/whats-new.txt

View workflow job for this annotation

GitHub Actions / TDBX Vale rules 

[vale] reported by reviewdog 🐶
[MongoDB.AvoidSubjunctive] Avoid the subjunctive 'should'.

Raw Output:
{"message": "[MongoDB.AvoidSubjunctive] Avoid the subjunctive 'should'.", "location": {"path": "source/whats-new.txt", "range": {"start": {"line": 185, "column": 39}}}, "severity": "ERROR"}
You can use the `Mongoid::Threaded.get <{+api+}/Mongoid/Threaded.html#get-instance_method>`__
and `Mongoid::Threaded.set <{+api+}/Mongoid/Threaded.html#set-instance_method>`__
methods to query and modify thread-local variables. To learn when to use
these methods, see the :ref:`mongoid-callbacks-thread-local-vars`
section of the Callbacks guide.

Index Verification Configuration
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down
Loading