aws / aws/amazon-redshift-python-driver

docs: client_protocol_version missing from Connection Parameters table

Aberta Para iniciantes
#276 0 comentários 0 reações 0 responsáveis Ver no GitHub
Linguagem predominante
Python
Estrelas
220
Forks
86
Métricas de merge de PRs
Nenhum PR com merge em 30d

Descrição

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.

Guia de contribuição

Abrir o guia de contribuição

Direção de pesquisa

Comece pela seção Client Transfer Protocol e pela tabela Connection Parameters do README, onde client_protocol_version é referenciado, mas não está listado. Confirme os valores válidos com os maintainers e, em seguida, documente o tipo, o valor padrão, a descrição, os valores válidos e um exemplo de conexão em Python para o parâmetro. Considera-se concluído quando a tabela e a documentação de uso cobrirem o parâmetro de forma consistente.

Escrita pelo modelo de indexação a partir do texto da issue.

Avaliação

Stack de tecnologia
python
Domínio
documentation
Tipo de issue
Documentação
Dificuldade
1/5
Tempo estimado
1-3 horas
Status de atividade
Pouca atividade
Clareza
Razoavelmente clara
Facilidade para iniciantes
74/100

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.