aws / aws/amazon-redshift-python-driver
docs: client_protocol_version missing from Connection Parameters table
- Lenguaje dominante
- Python
- Estrellas
- 220
- Forks
- 86
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Descripción
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.
Guía de contribución
Línea de trabajo
Comienza en la sección Client Transfer Protocol y en la tabla Connection Parameters del README, donde se hace referencia a client_protocol_version, pero no se incluye. Confirma los valores válidos con los maintainers y, después, documenta el tipo, el valor predeterminado, la descripción, los valores válidos y un ejemplo de conexión en Python para el parámetro. Se considera terminado cuando la tabla y la documentación de uso cubren el parámetro de forma coherente.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- python
- Área
- documentation
- Tipo de issue
- Documentación
- Dificultad
- 1/5
- Tiempo estimado
- 1-3 horas
- Estado de actividad
- Tranquilo
- Claridad
- Bastante claro
- Aptitud para principiantes
- 74/100