SQL 控制台功能键列表

个人设置

SQL 编辑窗口支持进行一些常见配置的设置。

类型	配置项	描述
会话	MySQL 提交模式	设置 MySQL 模式下事务的默认提交模式。
会话	Oracle 提交模式	设置 Oracle 模式下事务的默认提交模式。
结果集	获取结果集列信息	SQL 执行前，支持选择是否开启获取结果集列信息。表列数量较多时关闭该选项，将不查询获取列注释及可编辑的列信息，以降低 SQL 执行耗时。
结果集	查询条数限制	支持单次查询的上限。
结果集	结果集展示	覆盖：最近查询结果覆盖上一次查询结果，若要查看多次执行结果需手动固定结果集（在结果集页签右键操作）。追加：多次查询结果追加展示，需手动关闭结果集页签才会关闭。
SQL执行	开启全链路诊断	SQL 执行时是否开启全链路追踪。
SQL执行	报错继续执行	SQL 执行遇到错误是否继续。
SQL执行	Delimiter 设置	修改 SQL 语句的结束符。
对象	对象拖放生成语句类型	通过拖拽数据库对象（如表、视图）到编辑区，自动生成指定类型的 SQL 语句。
样式	主题	编辑器主题，包括 OceanBase、VSCode、GitHub 等。
样式	字体	编辑器字体大小，支持小、正常、大三种。
快捷键	运行 SQL	设置运行当前所有 SQL 的快捷键。
快捷键	运行所选 SQL	设置运行当前所选 SQL 的快捷键。

开发助理

SQL 编辑窗口支持使用开发助理，可以帮助查询 OceanBase 数据库知识和 SQL 开发技巧，也可以进行 SQL 生成、改写、纠错、格式化等智能处理。详细的使用说明，请参见智能 SQL 开发。

SQL 窗口编辑区

SQL 窗口编辑区工具栏支持如下功能：

功能	说明
	运行当前 SQL 窗口中所有的 SQL 语句。可以通过快捷键 Ctrl+Enter 运行所有 SQL 语句。
	运行当前选中的所有 SQL 语句或当前光标所在行的 SQL 语句。可以通过快捷键 Ctrl+Shift+Enter 运行当前语句。
	查看选中的或当前光标所在的 SQL 语句在执行前系统预估的执行计划（`EXPLAIN` 操作的结果），展示的执行数据可能与实际执行语句后的数据略有不同，您可以使用该功能评估 SQL 语句。单击执行计划按钮，在计划详情页签中，单击查看格式化信息切换至格式化展示页面。
	在查找框内输入内容以对脚本进行检索，查找后可在替换框内输入内容以对查找内容进行替换。
	将脚本回退到上一步操作执行的结果。
	执行撤销操作后，对脚本重新执行撤销前的操作。
	单击该按钮对选中的 SQL 语句或当前 SQL 窗口中的所有 SQL 语句进行统一的格式化（缩进、换行和高亮关键字等操作）。
	批量复制转化工具，适用于查询数据时对复制的行或列结果进行格式转化。将批量数据粘贴在 SQL 编辑区后，选择复制的数据，单击 IN 值转化按钮，即可转化成 in（'A','B'）格式。列值分隔符号为换行符。行值分隔符为空格或 TAB 值。
	提供全部大写、全部小写和首字母大写三种效果，将您在脚本中选中的语句转换为对应形式。
	提供添加缩进和删除缩进两种效果，为您在脚本中选中的语句添加或删除包含的缩进。
	提供添加注释和删除注释两种效果，将您在脚本中选中的语句转换为注释或转换为 SQL 语句。
	Delimiter ：在下拉列表中选择您想要的符号以完成界定符的设置。目前支持设置 ; 、 / 、 // 、 $ 和 $$ 等 5 种形式的界定符。查询结果限制：设置查询结果返回的条数，默认值为 1000 行。获取结果集列信息：SQL 执行前，支持选择是否开启获取结果集列信息。表列数量较多时关闭该选项，将不查询获取列注释及可编辑的列信息，以降低 SQL 执行耗时。会话变量：可编辑、刷新和搜索变量。

表对象

表属性管理

基本信息

table-attribute1

在属性页签的左侧数据库列表中单击 基本信息 标签查看当前表的基本信息：

信息项	说明
表名称	显示当前表的名称，同时可在此修改表的名称。
默认字符集	当前表所用的字符集。
默认排序规则	当前表所用的排序规则。
描述	显示创建表时所添加的描述，同时可在此修改对表的描述。
所有者	表对象所在的数据库。
最近修改日期	显示最近修改表属性的日期。
行数据量	显示行数。
大小	显示数据大小。

