aws / aws/amazon-redshift-python-driver
docs: client_protocol_version missing from Connection Parameters table
- 主要语言
- Python
- 星标
- 220
- 派生
- 86
- PR 合并指标
- 30 天内没有已合并 PR
描述
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.
贡献指南
调研方向
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.
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- python
- 领域
- documentation
- Issue 类型
- 文档
- 难度
- 1/5
- 预计耗时
- 1-3 小时
- 活跃度
- 冷清
- 描述清晰度
- 基本清楚
- 新手友好度
- 74/100