跳到主要内容

通过 NineData SQL 窗口管理 Doris 数据源

本文介绍如何使用 SQL 窗口管理 Doris 数据源。

背景信息​

NineData 是集成了数据库 DevOps 、数据复制、数据备份、数据对比多个模块的云服务，支持混合云（自建库+云数据库的业务架构）和多云（多个不同云厂商数据库组成的业务架构）架构下的企业数据管理，大幅降低企业的数据运维难度和成本。

NineData 的 SQL 窗口可以帮助您更轻松地管理 Doris 数据库，通过 NineData，您可以轻松地查看、编辑和管理 Doris 数据，还可以创建、删除和修改 Doris 数据库。

ninedata

前提条件​

  • 已注册 NineData 平台账号。更多信息，请参见注册 NineData 账号。

  • 在数据库 DevOps 企业版（组织模式）下，您必须拥有目标数据源的只读、DML 或 DDL 权限。

    提示

    只读权限仅支持查看数据库以及查询数据操作。

  • 在商业化版本下（数据库 DevOps 专业版、数据库 DevOps 企业版），请确保您的包年包月订阅未过期，否则将无法正常使用数据库 DevOps 服务。您可以在 NineData 控制台页面右上方快速查看剩余配额以及到期时间。check_quota

功能介绍​

NineData 的 SQL 窗口提供多个便捷功能，帮助您轻松管理您的数据源。

功能
说明
AI 智能NineData 提供的 AI 服务，支持如下功能：
  • SQL 语句生成：通过简短的自然语言表达，即可快速转换成 SQL 查询语句。
  • SQL 查询优化：帮助您优化 SQL 语句，仅需提供原 SQL 语句，并告诉 AI 需要优化即可。
  • 问题解答：解答您各种各样的问题。
AI 功能
  • SQL 智能优化：AI 对光标所在行或选中的 SQL 语句进行智能分析，并给出优化建议。
  • AI 格式化：AI 分析已选中 SQL 语句的结构并执行格式化，增强可读性。
执行 SQL 语句
  • 访问数据源中的数据。
  • 对数据源中的库、表、数据（记录）进行增删改操作。
  • 在数据源中创建视图。
  • 对用户授权或回收权限。
说明：数据库 DevOps 企业版（组织模式组织模式支持对组织下的每个用户分配不同的角色和资源管理权限，适用于同一组织下多用户协同开发，在保证数据安全的同时，提升整体生产效率。）下，您需要对数据源拥有相应的权限才可以执行上述操作。
生成创建脚本支持针对数据源中已有的库、表等对象生成创建脚本，用于在其他数据源中复制一个相同结构的对象等场景。
SQL 智能提示在 SQL 窗口中输入 SQL 语句时，根据您输入的语义，系统会自动提示关键字、函数、库表字段名等常规对象信息；除此之外，还提供 SQL 模板（语义结构体）、语法帮助等便捷功能。
保存 SQL|查看 SQL对于常用 SQL，您可以将 SQL 保存至 NineData，保存后的 SQL 也支持查看。且由于 SQL 保存在云端，不受浏览器或主机的限制，您可以随时随地查看并使用保存的 SQL。
工作现场恢复对于浏览器意外退出或突发宕机等场景，您只需要重新登录 NineData 控制台并打开 SQL 窗口，之前打开的数据源以及执行过的 SQL 命令会被自动加载。由于页面状态保存在云端，不受浏览器或主机的限制，您可以随时随地恢复工作现场。
执行历史执行历史会记录当前账号在 NineData 控制台执行过的所有 SQL 语句，还支持根据数据源、执行时间、SQL 关键字等方式快速检索。您也可以快速复制执行历史中的 SQL 语句重新在 SQL 窗口中执行。
SQL 规范检查（企业版）数据库 DevOps 企业版（组织模式组织模式支持对组织下的每个用户分配不同的角色和资源管理权限，适用于同一组织下多用户协同开发，在保证数据安全的同时，提升整体生产效率。）下，系统会基于系统管理员配置的 SQL 开发规范检查每一条在 SQL 窗口中执行的 SQL，如果该条 SQL 不符合规范，则会被系统拦截，保证数据库安全。拦截后，根据系统管理员配置的审批流程，用户可以按照规范修改 SQL 重新提交，或直接提交 SQL 任务。

