From 7dc8dd73924597fb0e7e0db32493f89073a29665 Mon Sep 17 00:00:00 2001 From: Atharva Karande Date: Mon, 8 Sep 2025 12:49:54 +0530 Subject: [PATCH] [CLOUDGA-29147] CLI docs for Enable-Disable Connection Pooling. --- docs/ybm_cluster.md | 1 + docs/ybm_cluster_connection-pooling.md | 38 +++++++++++++++++++ .../ybm_cluster_connection-pooling_disable.md | 36 ++++++++++++++++++ docs/ybm_cluster_connection-pooling_enable.md | 36 ++++++++++++++++++ docs/ybm_cluster_create.md | 1 + 5 files changed, 112 insertions(+) create mode 100644 docs/ybm_cluster_connection-pooling.md create mode 100644 docs/ybm_cluster_connection-pooling_disable.md create mode 100644 docs/ybm_cluster_connection-pooling_enable.md diff --git a/docs/ybm_cluster.md b/docs/ybm_cluster.md index 53490c16..f4dd0721 100644 --- a/docs/ybm_cluster.md +++ b/docs/ybm_cluster.md @@ -33,6 +33,7 @@ ybm cluster [flags] * [ybm](ybm.md) - ybm - Effortlessly manage your DB infrastructure on YugabyteDB Aeon (DBaaS) from command line! * [ybm cluster cert](ybm_cluster_cert.md) - Get the root CA certificate +* [ybm cluster connection-pooling](ybm_cluster_connection-pooling.md) - Manage Connection Pooling for a cluster * [ybm cluster create](ybm_cluster_create.md) - Create a cluster * [ybm cluster db-audit-logging](ybm_cluster_db-audit-logging.md) - Configure Database Audit Logging for your Cluster. * [ybm cluster db-query-logging](ybm_cluster_db-query-logging.md) - Configure Database Query Logging for your Cluster. diff --git a/docs/ybm_cluster_connection-pooling.md b/docs/ybm_cluster_connection-pooling.md new file mode 100644 index 00000000..251e5b99 --- /dev/null +++ b/docs/ybm_cluster_connection-pooling.md @@ -0,0 +1,38 @@ +## ybm cluster connection-pooling + +Manage Connection Pooling for a cluster + +### Synopsis + +Manage Connection Pooling for a cluster + +``` +ybm cluster connection-pooling [flags] +``` + +### Options + +``` + -c, --cluster-name string [REQUIRED] The name of the cluster. + -h, --help help for connection-pooling +``` + +### Options inherited from parent commands + +``` + -a, --apiKey string YugabyteDB Aeon account API key + --config string config file (default is $HOME/.ybm-cli.yaml) + --debug Use debug mode, same as --logLevel debug + -l, --logLevel string Select the desired log level format(info). Default to info + --no-color Disable colors in output , default to false + -o, --output string Select the desired output format (table, json, pretty). Default to table + --timeout duration Wait command timeout, example: 5m, 1h. (default 168h0m0s) + --wait Wait until the task is completed, otherwise it will exit immediately, default to false +``` + +### SEE ALSO + +* [ybm cluster](ybm_cluster.md) - Manage cluster operations +* [ybm cluster connection-pooling disable](ybm_cluster_connection-pooling_disable.md) - Disable Connection Pooling for a cluster +* [ybm cluster connection-pooling enable](ybm_cluster_connection-pooling_enable.md) - Enable Connection Pooling for a cluster + diff --git a/docs/ybm_cluster_connection-pooling_disable.md b/docs/ybm_cluster_connection-pooling_disable.md new file mode 100644 index 00000000..83dbcf27 --- /dev/null +++ b/docs/ybm_cluster_connection-pooling_disable.md @@ -0,0 +1,36 @@ +## ybm cluster connection-pooling disable + +Disable Connection Pooling for a cluster + +### Synopsis + +Disable Connection Pooling for a cluster + +``` +ybm cluster connection-pooling disable [flags] +``` + +### Options + +``` + -h, --help help for disable +``` + +### Options inherited from parent commands + +``` + -a, --apiKey string YugabyteDB Aeon account API key + -c, --cluster-name string [REQUIRED] The name of the cluster. + --config string config file (default is $HOME/.ybm-cli.yaml) + --debug Use debug mode, same as --logLevel debug + -l, --logLevel string Select the desired log level format(info). Default to info + --no-color Disable colors in output , default to false + -o, --output string Select the desired output format (table, json, pretty). Default to table + --timeout duration Wait command timeout, example: 5m, 1h. (default 168h0m0s) + --wait Wait until the task is completed, otherwise it will exit immediately, default to false +``` + +### SEE ALSO + +* [ybm cluster connection-pooling](ybm_cluster_connection-pooling.md) - Manage Connection Pooling for a cluster + diff --git a/docs/ybm_cluster_connection-pooling_enable.md b/docs/ybm_cluster_connection-pooling_enable.md new file mode 100644 index 00000000..bf9ed013 --- /dev/null +++ b/docs/ybm_cluster_connection-pooling_enable.md @@ -0,0 +1,36 @@ +## ybm cluster connection-pooling enable + +Enable Connection Pooling for a cluster + +### Synopsis + +Enable Connection Pooling for a cluster + +``` +ybm cluster connection-pooling enable [flags] +``` + +### Options + +``` + -h, --help help for enable +``` + +### Options inherited from parent commands + +``` + -a, --apiKey string YugabyteDB Aeon account API key + -c, --cluster-name string [REQUIRED] The name of the cluster. + --config string config file (default is $HOME/.ybm-cli.yaml) + --debug Use debug mode, same as --logLevel debug + -l, --logLevel string Select the desired log level format(info). Default to info + --no-color Disable colors in output , default to false + -o, --output string Select the desired output format (table, json, pretty). Default to table + --timeout duration Wait command timeout, example: 5m, 1h. (default 168h0m0s) + --wait Wait until the task is completed, otherwise it will exit immediately, default to false +``` + +### SEE ALSO + +* [ybm cluster connection-pooling](ybm_cluster_connection-pooling.md) - Manage Connection Pooling for a cluster + diff --git a/docs/ybm_cluster_create.md b/docs/ybm_cluster_create.md index a67b64df..5b542c0a 100644 --- a/docs/ybm_cluster_create.md +++ b/docs/ybm_cluster_create.md @@ -34,6 +34,7 @@ ybm cluster create [flags] --region-info stringArray Region information for the cluster, provided as key-value pairs. Arguments are region=,num-nodes=,vpc=,num-cores=,disk-size-gb=,disk-iops= (AWS only). region, num-nodes, num-cores, disk-size-gb are required. Specify one --region-info flag for each region in the cluster. --preferred-region string [OPTIONAL] The preferred region in a multi region cluster. The preferred region handles all read and write requests from clients. --default-region string [OPTIONAL] The primary region in a partition-by-region cluster. The primary region is where all the tables not created in a tablespace reside. + --enable-connection-pooling [OPTIONAL] Enable connection pooling for the cluster during creation. Default false. -h, --help help for create ```