メインコンテンツへスキップ
メインコンテンツへスキップ

ODBC テーブルエンジン

Not supported in ClickHouse Cloud

ClickHouse が ODBC を介して外部データベースに接続できるようにするエンジンです。

ODBC 接続を安全に実装するために、ClickHouse は別のプログラム clickhouse-odbc-bridge を使用します。ODBC ドライバを clickhouse-server から直接ロードすると、ドライバ側の問題によって ClickHouse サーバーがクラッシュする可能性があります。ClickHouse は必要に応じて自動的に clickhouse-odbc-bridge を起動します。ODBC ブリッジプログラムは clickhouse-server と同じパッケージからインストールされます。

このエンジンは Nullable データ型をサポートします。

テーブルを作成する​

CREATE TABLE [IF NOT EXISTS] [db.]table_name [ON CLUSTER cluster]
(
    name1 [type1],
    name2 [type2],
    ...
)
ENGINE = ODBC(datasource, external_database, external_table)

CREATE TABLE クエリの詳細な説明については、該当ページを参照してください。

テーブル構造は、ソーステーブルの構造と異なっていてもかまいません。

  • 列名はソーステーブルと同じである必要がありますが、その一部の列だけを任意の順序で使用できます。
  • 列の型は、ソーステーブルとは異なっていてもかまいません。ClickHouse は値を ClickHouse のデータ型にキャストしようとします。
  • external_table_functions_use_nulls 設定は、Nullable 列をどのように扱うかを定義します。デフォルト値は 1 です。0 の場合、テーブル関数は Nullable 列を作成せず、null の代わりにデフォルト値を挿入します。これは配列内の NULL 値にも適用されます。

エンジンパラメータ

  • datasource — odbc.ini ファイル内の、接続設定が記述されたセクション名。
  • external_database — 外部 DBMS 内のデータベース名。
  • external_table — external_database 内のテーブル名。

これらのパラメータは、named collections を使用して指定することもできます。

使用例​

ODBC を介してローカルの MySQL インストールからデータを取得する

この例は Ubuntu Linux 18.04 と MySQL サーバー 5.7 で動作確認されています。

unixODBC と MySQL Connector がインストールされていることを確認してください。

デフォルトでは（パッケージからインストールした場合）、ClickHouse はユーザー clickhouse として起動します。そのため、MySQL サーバーでこのユーザーを作成し、適切に設定する必要があります。

$ sudo mysql

mysql> CREATE USER 'clickhouse'@'localhost' IDENTIFIED BY 'clickhouse';
mysql> GRANT ALL PRIVILEGES ON *.* TO 'clickhouse'@'localhost' WITH GRANT OPTION;

その後、/etc/odbc.ini で接続を設定します。

$ cat /etc/odbc.ini
[mysqlconn]
DRIVER = /usr/local/lib/libmyodbc5w.so
SERVER = 127.0.0.1
PORT = 3306
DATABASE = test
USER = clickhouse
PASSWORD = clickhouse

unixODBC のインストールに含まれる isql ユーティリティを使用して、接続をテストできます。

$ isql -v mysqlconn
+-------------------------+
| 接続に成功しました!                  |
|                                       |
...

MySQL のテーブル:

mysql> CREATE DATABASE test;
クエリ OK, 1 行が影響を受けました (0,01 秒)

mysql> CREATE TABLE `test`.`test` (
    ->   `int_id` INT NOT NULL AUTO_INCREMENT,
    ->   `int_nullable` INT NULL DEFAULT NULL,
    ->   `float` FLOAT NOT NULL,
    ->   `float_nullable` FLOAT NULL DEFAULT NULL,
    ->   PRIMARY KEY (`int_id`));
クエリ OK, 0 行が影響を受けました (0,09 秒)

mysql> insert into test.test (`int_id`, `float`) VALUES (1,2);
クエリ OK, 1 行が影響を受けました (0,00 秒)

mysql> select * from test.test;
+------+----------+-----+----------+
| int_id | int_nullable | float | float_nullable |
+------+----------+-----+----------+
|      1 |         NULL |     2 |           NULL |
+------+----------+-----+----------+
1 行が取得されました (0,00 秒)

MySQL テーブルからデータを取得する ClickHouse テーブル:

CREATE TABLE odbc_t
(
    `int_id` Int32,
    `float_nullable` Nullable(Float32)
)
ENGINE = ODBC('DSN=mysqlconn', 'test', 'test')

SELECT * FROM odbc_t

┌─int_id─┬─float_nullable─┐
│      1 │           ᴺᵁᴸᴸ │
└────────┴────────────────┘

関連項目​