Skip to main content

AirbyteをClickHouseに接続する

Note

AirbyteのClickHouse用ソースとデスティネーションは現在アルファ版であり、非常に大きなデータセット(> 1000万行)を移動するには適しません。

Airbyteはオープンソースのデータ統合プラットフォームです。これは、ELTデータパイプラインを作成でき、140以上の即使用可能なコネクタを備えています。このステップバイステップのチュートリアルでは、AirbyteをデスティネーションとしてClickHouseに接続し、サンプルデータセットをロードする方法を示します。

1. Airbyteをダウンロードして実行する

  1. AirbyteはDocker上で動作し、docker-composeを使用します。最新のDockerをダウンロードしてインストールしてください。

  2. 公式のGithubリポジトリをクローンし、お気に入りのターミナルでdocker-compose upを実行してAirbyteをデプロイします:

    git clone https://github.com/airbytehq/airbyte.git --depth=1
    cd airbyte
    ./run-ab-platform.sh
  3. ターミナルでAirbyteのバナーが表示されたら、localhost:8000に接続できます。

    Airbyte banner
    Note

    代わりに、Airbyte Cloudをサインアップして使用することもできます。

2. ClickHouseをデスティネーションとして追加する

このセクションでは、ClickHouseインスタンスをデスティネーションとして追加する方法を説明します。

  1. ClickHouseサーバーを開始する(AirbyteはClickHouseバージョン21.8.10.19以降と互換性があります)か、ClickHouseクラウドアカウントにログインします:

    clickhouse-server start
  2. Airbyte内で"Destinations"ページを選択し、新しいデスティネーションを追加します:

    Add a destination in Airbyte
  3. "Destination type"のドロップダウンリストからClickHouseを選択し、ClickHouseのホスト名とポート、データベース名、ユーザー名、パスワードを入力し、SSL接続かどうかを選択して"Set up the destination"フォームを入力します(clickhouse-client--secureフラグに相当):

    ClickHouse destination creation in Airbyte
  4. おめでとうございます! ClickHouseをAirbyteのデスティネーションとして追加しました。

Note

ClickHouseをデスティネーションとして使用するには、使用するユーザーにデータベース、テーブルの作成と行の挿入の権限が必要です。Airbyte専用のユーザー(例: my_airbyte_user)を以下の権限で作成することをお勧めします:

CREATE USER 'my_airbyte_user'@'%' IDENTIFIED BY 'your_password_here';

GRANT CREATE ON * TO my_airbyte_user;

3. データセットをソースとして追加する

使用する例のデータセットはニューヨーク市タクシーデータです (Github)。このチュートリアルでは、2022年1月に対応するこのデータセットのサブセットを使用します。

  1. Airbyte内で"Sources"ページを選択し、ファイルタイプの新しいソースを追加します。

    Add a source in Airbyte
  2. ソースを名前付けし、NYC Taxi Jan 2022ファイルのURLを提供して"Set up the source"フォームを入力します(以下参照)。parquetをファイル形式として、HTTPS Public Webをストレージプロバイダとして、nyc_taxi_2022をデータセット名として選択してください。

    https://d37ci6vzurychx.cloudfront.net/trip-data/yellow_tripdata_2022-01.parquet
    ClickHouse source creation in Airbyte
  3. おめでとうございます! Airbyteにソースファイルを追加しました。

