docs: client_protocol_version missing from Connection Parameters table
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 74/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Quiet
- Tech stack
- python
- Domain
- documentation
Research direction
Start in the README's Client Transfer Protocol section and Connection Parameters table, where client_protocol_version is referenced but not listed. Confirm the valid values with maintainers, then document the parameter's type, default, description, valid values, and Python connection example. Done means the table and usage documentation consistently cover the parameter.
Written by the indexing model from the issue text.
Description
The README references client_protocol_version under "Client Transfer Protocol," stating it can modify the protocol version. However, this parameter is:
- Absent from the Connection Parameters table
- 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.
- Dominant language
- Python
- Stars
- 220
- Forks
- 86
- PR merge metrics
- No merged PRs in 30d
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from aws/amazon-redshift-python-driver
-
Difficulty 4/5 3-5 days Newbie friendliness 30/100
aws/amazon-redshift-python-driver#268 · 2 reactions ·
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
aws/amazon-redshift-python-driver#265 · 1 comment · 4 reactions ·
-
Difficulty 3/5 1-2 days Newbie friendliness 45/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 48/100
aws/amazon-redshift-python-driver#260 · 5 comments · 2 reactions ·
All issues in aws/amazon-redshift-python-driver
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100