Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

[client-v2] Expose supported configuration options via a public API

Abierto
  • ¿Algo no está bien?
#3,059 2 comentarios 1 reacción 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
45/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
java
Área
api, developer-experience

Línea de trabajo

Comience con el enum ClientConfigProperties de client-v2 y el punto de entrada Driver.getPropertyInfo(url, info) de jdbc-v2; después, siga cómo se definen actualmente las claves, los tipos y los valores predeterminados. La implementación debe proporcionar metadatos estructurados para plain client-v2, cubrir los prefijos dinámicos y los flags solicitados, y mantener coherente la información de propiedades de JDBC.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

area:general client-api-v2 enhancement

Is your feature request related to a problem?

Connectors and tools built on top of the Java client (e.g. Kafka Connect sink, Spark connector, ingestion frameworks, config-validation UIs) need to know which configuration options the client supports so they can expose, validate, and document them programmatically. Today there is no supported API call to retrieve this list:

  • ClientConfigProperties (client-v2) is a public enum, but it only carries the option key, value type, and default value — no human-readable description, no allowed-value/choices metadata, and no indication of whether an option is required or deprecated.
  • jdbc-v2 implements Driver.getPropertyInfo(url, info) returning DriverPropertyInfo[], but that is JDBC-specific and not usable from plain client-v2.

Describe the solution you'd like

A public API on the client (e.g. Client.getSupportedOptions() or a static method on ClientConfigProperties) that returns structured metadata for every supported option:

  • option key (e.g. connect_timeout)
  • value type
  • default value
  • description
  • allowed values / choices where applicable
  • flags such as required, deprecated, sensitive (e.g. password, so tools know to mask it)

This would let integrators generate their config surface directly from the client instead of hard-coding option lists that drift out of date. Ideally jdbc-v2's getPropertyInfo would be backed by the same metadata source so the two stay consistent.

Describe alternatives you've considered

  • Iterating ClientConfigProperties.values() via the enum — works for key/type/default but lacks descriptions and semantic metadata, and does not cover dynamic prefixes (clickhouse_setting_*, http_header_*).
  • Scraping the docs — brittle and not machine-friendly.
Lenguaje dominante
Java
Estrellas
1.6k
Forks
638
Merge medio
2 d 14 h
PR fusionados (30 d)
44

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de ClickHouse/clickhouse-java

Todos los issues de ClickHouse/clickhouse-java

Issues similares

Más issues de Java

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.