box.atomic({is_sync = true})
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 15
- Forks
- 49
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 3
Description
Product: Tarantool
Since: 3.0
Root document:
- https://www.tarantool.io/en/doc/latest/reference/reference_lua/box_txn_management/atomic/
- (possibly) https://www.tarantool.io/en/doc/latest/concepts/atomic/txn_mode_mvcc/
SME: @ yanshtunder
Details
Added the new is_sync parameter to box.atomic(). To make the
transaction synchronous, set the is_sync option to true. Setting
is_sync = false is prohibited. If to set any value other than true
for example is_sync = "some string", then an error will be thrown.
Requested by @yanshtunder in https://github.com/tarantool/tarantool/commit/c3c0d439ce8f468f5d5088db3bf3d783d5fb5c24.
Definition of done
- The new parameter is described in the
box.atomic()reference - The usage is shown in examples where applicable
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the box.atomic() reference at the linked Tarantool documentation page, then check the linked MVCC transaction-mode concept page for related guidance. Document the is_sync parameter, its accepted values and error behavior, and add usage examples where applicable; done means both checklist items are covered.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- lua
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 65/100