Embeddable を ClickHouse に接続する

Parameter(s)	Description
`HOST` and `PORT`	通常、TLS を使用する場合のポートは 8443、TLS を使用しない場合は 8123 です。
`DATABASE NAME`	デフォルトでは `default` という名前のデータベースがあります。接続先のデータベース名を使用してください。
`USERNAME` and `PASSWORD`	デフォルトのユーザー名は `default` です。用途に応じたユーザー名を使用してください。

Parameter(s)

Description

HOST and PORT

通常、TLS を使用する場合のポートは 8443、TLS を使用しない場合は 8123 です。

DATABASE NAME

デフォルトでは default という名前のデータベースがあります。接続先のデータベース名を使用してください。

USERNAME and PASSWORD

デフォルトのユーザー名は default です。用途に応じたユーザー名を使用してください。

ClickHouse接続タイプを作成する

Embeddable API を使用してデータベース接続を追加します。この接続は、ClickHouse サービスへの接続に使用されます。接続は、次の API 呼び出しで追加できます。

Query

// セキュリティ上の理由から、クライアントサイドからは絶対に呼び出さないでください
fetch('https://api.embeddable.com/api/v1/connections', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    Accept: 'application/json',
    Authorization: `Bearer ${apiKey}` /* APIキーを安全に保管してください */,
  },
  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 のいずれかのダッシュボードで “Publish” をクリックすると確認できます。name は、この接続を識別するための一意の名前です。

デフォルトでは、Data Models は “default” という名前の接続を参照しますが、モデルに別の data_source 名を指定することで、異なる Data Models を異なる接続先に接続できます (モデル内で data_source 名を指定するだけです) 。

type は、どのドライバーを使うかを Embeddable に伝えます

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

credentials は、ドライバーが必要とする認証情報を含む JavaScript オブジェクトです

これらは安全に暗号化され、Data Models で定義したデータを取得するためにのみ使用されます。 Embeddable では、接続ごとに読み取り専用のデータベースユーザーを作成することを強く推奨しています (Embeddable がデータベースに対して行うのは読み取りのみで、書き込みは行いません) 。

prod、qa、test などで異なるデータベースへの接続に対応するため (または顧客ごとに異なるデータベースに対応するため) 、各接続を環境に割り当てることができます (Environments API を参照) 。