列信息

table-attribute2

信息项	说明
名称	指定字段（列）的名称。
类型	指定字段（列）的数据类型。具体数据类型，请参考 OceanBase 数据库的参考指南。
长度	指定类型长度。
小数点	设置类型精度。
非空	是否限制该字段（列）的值不能为空。
自增（MySQL 模式下）	选择是否为自增列。注意每个表仅允许设置一个自增字段（列）。当一个字段（列）设置为自增后，其余字段（列）不可勾选，需取消勾选后，才可设置其它字段（列）为自增字段（列）。
虚拟列	选择是否创建虚拟列。注意如果已勾选虚拟列，则必须填写表达式。在创建虚拟列时需要定义虚拟列依赖的表达式，虚拟列包含 Virtual Column 和 Stored Column，仅在使用时会根据表达式计算出虚拟列的值，因此在向表中插入数据的时候，不能为虚拟列指定要插入的值。
缺省值/表达式	该字段（列）的默认值/表达式。
注释	对该字段（列）的说明。

设置列页面提供 3 种功能操作：

功能项	说明
工具栏操作	通过列页面顶部的工具栏可添加和删除列。
单击行序号	单击行序号，选中整行，显示辅助菜单（新建、删除）。单击并选中行序号，可拖动整行参数以调整顺序。
鼠标右键操作	右键单击鼠标选中整行，进行复制行 / 向下移动一行。

索引信息

table-attribute3

信息项	说明
索引名称	为该索引指定的名称。
范围	默认值为 GLOBAL ，支持 GLOBAL （全局索引）/ LOCAL （局部索引）。
方法	默认值为 BTREE （全局索引），支持空/BTREE/HASH 。 BTREEB 以 B+树结构存储数据，适用于在范围查找的SQL语句中。 HASH 索引基于 HASH 表实现，只有查询条件精确匹配 HASH 索引中的所有列才会用到 HASH 索引，仅能满足"=","IN"和"<=>"查询，HASH 索引无法用于排序，不适用于区分度小的列上，例如员工性别（gender）。
索引类型	默认值为 NORMAL ，支持 NORMAL /UNIQUE/FULLTEXT 。 NORMAL 表示普通索引。 UNIQUE 表示唯一的、不允许重复的索引，例如员工工号（emp_no）。 FULLTEXT 表示全文搜索的索引，用于搜索包含大量数据的表。
列	选择索引所在的列，需注意索引列的顺序。
不可见	选择设置的索引是否可见。

约束信息

table-attribute4

由于 OceanBase 数据库中 MySQL 模式和 Oracle 模式支持的约束不同，而不同约束所需的信息也略有不同，因此请根据所选的约束方法按页面上的要求指定所需信息。

信息项	说明
约束名称	指定约束的名称。
列信息	选择一个字段或者一组字段作为约束。
关联 Schema（Oracle 模式下）	使用外键约束时需指定关联表（父表）所在的 Schema。
关联数据库（MySQL 模式下）	使用外键约束时需指定关联表（父表）所在的数据库。
关联表	使用外键约束时需指定关联表（父表）。
关联字段	使用外键约束时需指定关联字段（父表）。
删除	指定删除关联表（父表）中的数据时，当前表（子表）对应的动作。可指定 CASCADE 、 NO ACTION 、 RESTRICT 和 SET NULL 等四种对应的动作。 MySQL 和 Oracle 模式下所支持的外键动作不同： MySQL 模式下，OceanBase 可指定 CASCADE、NO ACTION、RESTRICT 和 SET NULL； Oracle 模式下，OceanBase 可指定 CASCADE、NO ACTION 和 SET NULL。注意 OceanBase 暂不支持 SET NULL 动作。相关语法，请参考 OceanBase 或 MySQL/Oracle 官网文档。
更新	指定更新关联表（父表）中的数据时，当前表（子表）对应的动作。可指定 CASCADE 、 NO ACTION 、 RESTRICT 和 SET NULL 等四种对应的动作。 MySQL 和 Oracle 模式下所支持的外键动作不同： MySQL 模式下，OceanBase 可指定 CASCADE、NO ACTION、RESTRICT 和 SET NULL； Oracle 模式下，OceanBase 可指定 NO ACTION。注意 OceanBase 暂不支持 SET NULL 动作。相关语法，请参考 OceanBase 或 MySQL/Oracle 官网文档。
检查条件	指定执行检查约束时校验数据的检查规则。

分区规则

table-attribute5

由于在 MySQL 模式和 Oracle 模式下分区的定义不同，因此以下信息在不同模式下的意义略有不同，请根据所选的分区方法按其定义指定以下信息：

