Skip to content

docs: document client_protocol_version in connection parameters table #286

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

Open
reginaldalfret wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: document client_protocol_version in connection parameters table #286

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 15 additions & 0 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand Down Expand Up @@ -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
~~~~~~~~~~~~
Expand Down