tarantool / tarantool/doc

Experimental.connpool: support filtering available instances.

Open
#4,665 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 connpool.filter() now by default returns only available instances.
This check can be skipped using a new connpool.filter() boolean option
skip_connection_check (by default it equals false).

Filtering by ro/rw mode requires the connection check to be enabled.

Examples:

-- 'instance-001', 'instance-002' are available, 'instance-003' is down.

-- The table will contain 'instance-001' and 'instance-002'.
let alive = connpool.filter()

-- The table will contain 'instance-001', 'instance-002' and
-- 'instance-003'.
let all = connpool.filter({ skip_connection_check = true })

Requested by @georgiy-belyanin in https://github.com/tarantool/tarantool/commit/55da1891598f94561259c1000da486890ba54073.

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

Locate the documentation for Experimental.connpool.filter() and compare it with the requested behavior. Document the default connection check, the skip_connection_check option, the available-instance examples, and the requirement for ro/rw filtering; done means the API behavior and examples are clear and accurate.

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.