连接可嵌入的到 ClickHouse
在 可嵌入的 中,您可以在代码中定义 数据模型 和 组件(存储在您自己的代码库中),并使用我们的 SDK 将这些内容提供给您的团队,构建强大的可嵌入 无代码构建器。
最终结果是能够直接在您的产品中交付快速、交互式的面向客户的分析;由您的产品团队设计;由您的工程团队构建;由您的客户和数据团队维护。正如它应该那样。
内置的行级安全性意味着每个用户只会看到他们被允许查看的数据。而两级完全可配置的缓存意味着您可以按比例提供快速、实时的分析。
1. 收集您的连接详细信息
要通过 HTTP(S) 连接到 ClickHouse,您需要以下信息:
-
HOST 和 PORT:通常,当使用 TLS 时,端口为 8443;当不使用 TLS 时,端口为 8123。
-
数据库名称:开箱即用时,有一个名为
default
的数据库,请使用您要连接的数据库名称。 -
用户名和密码:开箱即用时,用户名为
default
。请使用适合您用例的用户名。
您的 ClickHouse Cloud 服务详细信息可在 ClickHouse Cloud 控制台中找到。 选择您要连接的服务并点击 Connect:

选择 HTTPS,详细信息会在示例 curl
命令中提供。

如果您使用的是自管理的 ClickHouse,连接详细信息由您的 ClickHouse 管理员设置。
2. 创建一个 ClickHouse 连接类型
您可以使用可嵌入 API 添加一个数据库连接。此连接用于连接到您的 ClickHouse 服务。您可以使用以下 API 调用添加连接:
上述内容表示一个 CREATE
操作,但所有 CRUD
操作均可用。
apiKey
可以通过点击您的可嵌入仪表板上的 "发布" 按钮找到。
name
是一个唯一名称,用于标识此连接。
- 默认情况下,您的数据模型会查找名为 "default" 的连接,但您可以为模型提供不同的
data_source
名称,以支持将不同的数据模型连接到不同的连接(只需在模型中指定数据源名称即可)。
type
告诉可嵌入使用哪个驱动程序
- 在这里,您将想使用
clickhouse
,但您可以将多个不同的数据源连接到一个可嵌入工作区,因此您也可以使用其他数据源,如:postgres
、bigquery
、mongodb
等。
credentials
是一个包含驱动程序所需凭据的 JavaScript 对象
- 这些凭据是安全加密的,仅用于检索您在数据模型中描述的确切数据。可嵌入强烈建议您为每个连接创建一个只读数据库用户(可嵌入只会从数据库中读取,而不是写入)。
为了支持连接到不同的数据库以适应生产、质量控制、测试等(或支持为不同客户连接不同的数据库),您可以将每个连接分配给一个环境(请参见 环境 API)。