You need to enable JavaScript to run this app.
ByteHouse云数仓版

ByteHouse云数仓版

请输入
  • 文档首页
    • ByteHouse云数仓版用户指南数据管理使用 SQL 工作表
复制全文
我的收藏
数据管理
使用 SQL 工作表
复制全文
我的收藏
使用 SQL 工作表

SQL 工作表是 ByteHouse 云数仓版控制台提供的 SQL 编辑器，支持编写和执行 SQL 查询并查看结果，帮助您高效执行 SQL 查询并管理查询结果，提升数据处理效率。本文介绍了如何使用 SQL 工作表。

功能概述

ByteHouse 云数仓版 SQL 工作表页面提供了功能丰富的查询和分析界面，可用于编写和提交 SQL 查询，并查看查询结果。您可以在此页面执行 DML、DDL、DCL 等操作，支持在一次运行中执行多个语句，支持保存和管理工作表，支持执行时添加 SQL 参数组等功能。
Image

新建和管理工作表

ByteHouse SQL 工作表提供了新建、命名、保存、共享、归档、删除工作表等操作。

新建并命名工作表

在 SQL 工作表页面的顶部导航栏右侧，单击加号按钮，即可新建工作表。您可在选项卡栏中单击工作表标题，为工作表自定义名称（例如 销售分析 ）。如需修改已设置的工作表名，可再次单击工作表名称，修改名称。
Image

保存工作表

ByteHouse 支持在您输入 SQL 语句的同时自动保存工作表，您也可单击右上角的保存按钮，保存当前工作表。
Image

打开工作表

工作表保存后，如需打开已关闭的工作表，请单击左侧侧边栏的已保存工作表图标，单击工作表名称，即可打开。
Image

共享工作表

您可将已保存的工作表分享指定角色，具有该角色的共享用户能够查看此工作表。
单击工作表右上角的共享按钮，在共享工作表对话框中选择相应的角色，并单击共享，即可共享工作表。
Image

归档工作表

您可在已保存工作表中创建文件夹，并将工作表移动至文件夹中，便于管理工作表。
操作步骤：

  1. 单击左侧侧边栏的已保存工作表图标，单击文件夹图标，创建文件夹。
    Image
  2. 将鼠标悬停在工作表名称上，单击 ... 按钮，单击移动至，选择文件夹，单击确定，即可将工作表移动至对应的文件夹。
    您也可以长按工作表名称，拖动工作表至目标文件夹，实现归档工作表。
    Image
  3. （可选）如需已设置的文件夹名称，将鼠标悬停在文件夹名称上，单击 ... 按钮，单击重命名，即可修改文件夹名称。
    Image
  4. （可选）如需删除文件夹，将鼠标悬停在文件夹名称上，单击 ... 按钮，单击删除，勾选删除全部工作表，并单击确定，即可删除当前文件夹。
    Image

    注意

    删除文件夹将同时删除该文件夹中及其中的全部工作表，且该操作不可逆，请谨慎操作。
    如果您仍需使用该文件夹下的工作表，请在删除文件夹前，根据步骤1-2，将工作表移动至其他文件夹。
    Image

删除工作表

将鼠标悬停在工作表名称上，单击 ... 按钮，单击删除，即可删除工作表。

选择计算组

执行查询前，需为工作表配置计算组，以获取对应的计算资源。
在 SQL 工作表页面的顶部工具栏中，单击计算组下拉列表，为当前工作表选择计算组。
Image
计算组后的绿色圆点表示计算组已启动，灰色圆点表示计算组当前处于暂停状态，如需使用，您可将鼠标悬停在灰色圆点上并单击启动按钮，启动计算组。
Image

选择方言

ByteHouse 云数仓版支持 ANSI MySQL、ClickHouse SQL、MySQL 三种方言，您可单击语言并切换至您需要的方言。
Image

选择数据库

执行查询前，您可先选择目标数据库。后续执行查询时，直接在 SQL 语句中使用表名即可，无需额外指定数据库名称。
Image

