box.atomic({is_sync = true})

Open Beginner friendly
#3,885 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
65/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
lua
Domain
documentation

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.

Description

3.0 reference transactions

Product: Tarantool
Since: 3.0
Root document:

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
Dominant language
CSS
Stars
15
Forks
49
Avg merge
1d 13h
Merged PRs (30d)
3

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from tarantool/doc

All issues in tarantool/doc

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.