docs: client_protocol_version missing from Connection Parameters table

Aperta Adatta ai principianti
#276 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

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

Direzione di ricerca

Inizia dalla sezione Client Transfer Protocol e dalla tabella Connection Parameters del README, dove client_protocol_version è menzionato ma non elencato. Conferma i valori validi con i maintainers, quindi documenta il tipo, il valore predefinito, la descrizione, i valori validi e un esempio di connessione Python per il parametro. Il lavoro è completo quando la tabella e la documentazione sull’utilizzo coprono il parametro in modo coerente.

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

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.

Lingua principale
Python
Stelle
220
Fork
86
Nessuna PR unita negli ultimi 30g

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di aws/amazon-redshift-python-driver

Tutte le issue di aws/amazon-redshift-python-driver

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.