步骤一：添加 Doris 数据源​

  1. 登录 NineData 控制台。

  2. 在左侧导航栏，单击数据源管理>数据源。

  3. 单击数据源页签，并单击页面上的创建数据源，在弹出的数据源类型弹窗中，选择自建数据库 > Doris，在创建数据源页面根据下表配置参数。

    提示

    如果您操作失误，可以单击创建数据源页面上方的arrow_down图标重新选择。

    单击展开表格详情
    参数
    		说明
    数据源名称输入数据源的名称，为了方便后续查找和管理，请尽量使用有意义的名称。
    连接方式选择数据源的接入方式。支持通过公网地址、网关、SSH Tunnel 三种方式接入。
    • 公网地址：通过公网地址接入数据源。
    • 网关：NineData 提供的安全快捷的内网访问方式，需先将数据源所在主机接入，接入方式请参见添加网关。
    • SSH Tunnel：通过 SSH 隧道接入数据源。
    连接方式选择公网地址的配置项连接地址：数据源的公网连接地址和端口。
    连接方式选择网关的配置项
    • 网关：选择数据源所在主机中安装的 NineData 网关。
    • 连接地址：可以写成 localhost（数据源在本机）或者数据源所在主机的内网 IP。
    连接方式选择 SSH Tunnel 的配置项
    • SSH 主机：输入目标数据源所在服务器的公网 IP 或者域名，以及对应的端口号（SSH 服务的默认端口号为 22）。
    • SSH 认证方式：选择 SSH 的认证方式。
      • 密码认证：通过 SSH 用户名（即服务器的登录名）和密码（即服务器的登录密码）进行连接。
        • SSH 用户名：输入目标数据源所在服务器的登录用户名。
        • 密码：输入目标数据源所在服务器的登录密码。
      • 密钥认证（推荐）：通过 SSH 用户名和密钥文件进行连接。
        • SSH 用户名：输入目标数据源所在服务器的登录用户名。
        • 密钥文件：单击上传文件上传私钥文件，即无后缀名的密钥文件。如果您还未创建，请参见生成 SSH Tunnel 密钥文件。
        • 口令：输入生成密钥文件时设置的密码。如果您在密钥生成过程中未设置密码，此处请留空。
      • 说明：SSH 配置完成后，您需要单击右侧的连接测试，可能出现如下两种结果：
      • 提示连接成功：表示 SSH Tunnel 已打通。
      • 提示错误信息：表示连接失败，您需要根据提错误示排查故障原因并重试。
    • 连接地址：可以写成 localhost（数据源在本机）或者数据源所在主机的内网 IP。
    数据库账号数据源的用户名。
    数据库密码数据源的密码。
    接入地域选择离您数据源所在地最近的地域，可有效降低网络延迟。
    环境根据该数据源的实际业务用途进行选择，作为数据源的环境标识。默认提供生产和开发环境，同时支持您创建自定义环境。
    说明：在组织模式下，数据库环境还可应用于权限策略管理，例如，默认情况下的生产环境管理员角色仅支持访问生产环境下的数据源，无法访问其他环境的数据源。更多信息，请参见管理角色。
    加密传输是否使用 SSL 加密方式访问数据源（默认开）。数据源如果强制 SSL 加密连接，则必须开启本开关，否则连接失败。
    单击右侧的开关可开启或关闭加密传输。单击加密传输左侧的>可以展开详细配置。
    • 加密选项：支持如下两种方式。
      • 尽量使用加密传输：自动检测服务端的 SSL 状态，如果服务端开启了 SSL，则优先通过 SSL 连接，如果服务端未开启 SSL，则使用非 SSL 的方式连接。
      • 强制使用加密传输：无论如何都使用 SSL 方式连接数据源，如果服务端不支持该方式或由于其他原因无法建立 SSL 连接，则会连接失败。
    • 指定加密密钥（SSL Cipher）：指定 SSL-Cipher 加密算法。
    • 验证服务端证书（SSL CA）：如果 Doris 服务器使用的是自签名 CA 颁发的证书，则需要在此上传该 CA 的根证书。
    • 验证服务端身份 (SSL Identify)：勾选用于验证服务器的名称和 IP 地址等，以确保连接到的是真正的 Doris 服务器，避免中间人攻击（Man-in-the-MiddleAttack）。
    • 验证客户端：如果 Doris 服务器需要客户端提供证书，则需要在此上传客户端的证书和密钥，Doris 服务器将验证您上传的信息，以确保连接的安全性。
    说明：通常情况下，如果 Doris 服务端支持使用 SSL 加密连接，您仅需要选中强制使用加密传输即可，无需配置其他选项，系统会自动为您生成密钥进行连接。更多 SSL 的配置方法请参见官方文档：配置 Doris 加密连接。

  4. 全部配置完成后，单击创建数据源右侧的连接测试可以测试该数据源是否可以正常访问，提示连接成功即可单击创建数据源，完成数据源的添加。否则请重新检查连接设置，直到连接测试成功为止。

