ODBC ドライバ - ClickHouse Documentation

ClickHouse ODBC ドライバは、ODBC 対応アプリケーションを ClickHouse に接続するための標準準拠のインターフェイスを提供します。 ODBC API を実装しており、アプリケーション、BI ツール、スクリプト環境から SQL クエリの実行、結果の取得、そして使い慣れた方法での ClickHouse との連携を可能にします。このドライバは、HTTP protocol を使用して ClickHouse サーバーと通信します。これは、あらゆる ClickHouse デプロイメントでサポートされる主要なプロトコルです。これにより、このドライバはさまざまな環境で一貫して動作できます。たとえば、ローカルインストール、クラウド管理サービス、HTTP ベースのアクセスのみが利用可能な環境などです。このドライバのソースコードは、 ClickHouse-ODBC GitHub Repository で公開されています。

互換性向上のため、ClickHouse サーバーをバージョン 24.11 以降に更新することを強く推奨します。

このドライバは現在も活発に開発が進められています。一部の ODBC 機能は、まだ完全には実装されていない可能性があります。現行バージョンは基本的な接続機能と中核となる ODBC 機能の提供に重点を置いており、追加機能は今後のリリースで対応予定です。皆様からのフィードバックは非常に重要であり、新機能や改善の優先順位付けに役立ちます。制限事項、不足している機能、または予期しない動作に遭遇した場合は、以下の issue tracker からご意見や機能要望をお寄せください。 https://github.com/ClickHouse/clickhouse-odbc/issues

Windows へのインストール

ドライバーの最新バージョンは https://github.com/ClickHouse/clickhouse-odbc/releases/latest から入手できます。そこから MSI インストーラーをダウンロードして実行し、画面の案内に従ってインストールしてください。

テスト

この簡単な PowerShell スクリプトを実行して、ドライバーをテストできます。以下のテキストをコピーし、URL、ユーザー名、パスワードを設定して、そのまま PowerShell のコマンドプロンプトに貼り付けてください。$reader.GetValue(0) を実行すると、ClickHouse サーバーのバージョンが表示されるはずです。

