vshard: vshard.router.buckets_info shows name
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 15
- Forks
- 49
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 3
Description
Related dev. issue: https://github.com/tarantool/vshard/issues/426
Related doc. issues: https://github.com/tarantool/doc/issues/3942, https://github.com/tarantool/doc/issues/3944
Product: Tarantool, vshard
Since: 3.0, 0.1.25
Root document: https://www.tarantool.io/en/doc/latest/reference/reference_rock/vshard/vshard_router/
SME: @ Totktonada, @ Serpentian
Details
When identification_mode is name_as_key, buckets_info()
also returns name of the replicas, where buckets are stored:
tarantool> vshard.router.buckets_info()
---
- - uuid: aaaaaaaa-0000-4000-a000-000000000000
status: available_rw
name: replica_1_a
Requested by @Serpentian in https://github.com/tarantool/vshard/commit/daa31a023e4eb2ddc2ac1e91cb68a09450252ef5.
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
Open the vshard.router reference page linked as the root document and locate the buckets_info() documentation. Update it to describe that name_as_key also returns each replica's name, using the supplied output example as the expected result. Done means the reference page accurately documents this behavior and example.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 50/100