4. 接続を作成し、データセットをClickHouseにロードする

  1. Airbyte内で"Connections"ページを選択し、新しい接続を追加します。

    Add a connection in Airbyte
  2. "Use existing source"を選択し、New York City Taxi Dataを選択します。"Use existing destination"を選択し、ClickHouseインスタンスを選びます。

  3. "Set up the connection"フォームを記入し、レプリケーション頻度を選択します(このチュートリアルではmanualを使用します)。nyc_taxi_2022を同期したいストリームとして選択し、Normalized Tabular Dataを正規化として選択します。

    Connection creation in Airbyte
  4. 接続が作成されたら、"Sync now"をクリックしてデータのロードを開始します(Manualをレプリケーション頻度として選択したため)。

    Sync now in Airbyte
  5. データのロードが始まり、Airbyteのログと進捗を確認できます。操作が完了したら、ログにCompleted successfullyというメッセージが表示されます。

    Completed succesfully
  6. 好みのSQLクライアントを使用してClickHouseインスタンスに接続し、結果のテーブルを確認します:

    SELECT *
    FROM nyc_taxi_2022
    LIMIT 10

    レスポンスは次のようになります:

    Query id: 4f79c106-fe49-4145-8eba-15e1cb36d325

    ┌─extra─┬─mta_tax─┬─VendorID─┬─RatecodeID─┬─tip_amount─┬─airport_fee─┬─fare_amount─┬─DOLocationID─┬─PULocationID─┬─payment_type─┬─tolls_amount─┬─total_amount─┬─trip_distance─┬─passenger_count─┬─store_and_fwd_flag─┬─congestion_surcharge─┬─tpep_pickup_datetime─┬─improvement_surcharge─┬─tpep_dropoff_datetime─┬─_airbyte_ab_id───────────────────────┬─────_airbyte_emitted_at─┬─_airbyte_normalized_at─┬─_airbyte_nyc_taxi_2022_hashid────┐
    │ 0 │ 0.5 │ 2 │ 1 │ 2.03 │ 0 │ 17 │ 41 │ 162 │ 1 │ 0 │ 22.33 │ 4.25 │ 3 │ N │ 2.5 │ 2022-01-24T16:02:27 │ 0.3 │ 2022-01-24T16:22:23 │ 000022a5-3f14-4217-9938-5657f9041c8a │ 2022-07-19 04:35:31.000 │ 2022-07-19 04:39:20 │ 91F83E2A3AF3CA79E27BD5019FA7EC94 │
    │ 3 │ 0.5 │ 1 │ 1 │ 1.75 │ 0 │ 5 │ 186 │ 246 │ 1 │ 0 │ 10.55 │ 0.9 │ 1 │ N │ 2.5 │ 2022-01-22T23:23:05 │ 0.3 │ 2022-01-22T23:27:03 │ 000036b6-1c6a-493b-b585-4713e433b9cd │ 2022-07-19 04:34:53.000 │ 2022-07-19 04:39:20 │ 5522F328014A7234E23F9FC5FA78FA66 │
    │ 0 │ 0.5 │ 2 │ 1 │ 7.62 │ 1.25 │ 27 │ 238 │ 70 │ 1 │ 6.55 │ 45.72 │ 9.16 │ 1 │ N │ 2.5 │ 2022-01-22T19:20:37 │ 0.3 │ 2022-01-22T19:40:51 │ 00003c6d-78ad-4288-a79d-00a62d3ca3c5 │ 2022-07-19 04:34:46.000 │ 2022-07-19 04:39:20 │ 449743975782E613109CEE448AFA0AB3 │
    │ 0.5 │ 0.5 │ 2 │ 1 │ 0 │ 0 │ 9.5 │ 234 │ 249 │ 1 │ 0 │ 13.3 │ 1.5 │ 1 │ N │ 2.5 │ 2022-01-22T20:13:39 │ 0.3 │ 2022-01-22T20:26:40 │ 000042f6-6f61-498b-85b9-989eaf8b264b │ 2022-07-19 04:34:47.000 │ 2022-07-19 04:39:20 │ 01771AF57922D1279096E5FFE1BD104A │
    │ 0 │ 0 │ 2 │ 5 │ 5 │ 0 │ 60 │ 265 │ 90 │ 1 │ 0 │ 65.3 │ 5.59 │ 1 │ N │ 0 │ 2022-01-25T09:28:36 │ 0.3 │ 2022-01-25T09:47:16 │ 00004c25-53a4-4cd4-b012-a34dbc128aeb │ 2022-07-19 04:35:46.000 │ 2022-07-19 04:39:20 │ CDA4831B683D10A7770EB492CC772029 │
    │ 0 │ 0.5 │ 2 │ 1 │ 0 │ 0 │ 11.5 │ 68 │ 170 │ 2 │ 0 │ 14.8 │ 2.2 │ 1 │ N │ 2.5 │ 2022-01-25T13:19:26 │ 0.3 │ 2022-01-25T13:36:19 │ 00005c75-c3c8-440c-a8e8-b1bd2b7b7425 │ 2022-07-19 04:35:52.000 │ 2022-07-19 04:39:20 │ 24D75D8AADD488840D78EA658EBDFB41 │
    │ 2.5 │ 0.5 │ 1 │ 1 │ 0.88 │ 0 │ 5.5 │ 79 │ 137 │ 1 │ 0 │ 9.68 │ 1.1 │ 1 │ N │ 2.5 │ 2022-01-22T15:45:09 │ 0.3 │ 2022-01-22T15:50:16 │ 0000acc3-e64f-4b58-8e15-dc47ff1685f3 │ 2022-07-19 04:34:37.000 │ 2022-07-19 04:39:20 │ 2BB5B8E849A438E08F7FCF789E7D7E65 │
    │ 1.75 │ 0.5 │ 1 │ 1 │ 7.5 │ 1.25 │ 27.5 │ 17 │ 138 │ 1 │ 0 │ 37.55 │ 9 │ 1 │ N │ 0 │ 2022-01-30T21:58:19 │ 0.3 │ 2022-01-30T22:19:30 │ 0000b339-b44b-40b0-99f8-ebbf2092cc5b │ 2022-07-19 04:38:10.000 │ 2022-07-19 04:39:20 │ DCCE79199EF9217CD769EFD5271302FE │
    │ 0.5 │ 0.5 │ 2 │ 1 │ 0 │ 0 │ 13 │ 79 │ 140 │ 2 │ 0 │ 16.8 │ 3.19 │ 1 │ N │ 2.5 │ 2022-01-26T20:43:14 │ 0.3 │ 2022-01-26T20:58:08 │ 0000caa8-d46a-4682-bd25-38b2b0b9300b │ 2022-07-19 04:36:36.000 │ 2022-07-19 04:39:20 │ F502BE51809AF36582561B2D037B4DDC │
    │ 0 │ 0.5 │ 2 │ 1 │ 1.76 │ 0 │ 5.5 │ 141 │ 237 │ 1 │ 0 │ 10.56 │ 0.72 │ 2 │ N │ 2.5 │ 2022-01-27T15:19:54 │ 0.3 │ 2022-01-27T15:26:23 │ 0000cd63-c71f-4eb9-9c27-09f402fddc76 │ 2022-07-19 04:36:55.000 │ 2022-07-19 04:39:20 │ 8612CDB63E13D70C1D8B34351A7CA00D │
    └───────┴─────────┴──────────┴────────────┴────────────┴─────────────┴─────────────┴──────────────┴──────────────┴──────────────┴──────────────┴──────────────┴───────────────┴─────────────────┴────────────────────┴──────────────────────┴──────────────────────┴───────────────────────┴───────────────────────┴──────────────────────────────────────┴─────────────────────────┴────────────────────────┴──────────────────────────────────┘
    SELECT count(*)
    FROM nyc_taxi_2022

    レスポンスは次の通りです:

    Query id: a9172d39-50f7-421e-8330-296de0baa67e

    ┌─count()─┐
    │ 2392428 │
    └─────────┘
  7. Airbyteは自動的にデータ型を推測し、デスティネーションテーブルに4つのカラムを追加したことに注意してください。これらのカラムはAirbyteがレプリケーションロジックを管理し、操作をログに記録するために使用されます。詳細はAirbyte公式ドキュメントで確認できます。

    `_airbyte_ab_id` String,
    `_airbyte_emitted_at` DateTime64(3, 'GMT'),
    `_airbyte_normalized_at` DateTime,
    `_airbyte_nyc_taxi_072021_hashid` String

    データセットがClickHouseインスタンスにロードされたので、新しいテーブルを作成し、より適切なClickHouseデータ型で使用することができます(詳細)。

  8. おめでとうございます - Airbyteを使用してNYCタクシーデータをClickHouseに正常にロードしました!