$url = "http://127.0.0.1:8123/"
$username = "default"
$password = ""
$conn = New-Object System.Data.Odbc.OdbcConnection("`
    Driver={ClickHouse ODBC Driver (Unicode)};`
    Url=$url;`
    Username=$username;`
    Password=$password")
$conn.Open()
$cmd = $conn.CreateCommand()
$cmd.CommandText = "select version()"
$reader = $cmd.ExecuteReader()
$reader.Read()
$reader.GetValue(0)
$reader.Close()
$conn.Close()

設定パラメータ

以下のパラメータは、ClickHouse ODBC ドライバとの接続を確立する際によく使用される設定です。認証、接続の動作、データ処理に関する主要なオプションをカバーしています。サポートされているパラメータの完全な一覧は、プロジェクトの GitHub ページ https://github.com/ClickHouse/clickhouse-odbcで確認できます。

Url: ClickHouse サーバーの完全な HTTP(S) エンドポイントを指定します。これには、プロトコル、ホスト、ポート、および任意のパスが含まれます。
Username: ClickHouse サーバーでの認証に使用するユーザー名です。
Password: 指定したユーザー名に対応するパスワードです。指定しない場合、ドライバーはパスワード認証なしで接続します。
Database: 接続時に使用するデフォルトのデータベースです。
Timeout: リクエストを中止する前に、ドライバーがサーバーからの応答を待機する最大時間 (秒) です。
ClientName: クライアントのメタデータの一部として ClickHouse サーバーに送信されるカスタム識別子です。トレーシングや、異なるアプリケーションからのトラフィックの識別に役立ちます。このパラメータは、ドライバーが生成する HTTP リクエストの User-Agent ヘッダーの一部になります。
Compression: リクエストおよびレスポンスのペイロードに対する HTTP 圧縮を有効または無効にします。有効にすると、帯域幅の使用量を削減し、大きな結果セットでのパフォーマンスを向上させることができます。
SqlCompatibilitySettings: ClickHouse が従来のリレーショナルデータベースにより近い動作をするようにするクエリ設定を有効にします。これは、たとえば Power BI のようなサードパーティ製ツールによってクエリが自動生成される場合に便利です。これらのツールは通常、ClickHouse 固有の一部の動作を認識していないため、エラーや想定外の結果につながるクエリを生成することがあります。詳しくは、SqlCompatibilitySettings 設定パラメータで使用される ClickHouse settings を参照してください。

以下は、接続を設定するためにドライバーに渡す完全な接続文字列の例です。

WSL インスタンスにローカルインストールされた ClickHouse サーバー

Driver={ClickHouse ODBC Driver (Unicode)};Url=http://localhost:8123/;Username=default

ClickHouse Cloud のインスタンス。

Driver={ClickHouse ODBC Driver (Unicode)};Url=https://you-instance-url.gcp.clickhouse.cloud:8443/;Username=default;Password=your-password

Microsoft Power BI インテグレーション

ODBC ドライバを使用して、Microsoft Power BI を ClickHouse サーバーに接続できます。Power BI には 2 つの接続オプションがあります。汎用 ODBC コネクタと ClickHouse Connector で、どちらも標準の Power BI インストールに含まれています。どちらのコネクタも内部的には ODBC を利用していますが、機能には違いがあります。

ClickHouse Connector (推奨) 内部では ODBC を使用しますが、DirectQuery モードをサポートしています。このモードでは、Power BI が自動的に SQL クエリを生成し、各可視化やフィルタ操作に必要なデータだけを取得します。
ODBC コネクタ Import モードのみをサポートします。Power BI は、ユーザーが指定したクエリを実行するか (またはテーブル全体を選択して) 、結果セット全体を Power BI にインポートします。以降の更新では、データセット全体が再インポートされます。

ユースケースに応じてコネクタを選択してください。DirectQuery は、大規模なデータセットを扱う対話型ダッシュボードに最適です。データの完全なローカルコピーが必要な場合は、Import モードを選択してください。 Microsoft Power BI と ClickHouse のインテグレーションの詳細については、Power BI インテグレーションに関する ClickHouse ドキュメントページを参照してください。

SQL 互換性設定

ClickHouse には独自の SQL 方言があり、MS SQL Server、MySQL、PostgreSQL などの他のデータベースとは動作が異なる場合があります。多くの場合、こうした違いは利点になります。というのも、ClickHouse の機能をより使いやすくする改善された構文が導入されているためです。しかし、ODBC ドライバは、Power BI などのサードパーティーツールによってクエリが生成され、ユーザーが自分で記述しない環境で使われることがよくあります。こうしたクエリは通常、SQL 標準のごく一部の機能に依存しています。そのため、このような場合には、ClickHouse の SQL 標準からの違いによって期待どおりに動作せず、予期しない結果やエラーが発生することがあります。 ODBC ドライバには、追加の設定パラメーター SqlCompatibilitySettings が用意されており、これを使用すると特定のクエリ設定を有効にして、ClickHouse の動作を標準 SQL により近づけることができます。

SqlCompatibilitySettings 構成パラメータによって有効になる ClickHouse の設定

このセクションでは、ODBC ドライバがどの設定を変更するのかと、その理由を説明します。 cast_keep_nullable デフォルトでは、ClickHouse は Nullable 型から非 Nullable 型への変換を許可していません。しかし、多くの BI ツールは型変換時に Nullable 型と非 Nullable 型を区別しません。そのため、BI ツールによって次のようなクエリが生成されることは珍しくありません。

SELECT sum(CAST(value, 'Int32'))
FROM values

デフォルトでは、valueカラムがNULLを許容している場合、このクエリは次のメッセージで失敗します:

DB::Exception: Cannot convert NULL value to non-Nullable type: while executing 'FUNCTION CAST(__table1.value :: 2,
'Int32'_String :: 1) -> CAST(__table1.value, 'Int32'_String) Int32 : 0'. (CANNOT_INSERT_NULL_IN_ORDINARY_COLUMN)

cast_keep_nullable を有効にすると、CAST の動作が変わり、引数の Nullable 属性が保持されるようになります。これにより、この種の変換における ClickHouse の動作は、他のデータベースや SQL 標準により近くなります。 prefer_column_name_to_alias ClickHouse では、同じ SELECT リスト内の式をその別名で参照できます。たとえば、次のクエリは重複を避けられるため、より簡潔に記述できます。

SELECT
    sum(value) AS S,
    count() AS C,
    S / C
FROM test

この機能は広く使われていますが、他のデータベースでは通常、同じ SELECT リスト内でこのように別名を解決しないため、そのようなクエリはエラーになります。特に問題が表面化しやすいのは、別名がカラムと同じ名前の場合です。たとえば:

SELECT
    sum(value) AS value,
    avg(value)
FROM test

avg(value) は、どの value を集計すべきでしょうか。デフォルトでは、ClickHouse は別名を優先するため、実質的に集約のネストとなってしまいます。これは、ほとんどのツールが想定する動作ではありません。これ自体が問題になることはまれですが、一部の BI ツールは、カラムの別名を再利用するサブクエリを含むクエリを生成します。たとえば、Power BI はよく次のようなクエリを生成します。

SELECT
    sum(C1) AS C1,
    count(C1) AS C2
FROM
(
    SELECT sum(value) AS C1
    FROM test
    GROUP BY group_index
) AS TBL

C1 を参照すると、次のエラーが発生することがあります:

Code: 184. DB::Exception: Received from localhost:9000. DB::Exception: Aggregate function sum(C1) AS C1 is found
inside another aggregate function in query. (ILLEGAL_AGGREGATION)

通常、他のデータベースではこのように同じレベルで別名を解決せず、代わりに C1 をサブクエリのカラムとして扱います。ClickHouse で同様の動作を維持し、そのようなクエリをエラーなしで実行できるようにするため、ODBC ドライバは prefer_column_name_to_alias を有効にします。ほとんどの場合、これらの設定を有効にしても問題はありません。ただし、readonly 設定が 1 に設定されているユーザーは、SELECT クエリであってもいかなる設定も変更できません。そのようなユーザーでは、SqlCompatibilitySettings を有効にするとエラーが発生します。次のセクションでは、この設定パラメーターを読み取り専用ユーザーでも機能させる方法を説明します。

読み取り専用ユーザーで SQL compatibility settings を有効にする

SqlCompatibilitySettings パラメーターを有効にして ODBC ドライバ経由で ClickHouse に接続すると、ドライバがクエリ設定の変更を試みるため、 readonly 設定が 1 のユーザーではエラーが発生します:

Code: 164. DB::Exception: Cannot modify 'cast_keep_nullable' setting in readonly mode. (READONLY)
Code: 164. DB::Exception: Cannot modify 'prefer_column_name_to_alias' setting in readonly mode. (READONLY)

これは、read-only モードのユーザーは個別の SELECT クエリであっても設定の変更が許可されていないために発生します。これを解決する方法はいくつかあります。 オプション 1. readonly を 2 に設定する これが最も簡単な方法です。readonly を 2 に設定すると、ユーザーを read-only モードのままにしつつ、設定を変更できるようになります。

ALTER USER your_odbc_user MODIFY SETTING
    readonly = 2

ほとんどの場合、この問題を解決する最も簡単で推奨される方法は、readonly を 2 に設定することです。これでうまくいかない場合は、2 つ目の方法を使用してください。 方法 2. ODBC ドライバが設定しようとする設定に合わせて、ユーザー設定を変更する。 これも簡単です。ODBC ドライバが設定しようとする内容にあらかじめ合うように、ユーザー設定を更新します。

ALTER USER your_odbc_user MODIFY SETTING
    cast_keep_nullable = 1,
    prefer_column_name_to_alias = 1

この変更により、ODBC ドライバは引き続き設定の適用を試みることができますが、値はすでに一致しているため、実際には変更は行われず、エラーを回避できます。この方法も簡単ですが、メンテナンスが必要です。新しいドライバのバージョンでは、設定の一覧が変更されたり、互換性のために新しい設定が追加されたりする可能性があります。これらの設定を ODBC ユーザーにハードコードすると、 ODBC ドライバが追加の設定を適用するようになるたびに、それらを更新する必要が生じる場合があります。

​Windows へのインストール

​テスト

​設定パラメータ

​Microsoft Power BI インテグレーション

​SQL 互換性設定

​SqlCompatibilitySettings 構成パラメータによって有効になる ClickHouse の設定

​読み取り専用ユーザーで SQL compatibility settings を有効にする

Windows へのインストール

テスト

設定パラメータ

Microsoft Power BI インテグレーション

SQL 互換性設定

SqlCompatibilitySettings 構成パラメータによって有効になる ClickHouse の設定

読み取り専用ユーザーで SQL compatibility settings を有効にする