SQL 编辑和执行

本文档旨在介绍用户如何在 SQL 窗口中编辑和执行 SQL 语句。

背景信息

ODC SQL 窗口提供了用于处理数据的用户界面。在 SQL 窗口中,用户可以对数据进行排序、过滤、添加、编辑和删除以及执行数据库对象。

本文档以创建表为例,介绍如何在 SQL 窗口中创建表 employee 到数据库 odc_test 中。

说明

文中所使用的均为示例数据,您可根据实际情况对数据进行替换。

SQL 编辑

说明

如果用户无表权限,可以通过 工单 中的 申请表权限 查询/导出/变更表。

image

  1. 在项目 odc_4.2.0 中单击 登录数据库,进入 SQL 开发窗口。

    image.png

  2. 在 SQL 窗口中,编辑 SQL 语句以创建表employee

    image.png

    CREATE TABLE odc_test.employee (
    emp_no int(120) COMMENT '员工工号' NOT NULL,
    birthday date COMMENT '员工生日' NULL,
    name varchar(120) COMMENT '员工姓名' NULL,
    CONSTRAINT cons_employee_empno PRIMARY KEY (emp_no)) DEFAULT CHARSET = utf8mb4 COLLATE = utf8mb4_general_ci;
    

    语法格式:

    CREATE TABLE table_name (column_name column_type, column_name column_type,.......);
    

    参数说明:

    参数

    说明

    CREATE TABLE

    用于创建给定名称的表,必须拥有表 CREATE 的权限。

    table_name

    创建表的名称,表名称必须符合标识符命名规则。

    column_name column_type

    指定数据表中每个列(字段)的名称和数据类型,如果创建多个列,需要用逗号隔开。

    SQL 窗口编辑区的工具栏中同时提供以下功能键:

    功能

    说明

    SQL 检查

    单击该按钮检查 SQL 语法。

    执行计划

    查看选中的或当前光标所在的 SQL 语句在执行前系统预估的执行计划(EXPLAINPLAN操作的结果),展示的执行数据可能与实际执行语句后的数据略有不同,您可以使用该功能评估 SQL 语句。

    单击 执行计划 按钮,在 计划详情 页签中,单击 查看格式化 信息 切换至格式化展示页面。

    查找/替换

    在查找框内输入内容以对脚本进行检索,查找后可在替换框内输入内容以对查找内容进行替换。

    撤销

    将脚本回退到上一步操作执行的结果。

    重做

    执行 撤销 操作后,对脚本重新执行撤销前的操作。

    格式化

    单击该按钮对选中的 SQL 语句或当前 SQL 窗口中的所有 SQL 语句进行统一的格式化(缩进、换行和高亮关键字等操作)。

    IN 值转化

    批量复制转化工具,适用于查询数据时对复制的行或列结果进行格式转化。

    将批量数据粘贴在 SQL 编辑区后,选择复制的数据,单击 IN 值转化 按钮,即可转化成 in('A','B')格式。

    • 列值分隔符号为换行符。

    • 行值分隔符为空格或 TAB 值。

    大小写

    提供 全部大写全部小写 首字母大写 三种效果,将您在脚本中选中的语句转换为对应形式。

    缩进

    提供 添加缩进 删除缩进 两种效果,为您在脚本中选中的语句添加或删除包含的缩进。

    注释

    提供 添加注释 删除注释 两种效果,将您在脚本中选中的语句转换为注释或转换为 SQL 语句。

    设置

    • Delimiter:在下拉列表中选择您想要的符号以完成界定符的设置。目前支持设置 ;///$ $$ 等 5 种形式的界定符。

    • 查询结果限制:设置查询结果返回的条数,默认值为 1000 行。

    • 获取结果集列信息:SQL 执行前,支持选择是否开启获取结果集列信息。表列数量较多时关闭该选项,将不查询获取列注释及可编辑的列信息,以降低 SQL 执行耗时。

    • 会话变量:可编辑、刷新和搜索变量。

如上图所示,单击 SQL 窗口中的image.png支持切换数据库。

SQL 执行

  1. SQL 语句编辑完成后,在 SQL 窗口的工具栏中单击 运行 F8 运行当前 SQL 窗口中所有的 SQL 语句。

    功能

    说明

    运行 F8

    运行当前 SQL 窗口中所有的 SQL 语句。可以通过快捷键 F8 运行所有 SQL 语句。

    运行当前语句 F9

    运行当前选中的所有 SQL 语句或当前光标所在行的 SQL 语句。可以通过快捷键 F9 或者 Ctrl+Enter (Windows)/Command+Enter(MacOS) 运行当前语句。

    终止

    终止正在运行的语句。

    image.png

  2. 在结果页签中,可查看执行状态和执行结果。

    image.png

查看数据

  1. 在 SQL 开发窗口的左侧导航栏的 image.png 中确认表 employee 是否创建到项目 odc_4.2.0 > 数据库odc_test

    image.png

  2. 鼠标右键单击表 employee 或者在 SQL 窗口中编辑 SELECT 语句,查看表数据。

    image.png

  3. 单击image,可以手动同步当前项目或者数据源下的表列等元信息。

  4. 鼠标右键单击数据库名称 >元数据同步,可以手动同步当前数据库下表列等元信息。

    image

SQL 脚本

ODC 支持在 SQL 窗口和匿名块窗口中保存编辑的脚本,并可以在脚本页签中管理已保存的脚本。

保存脚本

在 SQL 窗口中,保存创建表 employee 的脚本。

信息项

示例值

表名称

employee

脚本名称

create_employee

  1. 在 SQL 窗口中,单击工具栏中的保存脚本按钮。

    image.png

  2. 指定保存的脚本名称,并 确认

    image.png

管理脚本

  1. 在 SQL 开发窗口的左侧导航栏中,单击image.png,打开脚本管理页面。

    image.png

  2. 脚本 页面中,支持编辑/下载/删除/刷新已保存的脚本、复制已保存的脚本路径,以及上传本地磁盘中的脚本。

    image.png

    说明
    • 单击脚本名称可以直接引用脚本内容到 SQL 窗口中。

    • 复制路径可以引用脚本内容到命令行窗口中。

代码片段

ODC 支持创建代码片段,用户可以在开发过程中查询已创建的代码片段,了解相关语句的具体用法。

创建代码片段

在代码片段页面,保存有关创建表 employee 的代码片段。

信息项

示例值

表名称

employee

代码片段名称

create_table

  1. 在 SQL 开发窗口的左侧导航栏中,单击image.png,并在打开的代码片段页面中单击+新建代码片段。

    image.png

  2. 新建代码片段 页面中,指定代码片段信息后单击 确定

    image.png

    说明

    ODC V4.2.3 及之后版本的代码片段长度调整至 64KB。

管理代码片段

在代码片段页面中,支持复制/编辑/删除/刷新已保存的代码片段。

image.png

相关文档