aws / aws/amazon-redshift-python-driver

docs: client_protocol_version missing from Connection Parameters table

Open
#276 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
220
Forks
86
PR merge metrics
No merged PRs in 30d

Description

The README references client_protocol_version under "Client Transfer Protocol," stating it can modify the protocol version. However, this parameter is:



  1. Absent from the Connection Parameters table

  2. Has no usage example or valid values documented


Suggested addition to the parameters table:

Parameter | Type | Default | Description
-- | -- | -- | --
client_protocol_version | int | 2 | Controls the wire protocol version for data transfer

Example:


conn = redshift_connector.connect(

host='cluster.abc123.us-east-1.redshift.amazonaws.com',
database='dev',
user='admin',
password='***',
client_protocol_version=2
)

Happy to open a PR if maintainers can confirm the valid values.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.