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.
貢獻指南
研究方向
從 README 的 Client Transfer Protocol 區段和 Connection Parameters 表開始,其中引用了 client_protocol_version,但未列出該參數。與 maintainers 確認有效值,然後記錄該參數的型別、預設值、描述、有效值以及 Python 連線範例。表格和使用文件一致地涵蓋該參數即視為完成。
由索引模型根據 Issue 內容生成。
評估
- 技術堆疊
- python
- 領域
- documentation
- Issue 類型
- 文件
- 難度
- 1/5
- 預估耗時
- 1-3 小時
- 活躍度
- 冷清
- 描述清晰度
- 基本清楚
- 新手友好度
- 74/100