文档

创建ClickHouse数据源

更新时间:

通过创建ClickHouse数据源能够实现Dataphin读取ClickHouse的业务数据或向ClickHouse写入数据。本文为您介绍如何创建ClickHouse数据源。

前提条件

若您需在Dataphin中创建基于阿里云产品的数据源,创建数据源前,需确保Dataphin的IP已添加至数据库白名单(或安全组)中,使数据源与Dataphin网络互通。具体操作,请参见数据源白名单配置

背景信息

如果您使用的是数据库ClickHouse,引入ClickHouse的业务数据至Dataphin中或将Dataphin数据导出至ClickHouse的场景中,您需要先完成ClickHouse数据源的创建。阿里云数据库ClickHouse的更多信息,请参见云数据库 ClickHouse

权限说明

仅支持拥有新建数据源权限点的自定义全局角色和超级管理员数据源管理员板块架构师项目管理员系统角色创建数据源。

操作步骤

  1. 在Dataphin首页,单击顶部菜单栏管理中心 > 数据源管理

  2. 数据源页面,单击+新建数据源

    image

  3. 新建数据源对话框的关系型数据库区域,选择ClickHouse

    如果您最近使用过ClickHouse,也可以在最近使用区域选择ClickHouse。同时,您也可以在搜索框中,输入ClickHouse的关键词,快速筛选。

    image

  4. 新建ClickHouse数据源对话框中,配置连接数据源参数。

    1. 配置数据源的基本信息。

      参数

      说明

      数据源名称

      填写数据源名称。命名规则如下:

      • 只能包含中文、英文字母大小写、数字、下划线(_)或短划线(-)。

      • 长度不能超过64个字符。

      数据源编码

      配置数据源编码后,您可以在Flink_SQL任务或使用Dataphin JDBC客户端中,通过数据源编码.表名称数据源编码.schema.表名称的格式直接访问Dataphin数据源表,实现快捷消费;如果需要根据任务执行环境自动切换数据源,请通过${数据源编码}.table${数据源编码}.schema.table的变量格式访问。更多信息,请参见Flink_SQL任务开发方式

      重要

      数据源编码配置成功后不支持修改。

      数据源描述

      对数据源的简单描述。不得超过128个字符。

      数据源配置

      选择需要配置的数据源:

      • 如果业务数据源区分生产数据源和开发数据源,则选择生产+开发数据源

      • 如果业务数据源不区分生产数据源和开发数据源,则选择生产数据源

      标签

      您可根据标签给数据源进行分类打标,如何创建标签,请参见管理数据源标签

    2. 配置数据源与Dataphin的连接参数。

      若您的数据源配置选择生产+开发数据源,则需配置生产+开发数据源的连接信息。如果您的数据源配置为生产数据源,仅需配置生产数据源的连接信息。

      说明

      通常情况下,生产数据源和开发数据源需配置为非同一个数据源,以实现开发数据源与生产数据源的环境隔离,降低开发数据源对生产数据源的影响。但Dataphin也支持配置成同一个数据源,即相同参数值。

      参数

      说明

      JDBC URL

      ClickHouse的连接地址,JDBC URL格式为jdbc:clickhouse://host:port/dbname

      若您使用阿里云数据库ClickHouse,您可以在ClickHouse控制台集群信息页面,查看链接地址和端口信息;连接集群后,在SQL Console中执行show Databases命令,可查看数据库名称。faga

      用户名密码

      访问ClickHouse实例的用户名和密码。

      类型

      支持公网数据库、阿里云数据库与ECS(VPC)自建数据库,您可根据您数据库类型及业务情况进行选择与配置:

      • 公网数据库:通过公网可直接访问的数据库。

      • 阿里云数据库:在阿里云购买的数据库。支持VPC网络或公网IP进行访问。VPC网络访问数据库需配置以下信息:

        • 区域:数据库所在Region。仅支持Dataphin实例相同区域的数据库。如您的Dataphin实例位于华东2(上海),仅支持选择华东2(上海)区域。

        • VPC ID:填写数据库所在VPC网络的VPC ID。您可登录专有网络控制台进行查看。如下图所示:

          image..png

        • VPC实例ID:填写数据库的专有网络实例ID,即VpcCloudInstanceId。您可以通过调用DescribeDBInstances API进行获取。更多信息,请参见DescribeDBClusters - 查询集群列表

      • ECS(VPC)自建数据库:您在阿里云ECS上自建的数据库。支持VPC方式访问。VPC网络访问数据库需配置以下信息:

        • 区域:据库所在Region。仅支持Dataphin实例相同区域的数据库。如您的Dataphin实例位于华东2(上海),仅支持选择华东2(上海)区域。

        • VPC ID:填写ECS所在VPC网络的VPC ID。您可登录专有网络控制台进行查看。如下图所示:

          image..png

        • ECS ID:填写部署数据库的ECS服务器的ECS ID。您可登录ECS控制台进行查看。如下图所示:

          image..png

    3. 配置数据源的高级设置。

      参数

      说明

      connection_timeout

      数据库的connection_timeout时长(单位:毫秒),默认900000毫秒(15分钟)。

      说明
      • 若您在JDBC URL中带有connection_timeout配置,则connection_timeout为JDBC URL中配置的超时时间。

      • Dataphin V3.11版本之前的创建数据源,connection_timeout默认为-1,表示无超时限制。

      socket_timeout

      数据库的socket_timeout时长(单位:毫秒),默认1800000毫秒(30分钟)。

      说明
      • 若您在JDBC URL中带有socket_timeout配置,则socket_timeout为JDBC URL中配置的超时时间。

      • Dataphin V3.11版本之前的创建数据源,socket_timeout默认为-1,表示无超时限制。

      连接重试次数

      数据库连接超时,将自动重试连接直到完成设定的重试次数。若达最大重试次数仍未连接成功,则连接失败。

      说明
      • 默认重试次数为1次,支持配置0~10之间参数。

      • 连接重试次数将默认应用于离线集成任务全域质量(需开通资产质量功能模块),离线集成任务中支持单独配置任务级别的重试次数。

  5. 单击测试连接,测试数据源是否可以和Dataphin正常的连通。

    重要

    如果连接测试失败,您可以根据网络连通常见问题进行排查。详细内容,请参见网络连通解决方案

  6. 测试成功后,单击确定,完成ClickHouse数据源的创建。