DOCSP-42774: transactions #63
Conversation
✅ Deploy Preview for docs-mongoid ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
There was a problem hiding this comment.
Take a lot of these suggestions with a grain of salt because they definitely stem from my lack of Ruby knowledge.
Also, will the existing Sessions and Transactions pages be removed/redirected?
source/interact-data/transaction.txt
Outdated
| In {+odm+}, you can perform transactions by using the following APIs: | ||
|
|
||
| - :ref:`mongoid-txn-high-level`: {+odm+} manages the life cycle of the | ||
| transaction. You can use this API in {+odm+} v9.0 and later. | ||
|
|
||
| - :ref:`mongoid-txn-low-level`: You must manage the life cycle of the | ||
| transaction. You can use this API in {+odm+} v6.4 and later. |
There was a problem hiding this comment.
S: Feel free to ignore, but something here makes me feel like the APIs are actually named "higher level API" and "lower level API".
| In {+odm+}, you can perform transactions by using the following APIs: | |
| - :ref:`mongoid-txn-high-level`: {+odm+} manages the life cycle of the | |
| transaction. You can use this API in {+odm+} v9.0 and later. | |
| - :ref:`mongoid-txn-low-level`: You must manage the life cycle of the | |
| transaction. You can use this API in {+odm+} v6.4 and later. | |
| In {+odm+}, you can perform transactions by using one or both of the following APIs: | |
| - :ref:`Higher Level <mongoid-txn-high-level>`: {+odm+} manages the life cycle of the | |
| transaction. You can use this API in {+odm+} v9.0 and later. | |
| - :ref:`Lower Level <mongoid-txn-low-level>`: You must manage the life cycle of the | |
| transaction. You can use this API in {+odm+} v6.4 and later. |
There was a problem hiding this comment.
I'll get a clarification on this
| :dedent: | ||
|
|
||
| To learn more about the available session options, see the | ||
| :ruby-api:`Session class constructor details |
There was a problem hiding this comment.
Note: API links are broken until the next snooty parser release see mongodb/snooty-parser#633
| # Starts a session from an instance of Book | ||
| book.with_session do |session| | ||
| # Starts the transaction in the session | ||
| session.start_transaction |
There was a problem hiding this comment.
I am not sure whether this and following two examples make sense. We should call session.start_transaction and session.commit_transaction or session.abort_transaction within the same with_session block. Maybe we should combine there examples into one.
There was a problem hiding this comment.
Discussed the updated code example over slack: https://mongodb.slack.com/archives/C076TNB2613/p1731947987671689?thread_ts=1731941918.388399&cid=C076TNB2613
source/interact-data/transaction.txt
Outdated
|
|
||
| .. _mongoid-txn-convenient: | ||
|
|
||
| Convenient Transaction API |
There was a problem hiding this comment.
The term "Convenient Transaction API" refers to the drivers API. It can be used in Mongoid like this (but this it probably not the best idea):
person.with_session do |session|
session.with_transaction do
person.save!
end
endMaybe we should not using this term to avoid confusion.
There was a problem hiding this comment.
Reverted the terminology to use high-level and low-level
Pull Request Info
PR Reviewing Guidelines
JIRA - https://jira.mongodb.org/browse/DOCSP-42774
Staging - https://deploy-preview-63--docs-mongoid.netlify.app/interact-data/transaction/
Self-Review Checklist