aws / aws/amazon-redshift-python-driver

docs: client_protocol_version missing from Connection Parameters table

Aperta Adatta ai principianti
#276 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
Lingua principale
Python
Stelle
220
Fork
86
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

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.

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

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.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
python
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
1/5
Tempo stimato
1-3 ore
Stato di attività
Tranquilla
Chiarezza
Abbastanza chiara
Idoneità per principianti
74/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.