管理查询

工作表中显示的查询详情与结果仅对当前用户会话有效。如果您退出 ByteHouse 控制台界面后重新登录，则上一个会话的结果将不再显示在工作表中；但是，您可以通过 SQL 历史功能查看已执行的查询，详情请参见SQL 审计。

执行查询

在 SQL 编辑器中输入 SQL 语句后，单击运行即可执行查询。
Image
如果您输入了多条 SQL 语句时，系统默认执行您选中的语句。如需执行所有查询，请选中所有查询复选框。
Image

中止执行中的查询

当查询正在运行时，运行按钮右侧会新增中止按钮，单击此按钮可中止运行中的查询。
Image

查看查询信息详情

查询执行完成后，您可在 SQL 编辑器下方查询结果中查看到具体信息。
Image
您可单击结果列的筛选按钮，按需筛选结果，或按照升序或降序查看结果。
Image

可视化数据结果

ByteHouse 支持以柱状图和折线图的形式查看数据结果。
查询执行完成后，您可在 SQL 编辑器下方数据可视化中设置图表类型、X 轴、Y 轴，将查询结果以可视化图表形式展示。可视化结果示例如下：
Image

移除查询

当您执行的查询过多，导致页面缓存过多时，您可删除查询结果，提升页面加载速度，删除后的查询结果可在审计日志中查看详情。
将鼠标悬停在某条查询结果上，单击 x 号，单击确定，即可删除当前查询。
Image

使用 SQL 参数组

SQL 参数组是指在 ByteHouse 控制台运行 SQL 语句时，提供的快捷参数，您可在 SQL 工作表中执行查询时选择所需 SQL 参数组，SQL 参数组将在 ByteHouse 控制台运行的 session 中生效。

注意事项

  • SQL 参数组仅在 ByteHouse 控制台运行的 session 中生效。每位子用户各自维护自己的快捷参数，相互之间不共享。
  • 使用时请谨慎添加，建议在 Query 级别使用，避免因参数设置不当，带来的全局系统问题。
  • ByteHouse 不会校验用户设置的参数与参数值，设置参数后，请确保设置无误。ByteHouse 提供了参数样例，您可参考样例参数及参数值并按需添加。
  • SQL 工作表中设置的 settings 参数优先级高于 SQL 参数组，即如果您同时通过 SQL 工作表中的 settings 参数和 SQL 参数组设置了同一参数，但参数值不同，ByteHouse 将以 SQL 工作表中设置的 settings 参数值为准。

创建并使用 SQL 参数组

  1. 勾选 SQL 参数组，单击 SQL 参数组旁的选择框，单击 + 参数组，进入新建 SQL 参数页面。
    Image

  2. 自定义参数组名称和描述，以 XML 格式填写 SQL 参数组。
    您可单击参数样例查看示例，复制并粘贴样例至 SQL 参数组文本框，并根据实际情况修改参数值。
    Image
    参数样例

    <sql_parameters>
       <optimize_unique_table_write>false</optimize_unique_table_write>
       <max_insert_threads>0</max_insert_threads>
       <min_insert_block_size_bytes>1073710080</min_insert_block_size_bytes>
       <min_insert_block_size_rows>1048545</min_insert_block_size_rows>
       <max_partitions_per_insert_block>100</max_partitions_per_insert_block>
       <lake_commit_in_worker>true</lake_commit_in_worker>
       <lake_write_threads>4</lake_write_threads>
       <lake_write_max_file_size>1073741824</lake_write_max_file_size>
       <enable_plan_cache>false</enable_plan_cache>
       <match_name_ignore_case>false</match_name_ignore_case>
       <wait_runtime_filter_timeout>1000</wait_runtime_filter_timeout>