步骤二：使用 SQL 窗口​

  1. 登录 NineData 控制台。

  2. 在左侧导航栏单击 数据库 DevOps>SQL 窗口。

    提示

    如果之前登录过数据源且没有关闭，则会自动进入该数据源页面。

  3. 单击 SQL 窗口下方文本框，会弹出可用的数据源，单击目标数据源，并单击开始查询，跳转到 SQL 窗口。

    提示

    如果有多个数据源，您可以在框中输入全部或部分关键词进行精确查找或模糊查找。支持搜索的字段如下：

    • 数据源名称

    • IP 地址

  4. 打开 SQL 窗口后，即可对数据源执行数据管理操作。如下图所示：

    execute_sql_doris

  5. SQL 窗口的详细使用方法，请参见 SQL 窗口界面介绍。

    提示

    数据库 DevOps 企业版（组织模式）下，如果目标数据源中添加了敏感列，您将无法完整查看敏感列的内容。如需查看，请先申请敏感列权限。sensitive_data

附录：SQL 窗口界面介绍​

doris_interface

序号
功能
介绍
1SQL 窗口页签表示当前已打开的数据源 SQL 窗口，多个 SQL 窗口可以通过单击页签切换，单击页签右侧的X可以关闭该 SQL 窗口。右键菜单支持如下操作：
  • 实例详情：打开当前数据源详情窗口。
  • 创建新查询：打开一个新的数据源 SQL 窗口。
  • 关闭窗口：关闭当前页签。
2打开数据源选择并打开新的数据源 SQL 窗口。
3数据源信息展示当前 SQL 窗口的数据源信息，包含环境、IP 地址以及端口号。
右键菜单：
  • 实例详情：显示当前数据源的详情信息，包含用户名、连接地址、运行时间、连接数等。
  • 刷新：刷新数据源信息。
4刷新可刷新当前数据源中的数据。
5数据库名称选中目标数据库以执行 SQL 操作。
6功能按钮
  • execute：执行 执行选中的 SQL 语句。
  • optimizedSQL：SQL 智能优化 AI 对光标所在行的 SQL 语句进行智能分析，并给出优化建议。
  • setting02：设置
    • 结果集：可选覆盖或追加。
      • 覆盖（默认）：新的结果集将覆盖上一次的执行结果。
      • 追加：生成新的页签展示新的结果集。
    • 主题：更改 SQL 窗口的主题，可选浅色和深色。
    • 字体大小：拖动滑块调整 SQL 窗口中 SQL 语句的字体大小，默认值如下：
      • Windows：16
      • MacOS：13
  • more：更多选项
    • 格式化：调整选中 SQL 语句的结构，增强可读性。
    • AI 格式化：由 AI 分析并调整选中 SQL 语句的结构，拥有更好的格式化效果。
    • 执行计划：查看选中 SQL 语句的执行计划。
    • 保存 SQL：将当前 SQL 窗口中的所有 SQL 语句保存至 SQL 列表，方便下次使用。
    • 查看 SQL：查看已保存的 SQL，您可以将目标 SQL 插入至当前的 SQL 窗口中。同时可以编辑或删除目标 SQL。
    • 执行历史：查看目标数据源的 SQL 的执行历史。您可以选择日期过滤出某个时间段的执行历史，也可以通过关键词（SQL 语句、数据库名称、错误提示）搜索执行历史。
  • more：编辑器 切换编辑器模式（Oracle 暂不支持）。
  • codefill：AI 智能 切换智能 SQL 模式（Oracle 暂不支持）。更多信息，请参见使用 AI 管理数据源。
  • ai：开启管理员模式|退出管理员模式 仅系统管理员可操作，开启该模式后，SQL 窗口中执行的所有 SQL 不受规范或审批流的限制，均可直接执行。
  • admin：全屏 将 SQL 窗口以全屏方式显示（浏览器大小)。全屏后，单击右上角的compress 退出全屏可以恢复到原始 SQL 窗口大小。