信息项	说明
分区方法	指定分区方法。 MySQL 模式和 Oracle 模式下支持的分区方法不同。 Range 分区：基于一个给定连续区间的列值，将多行分配给分区。范围必须是有序的、连续的和不重叠的。 List 分区：基于数据的枚举值进行分区。 Hash 分区：基于给定的分区个数进行分区。对于分布规则不明显的数据，并没有明显的范围查找等特征，可以使用HASH分区，将数据分区列的值按照HASH算法打散到不同的分区上，将数据随机分布到各个分区。 Key 分区：类似于按 HASH 分区，区别在于 KEY 分区只支持计算一列或多列，且 MySQL 服务器提供其自身的哈希函数。必须有一列或多列包含整数值。有关分区方法，请参见 OceanBase 数据库分区表。
字段	选择作为分区键的字段。
表达式	根据表达式的返回值进行分区（Oracle 模式下不支持分区表达式）。
分区	根据所选的分区方法，可能需要指定分区名称、分区数量、区间上限值或值枚举等信息。可添加多个分区，并拖动已选字段进行排序。

DDL 信息

table-attribute6

可在属性页签中单击左导航栏中的 DDL 标签，查看当前表的 DDL 语句（即查看定义当前表的 SQL 语句，不支持编辑）。

表数据管理

编辑结果集页面的工具栏中提供了以下功能键：

功能	说明
	编辑当前展示的结果集。编辑态中提供添加一行、删除、复制当前行、取消和确认修改（当自动提交设置为开时，单击该按钮事务被自动提交）等编辑操作。
	查看选中的或当前光标所在的 SQL 语句在执行前系统预估的执行计划（`EXPLAIN` 操作的结果），展示的执行数据可能与实际执行语句后的数据略有不同，您可以使用该功能评估 SQL 语句。单击执行计划按钮，在计划详情页签中，单击查看格式化信息切换至格式化展示页面。
	查看执行当前 SQL 语句的全链路 Trace 详情。通过全链路诊断可快速定位 SQL/事务在各个节点的执行耗时，方便定位异常。说明仅 OceanBase V4.1.0 及之后的版本支持查看全链路 Trace。
	在搜索框中输入关键字查询所需结果。
	筛选在页面中展示的列。
	以表格的形式展示一行选中的数据。在列模式页面可以进行上一行、下一行的切换展示，对于列数量比较多场景，列模式比较方便行数据的查看。参考步骤如下：选中需查看的数据后，单击列模式列模式按钮按钮。在弹出的列模式页面中，可单击左右按钮查看上下行列值。鼠标移动至某值字段，单击放大按钮，可查看该列字段详情。在列模式列表中，可通过备注查看表中对应的列注释信息。修改备注信息步骤如下：在左侧导航栏的表列表中，右键单击目标表，选择查看表结构，进入表属性管理页签。在属性页签的左导航栏中单击列标签。选择字段名，单击编辑图标，弹出编辑字段弹窗。在字段注释中，填写字段注释后，单击确定。在 SQL 确认弹窗，单击执行，完成修改备注信息。在列模式中即会显示修改的备注信息。

视图对象

在编辑页面的工具栏中提供了以下功能键：

功能	说明
格式化	单击该按钮对选中的 SQL 语句或当前 SQL 窗口中的所有 SQL 语句进行统一的格式化（缩进、换行和高亮关键字等操作）。
查找/替换	在查找框内输入内容以对脚本进行检索，查找后可在替换框内输入内容以对查找内容进行替换。
撤销	脚本回退到上一步操作执行的结果。
重做	执行撤销操作后，对脚本重新执行撤销前的操作。
大小写	提供全部大写、全部小写和首字母大写三种效果，为脚本中选中的语句转换为对应形式。
缩进	提供添加缩进和删除缩进两种效果，为脚本中选中的语句添加或删除包含的缩进。
注释	提供添加注释和删除注释两种效果，脚本中选中的语句转换为注释或转换为 SQL 语句。
IN 值转化	可以将如 A B 的格式转化为 ('A','B') 的格式。
上一步	返回新建视图页面，用户可以继续编辑或修改基本信息、基表选择和字段选择页签中的指定的值。

函数对象

编辑函数页面的工具栏中提供了以下功能键：