</sql_parameters>

    参数说明

    参数项

    参数说明

    推荐值

    optimize_unique_table_write

    针对唯一键表 INSERT SELECT 导入优化开关。建议仅在未开启暂存区且 dedup_impl_version='dedup_in_txn_commit' 的场景下开启。

    false

    max_insert_threads

    用于配置 Worker 节点执行 INSERT SELECT 请求时，写入操作对应的线程池大小。

    0

    min_insert_block_size_bytes

    控制 INSERT SELECT 操作中，数据攒批 block 块的最小大小，单位为字节（byte）。

    1073710080

    min_insert_block_size_rows

    控制 INSERT SELECT 操作中，数据攒批 block 块的最小行数。

    1048545

    max_partitions_per_insert_block

    限制单个 INSERT 操作中，每个 block 块内允许写入的最大 part 数。该数值通常受数据分布的分区数*桶数限制。

    100

    lake_commit_in_worker

    控制向外表写入数据时，是否使用 Worker 节点直接执行提交操作。

    true

    lake_write_threads

    配置向外表写入数据时，对应的线程池大小。

    4

    lake_write_max_file_size

    配置向外表写入数据时，单个文件的最大大小，单位为字节（byte）。

    1073741824

    enable_plan_cache

    控制是否开启内存的查询执行计划缓存（query plan cache）。

    false

    match_name_ignore_case

    控制解析 SQL 语句时，是否忽略 SQL 语句中的大小写。

    false

    wait_runtime_filter_timeout

    配置等待构建 runtime filter 的时长，默认 1 秒。若超时仍未构建完成，系统将会忽略 runtime filter 结果。

    1000

  3. 单击确定，创建 SQL 参数组。您可单击 SQL 参数组旁的选择框，查看已创建的 SQL 参数组，也可将鼠标悬停在参数组名称上方，预览参数组内容。

  4. （可选）ByteHouse 支持创建多个参数组，您可按照上述步骤继续创建。

  5. 单击 SQL 参数组旁的选择框，单击所需的参数组名称，即可在执行 SQL 语句时自动添加并使用该参数组。

    注意

    如果您在 SQL 工作表中通过 settings 参数重复设置了 SQL 参数组中已有的参数，但使用了不同的参数值，ByteHouse 将以您在 SQL 工作表中设置的 settings 参数值为准。

编辑 SQL 参数组

单击 SQL 参数组旁的选择框，将鼠标悬停在参数组名称上方，单击编辑按钮，您可按需修改 SQL 参数组名称、描述、SQL 参数内容。
Image

删除 SQL 参数组

单击 SQL 参数组旁的选择框，将鼠标悬停在参数组名称上方，单击删除按钮，确认后，即可删除当前参数组。
Image

使用查询分析器

除了查询详情和结果外，ByteHouse 还提供查询分析工具，用于分析查询统计数据和详情，包括查询的各执行组件。
单击查询结果中的查询 ID，单击该 ID，系统将跳转至审计日志中的 SQL 历史页面并自动筛选出该查询 ID，您可单击查询 ID，查看 SQL 执行详情，包括该查询的状态、使用的计算组、执行时间、执行计划等查询详情。
Image

使用数据对象浏览器

您可使用对象浏览器浏览您创建和被共享的所有数据对象，包括数据库、表、视图、外表等数据资源。
当工作表的内容发生变化时，数据库及其他对象的列表会自动刷新。您还可以单击对象浏览器上部的刷新按钮，立即查看对象的更改内容。
Image

  • 数据库、表
    可查看当前集群中的数据库、表，可将鼠标悬浮在表名称上方，查看表的列信息、表信息、底表、DDL。也可单击库、表右侧的插入按钮，将库、表插入 SQL 编辑器。
  • 外部 Catalog
    可查看已添加的外部 Catalog中的数据库、表，可将鼠标悬浮在表名称上方，查看表的列信息、表信息、底表、DDL。也可单击库、表右侧的插入按钮，将库、表插入 SQL 编辑器。
最近更新时间：2025.11.04 11:14:09
这个页面对您有帮助吗？
有用
有用
无用
无用