Skip to content

doc: clarify connection pooling in createClient and fix broken link in isolationPoolOptions #2896

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 3, 2025

Conversation

rickyssj2
Copy link
Contributor

Description

This PR improves the createClient documentation by:

  • Adding a Connection Pooling section to clarify that a single connection is usually sufficient for Redis and directing users to RedisClientPool for scenarios requiring connection pooling.
  • Updating isolationPoolOptions to provide a clearer explanation and replacing the broken link with a reference to createClientPool.
  • These updates help address #2845.

…in isolationPoolOptions

- Added a Connection Pooling section in `createClient` documentation to clarify that a single connection is typically sufficient and to provide guidance on when to use a connection pool.
- Updated `isolationPoolOptions` description with a more precise explanation and replaced the broken link with a reference to `createClientPool`.
- Changes made based on issue redis#2845.
Copy link
Collaborator

@nkaradzhov nkaradzhov left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

CLGTM

@nkaradzhov nkaradzhov merged commit 964b8de into redis:master May 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants