From 37c5f08ce04e137024c1fba9e85d49733246a105 Mon Sep 17 00:00:00 2001 From: reginaldalfret Date: Fri, 2 Oct 2026 23:39:05 +0530 Subject: [PATCH] docs: document client_protocol_version in connection parameters table Adds client_protocol_version to the Connection Parameters table in README.rst and includes a usage example in the Client Transfer Protocol section. Fixes #276 Signed-off-by: reginaldalfret --- README.rst | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.rst b/README.rst index 423d9c8..c12f076 100644 --- a/README.rst +++ b/README.rst @@ -372,6 +372,8 @@ Connection Parameters +-----------------------------------+------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------+----------+ | client_id | str | The client id from Azure IdP | None | No | +-----------------------------------+------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------+----------+ +| client_protocol_version | int | The requested wire transfer protocol version to use for data transfer. Supported values are 0 (base server), 1 (extended result metadata), and 2 (binary transfer protocol). | 2 | No | ++-----------------------------------+------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------+----------+ | client_secret | str | The client secret from Azure IdP | None | No | +-----------------------------------+------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------+----------+ | cluster_identifier | str | The cluster identifier of the Amazon Redshift Cluster | None | No | @@ -532,6 +534,19 @@ Client Transfer Protocol ``redshift_connector`` requests the Amazon Redshift server use the highest transfer protocol version supported. As of v2.0.879 binary transfer protocol is requested by default. If necessary, the requested transfer protocol can be modified via the ``client_protocol_version`` parameter of ``redshift_connector.connect(...)``. Please see the Connection Parameters table for more details. +.. code-block:: python + + import redshift_connector + + conn = redshift_connector.connect( + host="examplecluster.abc123xyz789.us-west-1.redshift.amazonaws.com", + database="dev", + user="awsuser", + password="my_password", + client_protocol_version=2, + ) + + Getting Help ~~~~~~~~~~~~