C 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/3747 (Lua API)
Product: Tarantool
Since: master
Root document: https://www.tarantool.io/en/doc/latest/dev_guide/reference_capi/
SME: @ mkostoevr
Details
Looks like the box_key_part_def_t type isn't documented, but
BOX_KEY_PART_DEF_SORT_ORDER bit field was added to its flags
member. The possible values are:
BOX_KEY_PART_DEF_SORT_ORDER_ASC: default sort order.
BOX_KEY_PART_DEF_SORT_ORDER_DESC: reversed sort order.
Requested by @ mkostoevr in https://github.com/tarantool/tarantool/commit/e9b550431e8ebbaeab3569614bdfffbbc529181a.
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 C API root document at https://www.tarantool.io/en/doc/latest/dev_guide/reference_capi/ and locate the section for box_key_part_def_t. Document the flags member and the BOX_KEY_PART_DEF_SORT_ORDER_ASC and BOX_KEY_PART_DEF_SORT_ORDER_DESC values, including their stated meanings. Done means the type and both sort-order options are covered in the C API documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- c
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 62/100