key_def API update - added support for key part sort order.
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 15
- Forks
- 49
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 3
Description
Parent doc. issue(s): https://github.com/tarantool/doc/issues/3746
Related doc. issue(s): https://github.com/tarantool/doc/issues/3748 (C API)
Product: Tarantool
Since: master
Root document: https://www.tarantool.io/en/doc/latest/reference/reference_lua/key_def/
SME: @ mkostoevr
Details
The part sort order is specified the same way as in index creation:
key_def.new({{1, 'unsigned', sort_order = 'desc'}})
The sort order is now taken into account in comparison functions.
Requested by @ mkostoevr in https://github.com/tarantool/tarantool/commit/dcf8bed3185f49a9aed1892df3b72eb5792f042d.
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 root document at reference/reference_lua/key_def/ and review the linked Tarantool commit for the API behavior. Update the key_def documentation to cover the sort_order option and its effect on comparison functions, then check the related parent and C API issues for scope.
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
- 52/100