vshard: vshard.storage.cfg argument change
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 15
- Forks
- 49
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 3
Description
Related dev. issue(s): https://github.com/tarantool/vshard/issues/426
Product: Tarantool, vshard
Since: 3.0 (vshard 0.1.25)
Root document:
- https://www.tarantool.io/en/doc/latest/how-to/vshard_quick/
- https://www.tarantool.io/en/doc/latest/reference/reference_rock/vshard/vshard_storage/#storage-api-cfg
SME: @ Serpentian
Details
vshard.storage.cfg(cfg, instance_id)
Configure the database and start sharding for the specified storage
instance. istance_id depends on identification_mode used in config.
If it's 'uuid_as_key', which is default, then UUID must be used.
Otherwise - instance_name.
Parameters:
cfg – a storage configuration
instance_id – UUID or name of the instance
Requested by @ Serpentian in https://github.com/tarantool/vshard/commit/4c9cc51f22c8665998a05c47e7e80b7f55bd9591.
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 vshard.storage.cfg sections in the vshard quick-start guide and the storage API reference linked in the issue. Check that both describe instance_id as a UUID or instance name according to identification_mode, and that the signature and parameter text match the current behavior.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 68/100