Connecting Embeddable to ClickHouse

Community Maintained

In Embeddable では、データモデルとコンポーネントをコードで定義し（自身のコードリポジトリに保存）、私たちの SDK を使用して、強力な Embeddable ノーコードビルダー でチームに提供します。

最終的な結果は、製品内で高速でインタラクティブな顧客向け分析を提供できる能力です。これは、あなたの製品チームによって設計され、エンジニアリングチームによって構築され、顧客向けやデータチームによって維持されます。ちょうどあるべき方法です。

組み込みの行レベルセキュリティにより、すべてのユーザーは常に許可されたデータのみを確認できます。また、2つの完全に構成可能なキャッシングレベルにより、大規模なリアルタイム分析を迅速に提供できます。

1. 接続詳細を収集する

To connect to ClickHouse with HTTP(S) you need this information:

The HOST and PORT: typically, the port is 8443 when using TLS or 8123 when not using TLS.
The DATABASE NAME: out of the box, there is a database named default, use the name of the database that you want to connect to.
The USERNAME and PASSWORD: out of the box, the username is default. Use the username appropriate for your use case.

The details for your ClickHouse Cloud service are available in the ClickHouse Cloud console. Select the service that you will connect to and click Connect:

Choose HTTPS, and the details are available in an example curl command.

ClickHouse Cloud HTTPS connection details

If you are using self-managed ClickHouse, the connection details are set by your ClickHouse administrator.

以下は、ClickHouseにHTTP(S)で接続するために必要な情報です：

HOSTとPORT: 通常、TLSを使用する場合はポートが8443、使用しない場合は8123です。
DATABASE NAME: デフォルトでは、defaultという名前のデータベースがあります。接続したいデータベースの名前を使用します。
USERNAMEとPASSWORD: デフォルトでは、ユーザー名はdefaultです。使用ケースに適したユーザー名を使用します。

ClickHouse Cloudサービスの詳細は、ClickHouse Cloudコンソールで確認できます。接続するサービスを選択し、Connectをクリックしてください：

HTTPSを選択すると、詳細はexample curlコマンドで確認できます。

セルフマネージドのClickHouseを使用している場合は、接続の詳細がClickHouse管理者によって設定されます。

2. ClickHouse接続タイプを作成する

Embeddable APIを使用してデータベース接続を追加します。この接続は、あなたの ClickHouse サービスに接続するために使用されます。次の API コールを使用して接続を追加できます：

// for security reasons, this must *never* be called from your client-side
fetch('https://api.embeddable.com/api/v1/connections', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    Accept: 'application/json',
    Authorization: `Bearer ${apiKey}` /* keep your API Key secure */,
  },
  body: JSON.stringify({
    name: 'my-clickhouse-db',
    type: 'clickhouse',
    credentials: {
      host: 'my.clickhouse.host',
      user: 'clickhouse_user',
      port: 8443,
      password: '*****',
    },
  }),
});

Response:
Status 201 { errorMessage: null }

上記は CREATE アクションを表していますが、すべての CRUD 操作が利用可能です。

apiKey は、あなたの Embeddable ダッシュボードの1つで "Publish" をクリックすることで見つけることができます。

name は、この接続を識別するためのユニークな名前です。

デフォルトでは、あなたのデータモデルは "default" という接続を探しますが、異なる接続に異なるデータモデルを接続するために、モデルに異なる data_source 名を指定することができます（単にモデル内で data_source 名を指定してください）。

type は、Embeddable にどのドライバーを使用するかを指示します。

ここでは clickhouse を使用しますが、1つの Embeddable ワークスペースに複数の異なるデータソースを接続できるため、postgres、bigquery、mongodb などの他のデータソースを使用することもできます。

credentials は、ドライバーによって期待される必要な資格情報を含む JavaScript オブジェクトです。

これらは安全に暗号化され、あなたのデータモデルに記述したデータを正確に取得するためのみに使用されます。Embeddable は、各接続に対して読み取り専用データベースユーザーを作成することを強く推奨します（Embeddable は常にデータベースから読み込み、書き込みは行いません）。

生産、QA、テストなどの異なるデータベースへの接続をサポートするため（または異なる顧客のために異なるデータベースをサポートするため）に、各接続に環境を割り当てることができます（Environments APIを参照してください）。

1. 接続詳細を収集する​

2. ClickHouse接続タイプを作成する​

1. 接続詳細を収集する

2. ClickHouse接続タイプを作成する