7搜索表名可输入表名快速查找目标数据表。
8数据库列表显示当前数据源中所有的数据库和数据表。
  • 创建数据库：右键单击任意数据库，单击创建数据库，在弹出的对话框中，输入库名称、字符集以及对应比较规则，单击确定，可视化创建数据库。
  • 数据库详情：右键单击目标库，单击数据库详情，即可打开数据库详情页面。您可以在这里查看目标库的详情。
  • 查询表数据：右键单击目标表，单击查询表数据，可自动查询该表中的数据，默认返回 100 行。
  • 表详情：右键单击目标表，单击表详情，即可打开数据库详情页面。您可以在这里查看目标表中所有的列名、Indexes。
  • 查询视图：右键单击目标视图，单击查询视图，可自动查询该视图，默认返回 100 行。
  • 生成创建脚本：右键单击目标对象，单击生成创建脚本，即可生成创建的 SQL 语句。
  • 创建新查询：右键单击任意对象，单击创建新查询，可以打开新的 SQL 窗口页签。
  • 刷新：右键单击任意对象，单击刷新，刷新数据库列表。
9SQL 编辑器支持如下功能：
  • SQL 执行：支持单个语句或批量执行。
  • 中断执行：SQL 执行过程中可以单击停止查询中断 SQL 的执行。
  • 语法高亮：以不同颜色显示不同语法元素，提高代码的可读性。
  • SQL 智能提示：输入命令过程中根据您输入的语义自动弹出提示。
  • 查看 SQL 语法帮助：输入 SQL 关键字后，选中该关键字并单击鼠标右键 > 帮助，即可查看该关键字对应的帮助信息。
  • SQL 模板：提供 CREATE、SELECT、INSERT、UPDATE、DELETE 等语句的常用模板，您只需要输入前置命令即可选择对应模板。例如：输入 CREATE 即可选择 CREATE TABLE、CREATE VIEW 等模板。
  • 右键菜单：
    • 执行：执行光标所在位置的 SQL 语句。
    • 格式化：调整选中 SQL 语句的结构，增强可读性。
    • AI 格式化：AI 智能调整选中 SQL 语句的结构，增强可读性，对比机器格式化有更好的效果。
    • SQL 智能优化： AI 对光标所在行的 SQL 语句进行智能分析，并给出优化建议。
    • 常规操作：包括剪切、复制、粘贴和全选。
    • 选中当前 SQL：选中光标所在位置的 SQL 语句。
    • 帮助：AI 对当前选中的内容进行分析，提供目标 SQL 语法的语义、目标表的表结构定义、SQL 语句逻辑的整体解释等信息。
10执行信息、结果集显示 SQL 的执行信息以及结果集。
  • 执行信息：包含执行时间、执行的 SQL 语句、执行状态、执行耗时等信息。
  • 结果集：显示 SQL 的返回结果。根据数据源类型的不同，您可以进行如下操作：
    • 单击upload：支持以多种格式导出数据表，可导出范围为当前页或者全部数据（最多 10000 条）。
    • 单击togglebottom2：将结果集缩放到页面最底部。单击togglebottom1可以恢复。
    • 单击setting02：支持对结果集中的列进行锁定、隐藏、显示等操作。
    • 结果集搜索：支持模糊搜索和精确搜索。
    • 单击列名右侧的小箭头，可对结果集进行排序。
    • 复制行：右键单击目标单元格，选择复制行，可以复制单元格所在行的整行数据。
    • 复制单元格：右键单击目标单元格，选择复制单元格，可以复制当前单元格。
    • 复制为：右键单击目标单元格，选择复制为，可以选择将单元格所在行的数据复制为多种格式。
    • 导出：右键单击任意单元格，选择导出，可以将当前结果集以多种格式导出，可导出范围为当前页或者全部数据（最多 10000 条)。

相关链接​

最后于 更新
扫一扫获取支持
企业微信