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

オープン
#3,059 コメント 2 件 リアクション 1 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
45/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
活発
技術スタック
java

調査の方向性

client-v2 の ClientConfigProperties enum と jdbc-v2 の Driver.getPropertyInfo(url, info) エントリーポイントから始め、現在のキー、型、デフォルト値がどのように定義されているかを追跡します。完了時には plain client-v2 用の構造化メタデータを提供し、動的なプレフィックスと要求されたフラグをカバーし、JDBC のプロパティ情報の一貫性を維持する必要があります。

索引モデルが issue の本文から書いたものです。

説明

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.
主要言語
Java
スター
1.6k
フォーク
637
平均マージ
2日 12時間
マージ済み PR(30日)
28

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

ClickHouse/clickhouse-java のほかの issue

ClickHouse/clickhouse-java の issue をすべて見る

似ている issue

Java の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。