Skip to content
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.

Sign up for GitHub

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

[doc][2024.2.1] Update YSQL Connection Manager to EA tag #25555

Merged
merged 2 commits into from
Jan 14, 2025
Merged

[doc][2024.2.1] Update YSQL Connection Manager to EA tag #25555

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ae5958d
Release time!
rahulb-yb Jan 9, 2025
4a8df8c
TP -> EA
ddhodge Jan 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/content/stable/develop/best-practices-ysql.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@ For more information, see [Connection pooling](../../drivers-orms/smart-drivers/

## Use YSQL Connection Manager

YugabyteDB includes a built-in connection pooler, YSQL Connection Manager {{<tags/feature/tp>}}, which provides the same connection pooling advantages as other external pooling solutions, but without many of their limitations. As the manager is bundled with the product, it is convenient to manage, monitor, and configure the server connections.
YugabyteDB includes a built-in connection pooler, YSQL Connection Manager {{<tags/feature/ea>}}, which provides the same connection pooling advantages as other external pooling solutions, but without many of their limitations. As the manager is bundled with the product, it is convenient to manage, monitor, and configure the server connections.

For more information, refer to the following:

Expand Down
6 changes: 3 additions & 3 deletions docs/content/stable/explore/going-beyond-sql/connection-mgr-ysql.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ linkTitle: Built-in connection pooling
description: Built-in server-side connection pooler for YSQL
headcontent: Built-in server-side connection pooler for YSQL
tags:
feature: tech-preview
feature: early-access
menu:
stable:
name: Built-in connection pooling
Expand All @@ -27,7 +27,7 @@ To provide the advantages of connection pooling, but without the limitations, Yu
![Connection manager](/images/explore/ysql-connection-manager.png)

{{< note title = "Note">}}
YSQL Connection Manager is currently not supported for [YugabyteDB Anywhere](../../../yugabyte-platform/) and [YugabyteDB Aeon](../../../yugabyte-cloud/).
YSQL Connection Manager is currently not supported for [YugabyteDB Aeon](../../../yugabyte-cloud/).
{{< /note >}}

## Key features
Expand Down Expand Up @@ -69,7 +69,7 @@ To create a large number of client connections, ensure that "SHMMNI" (the maximu

### YugabyteDB Anywhere

{{<tags/feature/tp>}}To use built-in connection pooling with universes deployed using YugabyteDB Anywhere, turn on the **Connection pooling** option when [creating](../../../yugabyte-platform/create-deployments/create-universe-multi-zone/#advanced-configuration) or [modifying](../../../yugabyte-platform/manage-deployments/edit-universe/#edit-connection-pooling) a universe. When managing universes using YugabyteDB Anywhere, do not set connection pooling options using flags.
{{<tags/feature/ea>}}To use built-in connection pooling with universes deployed using YugabyteDB Anywhere, turn on the **Connection pooling** option when [creating](../../../yugabyte-platform/create-deployments/create-universe-multi-zone/#advanced-configuration) or [modifying](../../../yugabyte-platform/manage-deployments/edit-universe/#edit-connection-pooling) a universe. When managing universes using YugabyteDB Anywhere, do not set connection pooling options using flags.

## Configuration

Expand Down
4 changes: 2 additions & 2 deletions ...ntent/stable/yugabyte-platform/create-deployments/create-universe-multi-zone.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,8 +132,8 @@ Enhanced Postgres Compatibility
: If database version is v2024.2 or later, you can enable early access features for PostgreSQL compatibility. For more information, refer to [Enhanced PostgreSQL Compatibility Mode](../../../develop/postgresql-compatibility/).

Enable Connection Pooling
: {{<tags/feature/tp>}}If database version is v2024.2 or later, you can enable [Built-in connection pooling](../../../explore/going-beyond-sql/connection-mgr-ysql/).
: While in Tech Preview, connection pooling is not available by default. To make the feature available, set the *Allow users to enable or disable connection pooling* Global Runtime Configuration option (config key `yb.universe.allow_connection_pooling`) to true. Refer to [Manage runtime configuration settings](../../administer-yugabyte-platform/manage-runtime-config/). You must be a Super Admin to set global runtime configuration flags.
: {{<tags/feature/ea>}}If database version is v2024.2 or later, you can enable [Built-in connection pooling](../../../explore/going-beyond-sql/connection-mgr-ysql/).
: While in Early Access, connection pooling is not available by default. To make the feature available, set the *Allow users to enable or disable connection pooling* Global Runtime Configuration option (config key `yb.universe.allow_connection_pooling`) to true. Refer to [Manage runtime configuration settings](../../administer-yugabyte-platform/manage-runtime-config/). You must be a Super Admin to set global runtime configuration flags.

Enable Systemd Services
: To use cron instead of systemd for managing nodes, you can disable systemd services. This is not recommended.
Expand Down
4 changes: 2 additions & 2 deletions docs/content/stable/yugabyte-platform/manage-deployments/edit-universe.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,9 +54,9 @@ To change the number of nodes of universes created with an on-premises cloud pro

### Edit connection pooling

{{<tags/feature/tp>}}If your universe is running database v2024.2 or later, you can enable [Built-in connection pooling](../../../explore/going-beyond-sql/connection-mgr-ysql/).
{{<tags/feature/ea>}}If your universe is running database v2024.2 or later, you can enable [Built-in connection pooling](../../../explore/going-beyond-sql/connection-mgr-ysql/).

While in Tech Preview, the feature is not available by default. To make connection pooling available, set the **Allow users to enable or disable connection pooling** Global Runtime Configuration option (config key `yb.universe.allow_connection_pooling`) to true. Refer to [Manage runtime configuration settings](../../administer-yugabyte-platform/manage-runtime-config/). You must be a Super Admin to set global runtime configuration flags.
While in Early Access, the feature is not available by default. To make connection pooling available, set the **Allow users to enable or disable connection pooling** Global Runtime Configuration option (config key `yb.universe.allow_connection_pooling`) to true. Refer to [Manage runtime configuration settings](../../administer-yugabyte-platform/manage-runtime-config/). You must be a Super Admin to set global runtime configuration flags.

To enable or disable connection pooling on a universe:

Expand Down