box.schema.needs_upgrade can now be used
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 15
- Forks
- 49
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 3
Description
Since: 3.6
Root document: https://www.tarantool.io/en/doc/latest/reference/reference_lua/box_schema/upgrade/
The box.schema.needs_upgrade function can be used to check if the
schema version does not correspond to the current instance version.
Requested by @mkostoevr in https://github.com/tarantool/tarantool/commit/68955ea2aabbb17d339975d53a2ac7c21d7294d1.
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 box.schema upgrade reference and inspect how related schema functions are documented. Add the box.schema.needs_upgrade documentation, including that it is available since 3.6 and checks whether the schema version matches the current instance version. Done means the function is covered in the appropriate reference section and the documentation builds successfully.
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
- 55/100