tarantool / tarantool/doc

vshard: `bucket_ids` option for `router.map_callrw()`

Open
#4,596 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
CSS
Stars
15
Forks
49
Avg merge
1d 13h
Merged PRs (30d)
3

Description

The option is an array of numeric bucket IDs. When specified, the
Ref-Map-Reduce is only performed on the masters having at least
one of these buckets. By default all the stages are done on all
masters in the cluster.

Example:

-- Assume buckets 1, 2, 3 cover replicasets UUID_A and UUID_B.
res, err = vshard.router.map_callrw(func, args, {bucket_ids = {1, 2, 3}})
assert(res[UUID_A] == {func_result_from_A})
assert(res[UUID_B] == {func_result_from_B})

Requested by @Gerold103 in https://github.com/tarantool/vshard/commit/5fa6ad51415fcfa50e9aa0ade533e3aa6c22aafe.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the existing reference entry for vshard.router.map_callrw and read how its options are documented. Document the bucket_ids option, including its numeric bucket ID array, master-selection behavior, default behavior, and the provided example; done means the option and example are covered in the relevant documentation.

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
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.