Tuple argument of `default_func` field option of `space:format`
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.2
Root documents: https://www.tarantool.io/en/doc/latest/reference/reference_lua/box_space/format/
Depends on https://github.com/tarantool/doc/issues/3617 and https://github.com/tarantool/doc/issues/3520
Details
The source tuple (i.e., the argument of DML) is now passed as a second
argument to the default_func field option of space:format.
See also tarantool/tarantool#9825 and PRD.
Please note that the tuple argument is created from the source tuple data,
which implies the following: (i) fields may not adhere to the space format;
(ii) nil fields are always nil (i.e., the default value and the
default_func are not used).
Requested by @CuriousGeorgiy in https://github.com/tarantool/tarantool/commit/b32b20c6640bb0b1a6ca278bad8061529d46b5b0.
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 linked space:format root document and its default_func field-option section. Document that the source tuple is passed as the second argument, including the stated caveats about format mismatches and nil fields, and verify the wording against dependencies 3617 and 3520.
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
- Mostly clear
- Newbie friendliness
- 35/100