功能	说明
确认修改	单击以更新本次修改。
	下载函数对象的 SQL 文件。
	运行当前函数。
	编译目标函数。
	在查找框内输入内容以对脚本进行检索，查找后可在替换框内输入内容以对查找内容进行替换。
	将脚本回退到上一步操作执行的结果。
	执行撤销操作后，对脚本重新执行撤销前的操作。
	单击该按钮对选中的 SQL 语句或当前 SQL 窗口中的所有 SQL 语句进行统一的格式化（缩进、换行和高亮关键字等操作）。
	批量复制转化工具，适用于查询数据时对复制的行或列结果进行格式转化。将批量数据粘贴在 SQL 编辑区后，选择复制的数据，单击 IN 值转化按钮，即可转化成 in（'A','B'）格式。列值分隔符号为换行符。行值分隔符为空格或 TAB 值。
	提供全部大写、全部小写和首字母大写三种效果，将在脚本中选中的语句转换为对应形式。
	提供添加注释和删除注释两种效果，旨在脚本中选中的语句转换为注释或转换为 SQL 语句。
	提供添加缩进和删除缩进两种效果，旨在脚本中选中的语句添加或删除包含的缩进。

存储过程对象

在编辑页面的工具栏中提供了以下功能键：

功能	说明
确认修改	单击以更新本次修改。
	下载存储过程对象的 SQL 文件。
	运行当前存储过程。
	编译目标存储过程。
	在查找框内输入内容以对脚本进行检索，查找后可在替换框内输入内容以对查找内容进行替换。
	将脚本回退到上一步操作执行的结果。
	执行撤销操作后，对脚本重新执行撤销前的操作。
	单击该按钮对选中的 SQL 语句或当前 SQL 窗口中的所有 SQL 语句进行统一的格式化（缩进、换行和高亮关键字等操作）。
	批量复制转化工具，适用于查询数据时对复制的行或列结果进行格式转化。将批量数据粘贴在 SQL 编辑区后，选择复制的数据，单击 IN 值转化按钮，即可转化成 in（'A','B'）格式。列值分隔符号为换行符。行值分隔符为空格或 TAB 值。
	提供全部大写、全部小写和首字母大写三种效果，将在脚本中选中的语句转换为对应形式。
	提供添加注释和删除注释两种效果，旨在脚本中选中的语句转换为注释或转换为 SQL 语句。
	提供添加缩进和删除缩进两种效果，旨在脚本中选中的语句添加或删除包含的缩进。

触发器对象

trigger1

在编辑页面的工具栏中提供了以下功能键：

功能	说明
确认修改	单击以更新本次修改。
	在查找框内输入内容以对脚本进行检索，查找后可在替换框内输入内容以对查找内容进行替换。
	将脚本回退到上一步操作执行的结果。
	执行撤销操作后，对脚本重新执行撤销前的操作。
	单击该按钮对选中的 SQL 语句或当前 SQL 窗口中的所有 SQL 语句进行统一的格式化（缩进、换行和高亮关键字等操作）。
	批量复制转化工具，适用于查询数据时对复制的行或列结果进行格式转化。将批量数据粘贴在 SQL 编辑区后，选择复制的数据，单击 IN 值转化按钮，即可转化成 in（'A','B'）格式。列值分隔符号为换行符。行值分隔符为空格或 TAB 值。
	提供全部大写、全部小写和首字母大写三种效果，将在脚本中选中的语句转换为对应形式。
	提供添加注释和删除注释两种效果，旨在脚本中选中的语句转换为注释或转换为 SQL 语句。
	提供添加缩进和删除缩进两种效果，旨在脚本中选中的语句添加或删除包含的缩进。

类型

在创建类型页面的工具栏中提供了以下功能键：

功能	说明
	在查找框内输入内容以对脚本进行检索，查找后可在替换框内输入内容以对查找内容进行替换。
	将脚本回退到上一步操作执行的结果。
	执行撤销操作后，对脚本重新执行撤销前的操作。
	单击该按钮对选中的 SQL 语句或当前 SQL 窗口中的所有 SQL 语句进行统一的格式化（缩进、换行和高亮关键字等操作）。
	批量复制转化工具，适用于查询数据时对复制的行或列结果进行格式转化。将批量数据粘贴在 SQL 编辑区后，选择复制的数据，单击 IN 值转化按钮，即可转化成 in（'A','B'）格式。列值分隔符号为换行符。行值分隔符为空格或 TAB 值。
	提供全部大写、全部小写和首字母大写三种效果，将在脚本中选中的语句转换为对应形式。
	提供添加注释和删除注释两种效果，旨在脚本中选中的语句转换为注释或转换为 SQL 语句。
	提供添加缩进和删除缩进两种效果，旨在脚本中选中的语句添加或删除包含的缩进。

个人设置

开发助理

SQL 窗口编辑区

表对象

表属性管理

基本信息

列信息

注意

注意

索引信息

约束信息

注意

注意

分区规则

DDL 信息

表数据管理

说明

视图对象

函数对象

存储过程对象

触发器对象

类型

相关文档