查询窗口

查询窗口首页

前提条件

•        已将可用的实例添加至组织，添加云数据库详见实例列表-添加云数据库，添加公网/直连数据库详见实例列表-添加公网/直连数据库。

•        已准备好该实例的数据库账号、密码，并且成功登录该实例。

操作步骤

1.    通过点击左侧菜单栏 开发空间 >查询窗口进入。

2.    通过控制台首页，点击功能简介模块中的查询窗口立即体验按钮进入。

3.    通过控制台首页，点击功能简介模块中的脚本管理立即体验按钮进入。

功能介绍

查询窗口首页由实例搜索框、最近访问的库/模式、最近打开的脚本三部分组成。

²  注意

实例搜索时，用户只能搜索到自身具有登录和查询权限的实例。

•        实例搜索框：支持关键字模糊搜索，可输入实例名称、库/模式名称、实例地址等进行模糊搜索。

•        最近访问的库/模式：展示最近的三条访问记录，每条记录展示实例信息和最近查询时间，点击跳转按钮可以直接跳转到查询窗口的主界面。

•        最近打开的脚本：展示最近的三条访问记录，每条记录展示脚本所属的实例信息和脚本名称，点击编辑按钮可以跳转到查询窗口，并打开脚本Tab界面。

查询窗口介绍

前提条件

•        已将可用的实例添加至组织，添加云数据库详见实例列表-添加云数据库，添加公网/直连数据库详见实例列表-添加公网/直连数据库。

•        已准备好该实例的数据库账号、密码。

注意事项

•        查询结果分页显示，每个分页默认展示20行数据，单次查询最大返回3000行，暂不支持用户修改该最大行数的默认值。

•        针对单个实例，最多可同时打开10个查询窗口。

•        单次查询最大支持50000个字符的SQL内容，最多支持100条SQL语句一次性执行。

•        对于MySQL系的实例需要选择到库级别进行操作，对于PostgreSQL系的实例需要选择到模式级别进行操作，为了叙述方便，本页面的说明皆以MySQL实例为标准。

操作步骤

1.    登录数据管理服务DMS。

2.    在左侧菜单栏依次点击开发空间 > 查询窗口 ，进入查询窗口首页。

3.    在查询窗口首页的下拉列表中选择目标库或者目标模式，点击查询按钮。

4.    在打开的实例登录弹窗中输入数据库账号密码，登录实例。

查询窗口界面介绍

表1 查询窗口界面介绍

序号

区域

说明

①

团队信息区域

展示当前实例所属的团队名称。

②

打开新标签页

点击，可打开一个当前选中数据库的新的查询标签页，最多可同时打开10个标签页。查询标签页的名称与脚本的名称保持一致。

③

实例信息区域

展示实例的IP、端口、实例名称等信息，鼠标悬浮可展示完整的信息。

④

功能按钮区域

•        执行：执行标签页内的SQL语句，也支持选择部分SQL语句执行。设定了F8为快捷键。

•        保存：将当前查询窗口中的所有SQL语句保存至我的脚本，方便下次使用，并支持对脚本进行命名。

•        格式化：优化选中的SQL语句的展示格式，增强可读性。

•        预估执行计划：在SQL语句执行前预测SQL语句执行时可能采用的逻辑步骤和访问路径，当前仅支持MySQL和PostgreSQL数据库。

•        实际执行计划：在SQL语句执行时由数据库引擎生成，反映了实际执行的确切步骤和细节，当前仅支持MySQL和PostgreSQL数据库。

•        语法帮助：提供了涵盖表/索引、show语句、视图、函数/存储过程、触发器、事件、权限相关的语法，以及select、update、insert、delete、replace等常用语法。

•        会话管理：会话管理帮助数据库运维和管理人员，快速查看与管理实例的会话信息，并支持高效定位难以排查的异常会话与阻塞问题。详见会话管理。

•        设置：可以对查询窗口标签页内的字体大小、结果集展示方式、语法提示功能开启状态等选项进行设置。

•        SQL生成：SQL生成提供了自然语言转换为sql语句的智能AI功能。详见SQL生成。

²  注意

•        查询窗口暂不支持会话保持功能，依赖于SAVEPOINT、HANDLER等的事务性语句请一次性执行。

•        语法帮助目前支持MySQL、PostgreSQL数据库。

•        管理员模式：此模式下执行SQL，不受风险、规范的限制，请谨慎操作，具体介绍参考管理员模式。

⑤

数据库用户区域

展示当前登录的数据库用户，可以进行退出或切换账号操作。

•         

        ：跳转到对象列表界面。

•         

        ：进入全屏操作。

⑥

数据库信息区域

展示当前选择的数据库信息，点击下拉列表可以切换到当前实例下其他的数据库，点击右侧的复制图标，可以复制完整的数据源信息。

⑦

可视化操作区域

该区域提供可视化管理数据库的功能：

•        表：分页展示当前数据库中的所有表信息，包括表名、表的大小、表的字段、字段类型、索引。右键单击目标表名称时，可进行打开表、新建表、编辑表、查看表详情、重命名表、复制表名、删除表等操作。且支持对表名进行搜索，修改表数据后，可以点击刷新按钮更新元数据。双击表名可于查询标签页生成简单的查询语句。

•        可编程对象：可查看当前数据库中的所有的可编程对象，包括视图、存储过程、函数、事件、触发器。右键单击可编程对象名称时，可进行创建、查看、编辑、删除等操作。

•        我的脚本：分页展示脚本列表，右键脚本名称可以对脚本进行查看、编辑、删除、复制、重命名等操作。

⑧

命令执行区域

支持如下功能：

•        SQL执行：支持执行单条语句或批量执行，批量执行最多一次执行100条语句，每条语句对应一个结果集。

•        中断执行：SQL执行过程中可以单击取消查询中断SQL的执行。

•        语法高亮：以不同颜色显示不同的语法元素，尤其会对关键字进行区别显示，提高SQL语句可读性。

•        元数据智能提示：根据用户输入的内容以及数据库的语法规则，自动提示对应的元数据信息。

⑨

执行结果区域

该区域主要展示执行历史、执行信息、结果集等信息。

•        执行历史：分页展示当前用户在当前数据库下的SQL语句执行记录，默认展示20条，且支持通过执行时间进行搜索。

•        执行信息：展示每次点击执行按钮之后的执行结果信息，可以选择覆盖展示或者追加展示。对于DQL类的查询语句，执行信息界面不直接展示结果信息，可在结果集tab查看。

•        结果集：当执行DQL类语句时将在结果集界面展示结果信息。支持新增、修改、删除、导出等操作，同时还支持对查询结果进行关键字搜索、高亮展示、展示界面调整等功能。

查询指引

前提条件

•        已将实例添加至组织，添加实例详见实例列表-添加云数据库、实例列表-添加公网/直连数据库

•        已准备好该实例的账号、密码。

操作步骤

平台提供了多个进入查询窗口页面的入口，包括从控制台首页进入、从菜单栏 开发空间 >查询窗口进入、从菜单栏实例列表进入、从实例元数据页面进入等。

从控制台首页进入

•        点击“功能简介”模块中的查询窗口立即体验按钮进入，详见查询窗口首页。

•        点击“最近访问的库/模式”、“最近打开的脚本”列表中的查询操作进入。

从查询窗口首页进入

1.    在左侧菜单栏中，选择 开发空间 >查询窗口 ，进入查询窗口首页。

2.    选择库/模式后点击查询按钮，或者点击

        、

        进入查询窗口操作页面。

从实例列表进入

1.    在左侧菜单栏中，选择实例列表 ，默认打开实例列表。

2.    双击库/模式名称进入查询窗口操作页面；或右击库/模式名后点击查询窗口进入。

从实例元数据页面进入

1.    在左侧菜单栏中，选择 数据源管理 >实例元数据 ，进入实例元数据页面。

2.    点击实例列表中的查询操作进入查询窗口操作页面。

功能介绍

使用SQL语句操作数据库

查询窗口目前能够很好的支持MySQL、PostgreSQL的大部分语法，以查询数据为例：

1.    进入查询窗口。

2.    双击表名称可在SQL编辑器中自动生成查询表的SQL语句，也可输入查询语句后，点击执行按钮，即可在执行结果区域显示查询的数据。

3.    支持同时执行多条SQL语句，在执行结果区域会生成多个结果集。

管理结果集

为了叙述方便，下面的说明皆以MySQL实例为标准。

搜索结果集

在结果集右上角的搜索框中，输入查询关键字，此时与输入内容模糊匹配的数据都会被高亮显示。

编辑结果集

单击开启编辑按钮，可以对结果集进行新增、编辑、删除等操作，编辑完成后，需单击提交编辑 。

²  注意

当结果集具有非空主键或唯一键的情况下，才可以进行编辑。

•        新增数据：新增空数据行在结果集的最后一行，此时可输入待增加的数据。

•        编辑数据：单击单元格可进行编辑操作，被编辑的表格左上角将出现红色角标。对于一些特殊的二进制字段，不支持直接编辑，提供上传功能。

•        删除数据：选中某一行数据，单击删除行 ，然后单击提交编辑 。

•        取消编辑：在进行新增、编辑或删除操作后，如果不想进行修改，可以单击取消编辑按钮取消修改。

•        提交编辑：在完成新增、编辑或删除操作后，才可使用提交修改功能。单击提交编辑后会生成预览SQL，单击执行按钮后，修改的数据才会生效。

导出结果集

SELECT等查询类语句支持导出结果集功能。

单击导出结果集按钮，可以将结果集导出为SQL文件、CSV文件或者TXT文件，默认导出当前页的数据，当导出范围选择更多数据时，会跳转到数据导出页面进行导出。

当进行多表联合查询并且导出文件类型为SQL时，可以自定义导出的目标表名。

当导出的结果集包含一些特殊字段时，会跳转到数据导出页面进行导出。

复制结果集

对于结果集，支持单个字段、单行的复制。复制单行数据时，可以选择复制为SQL、CSV、JSON、XML格式。在单个字段上，鼠标右键复制行或复制行为即可看到相关的菜单。

冻结/解冻列

结果集支持对列的冻结和解冻操作。

•        冻结：在未冻结列上右键 >冻结此列 ，即可将该列进行冻结，同时该列会移动到最前面。

•        解冻：在已冻结列上右键 >解除冻结 ，即可将该列解除冻结，同时该列会移动到原来的位置。

管理SQL脚本

进入查询窗口后，可以把常用的SQL保存为SQL脚本，并对脚本进行管理。

添加常用SQL

在当前查询tab页，点击保存按钮，可以把当前查询窗口的SQL语句保存为一个SQL脚本，输入脚本名称后，点击保存，脚本就会显示在脚本列表。

使用SQL脚本

在目标脚本文件右键 > 打开/编辑 ，可以把脚本内容在查询窗口打开，进行再编辑或者执行SQL语句。右键 > 复制使用 ，可以复制脚本的内容在粘贴板。

删除SQL脚本

在目标脚本文件右键 > 删除 ，可以删除对应的脚本文件。

通过表的形式查看数据

1.    进入查询窗口。

2.    在查询窗口左侧表列表中，右键单击目标表，选择 打开表 。

3.    在弹出的tab页中，即可用表格形式查看数据。

执行历史

执行历史会记录用户执行的每一条SQL，包括执行时间、执行语句、执行结果、耗时等信息。支持按时间筛选执行历史，双击执行语句可以快速将SQL语句粘贴到查询窗口。

查询和新建/编辑表结构

前提条件

已具备对应数据库的新建、查询、编辑、删除等权限。

注意事项

删除表操作不可回滚，请确保备份重要数据后再执行。

查询表结构

以查询MySQL表结构为例，操作步骤如下：

操作步骤

1.    进入查询窗口页面。

2.    在查询窗口左侧表tab中，右键表名称打开操作框，点击表详情 。

新建/编辑表结构

²  注意

可视化地新建/编辑表结构功能暂时仅限MySQL、PostgreSQL类型数据库。

以新建/编辑MySQL表为例，操作步骤和界面介绍如下：

操作步骤

从实例元数据页面进入

1.    登录DMS系统。

2.    在左侧菜单栏中，选择 数据源管理 > 实例元数据 ，选择库列表 。

3.    进入库列表后，选择对象列表 ，展示当前库下的所有表。

4.    进入对象列表后，点击新建表按钮，即可进入新建表页面；点击某个表的编辑按钮，即可查看该表的属性。

从查询窗口页面进入

1.    进入MySQL某个库下的查询窗口。如何进入查询窗口详见查询指引-操作步骤。

2.    选中某个表，右键，选择弹出菜单中的新建表 ，进入新建表页面；选择弹出菜单中的 编辑表 ，即可查看该表的属性。

界面介绍

新建表和编辑表的界面布局是一致的，不同的数据库类型，可能会有不同的模块信息供填写，以MySQL表为例，分为以下模块：

•        基本信息：填写表的名称、备注等整体属性。

•        列信息：填写列的数据类型、默认值、备注等属性。

•        索引信息：填写表的索引名称、索引类型等属性。

•        外键信息：填写表的外键名称、参考表列等属性。

•        约束信息：填写表的check约束表达式。

删除表

以删除MySQL表为例，操作步骤如下：

操作步骤

•        从 数据源管理 > 实例元数据 > 库/模式列表 > 对象列表页点击列表中的删除操作。

•        在查询窗口左侧表tab中，右键表名称打开操作框，点击删除表打开删除确认弹窗后点击确定按钮，即可完成删除表。

打开表

前提条件

•        已经录入实例并登录实例。

•        操作的库或者模式下拥有建好的表数据。

•        拥有该表的查询权限。

操作步骤

平台提供了多个进入打开表页面的入口，包括：

1.    查询窗口主界面，表Tab页右键点击表名称选择打开表进入。

2.    数据源管理 > 实例元数据 > 库列表 > 对象列表 ，点击打开按钮进入。

功能介绍

打开表界面支持开启编辑功能和导出表功能。

•        开启编辑：点击开启编辑按钮后可以对查询结果集进行编辑，详见查询指引-管理结果集。

•        导出表：点击导出表按钮后跳转到数据导出界面，详见数据导出介绍。

表详情

背景信息

表详情中引入表的元数据，可以帮助用户更好地理解数据的含义，提高开发和管理效率，元数据包括：表所属库和实例、表名、字段、索引、注释、环境等。

前提条件

•        已经录入实例并登录实例。

•        操作的库或者模式下拥有建好的表数据。

•        拥有该表的查询权限。

操作步骤

平台提供了多个进入表详情页面的入口，包括：

•        通过数据源管理 > 实例元数据 > 库/模式列表 > 对象列表 >表tab ，点击详情操作进入。

•        通过查询窗口操作页，表tab右键表名称选择表详情进入。

功能介绍

表详情页面旨在为用户提供关于特定数据库表的详细信息和管理功能。该页面汇总了表的结构、元数据、索引等多方面的信息，使用户能够深入了解和管理数据库表。

在表详情页面，主要功能如下表所示：

表1. 表详情介绍区域

说明

菜单栏

•        新建表：点击新建表按钮，跳转到新建表页面。

•        同步元数据：点击同步元数据按钮，能同步当前表的元数据信息。

•        查询窗口：点击查询窗口按钮，能打开对应的查询窗口。

表概览

•        当前所在表：显示当前表的名称，可以下拉选择其他表，打开其他表的表详情。

•        实例地址：显示当前表所在实例的实例地址，包括IP和端口信息。

•        数据库类型：显示当前表所在实例的实例类型，比如MySQL、PostgresSQL、SQLServer、DRDS等。

•        环境：显示当前表所在实例所对应的环境，比如开发、测试等。

基本信息

•        表名称：显示表的名称。

•        行：显示当前表有几条行记录。

•        主键：显示当前表的主键信息。

•        数据长度：显示当前表中数据的总大小。

•        索引长度：显示当前表中索引的总大小。

•        字符集：显示当前表的字符集信息。

•        排序规则：显示当前表的排序规则信息。

•        创建时间：显示当前表的创建时间。

•        修改时间：显示当前表的修改时间。

•        注释：显示当前表的注释。

列信息

•        字段名：表中字段的名称。

•        类型：表中字段的类型。

•        描述：表中字段的描述。

•        可空：表中字段是否可以为空。

•        自增：表中字段是否自增。

•        默认值：表中字段的默认值。

索引信息

•        索引名：表中索引的名称。

•        索引类型：表中索引的类型，比如BTREE、HASH等。

•        包含列：表中索引包含的列字段的名称。

•        备注：表中索引的备注。 

通过提供这个综合的表详情页面，我们的目标是简化用户对数据库表的管理任务，提高操作效率，同时为用户提供丰富的信息，以便更好地理解和利用数据库中的数据。

新建/编辑可编程对象

前提条件

•        已经录入实例并登录实例。数据管理服务支持录入的实例详见实例列表-添加云数据库、实例列表-添加公网/直连数据库。

•        拥有可编程对象的操作权限。

注意事项

•        数据管理服务目前支持的可编程对象有视图、存储过程、函数、事件、触发器、触发器函数、序列，按数据库类型不同对应显示。

•        新建/编辑可编程对象时，在点击提交按钮前可先点击DDL按钮查看DDL语句，确认无误后再点击提交。

•        可视化地新建/编辑可编程对象功能暂时仅限MySQL、PostgreSQL类型数据库。

操作步骤

1.    登录DMS系统。

2.    选择对应的库/模式，进入查询窗口。如何进入查询窗口详见查询指引-操作步骤。

3.    在左侧tab页中，选择可编程对象。

功能介绍

新建可编程对象

新建视图

1.    在视图上右键 ，选择新建视图 ，打开新建视图页面。

2.    在页面按要求输入视图名称、算法、安全性、检查选项、视图定义等信息后，点击提交按钮即可创建视图。

新建存储过程

1.    在存储过程上右键 ，选择新建存储过程 ，打开新建存储过程页面。

2.    在页面按要求输入存储过程名称、确定性、安全性、数据访问类型、注释、存储过程定义等信息后，点击提交按钮即可创建存储过程。

新建函数

1.    在函数上右键 ，选择新建函数 ，打开新建函数页面。

2.    在页面按要求输入函数名、函数的入参、函数的返回值类型、函数定义等信息后，点击提交按钮即可创建函数。

新建事件

1.    在事件上右键 ，选择新建事件 ，打开新建事件页面。

2.    在页面按要求输入事件名、事件定义等信息后，点击提交按钮即可创建事件。

新建触发器

1.    在触发器上右键 ，选择新建触发器 ，打开新建触发器页面。

2.    在页面按要求输入触发器名称、触发表、触发时机、触发事件、触发器定义等信息后，点击提交按钮即可创建触发器。

编辑可编程对象

²  说明

以编辑视图为例，其他可编程对象操作类似。

1.    在视图名称上右键 ，选择编辑视图 ，打开编辑视图页面。

2.    可以对视图名称、视图定义等进行修改，修改完成后，点击提交按钮即可。

删除可编程对象

²  说明

以删除视图为例，其他可编程对象操作类似。

在视图名称上右键 ，选择删除视图操作，在删除确认弹窗上点击确定按钮即可。

新建/编辑脚本

前提条件

用户有查看和编辑脚本权限。

注意事项

编辑脚本后，需点击保存按钮存储修改内容。

新建SQL脚本

1.    进入查询窗口 ， 点击窗口上方tab的

        ，打开新建脚本页面。

2.    编辑脚本内容完毕，点击保存按钮，弹出脚本命名窗口。命名后点击 确定 ，保存脚本。

3.    保存成功后，查询窗口左侧的脚本列表可显示新建的脚本。

打开SQL脚本

1.    打开查询窗口，选择窗口中我的脚本tab页，可查看已保存的SQL脚本。

2.    双击脚本名称，即可打开脚本。

3.    双击脚本列表，可展开脚本列表窗口，查看脚本的相关信息和进行编辑。

删除SQL脚本

•        在左侧我的脚本tab中，右键选中脚本，点击删除按钮，在打开的删除确认弹窗上点击确定按钮即可。

•        在展开的脚本列表中，点击操作栏的删除按钮，在打开的删除确认弹窗上点击确定按钮即可。

快速访问SQL脚本

DMS的查询窗口支持恢复上次未关闭的SQL脚本窗口。

²  注意

恢复窗口功能仅限已进行保存操作的SQL脚本。

在DMS的首页，可通过最近打开的脚本或脚本管理模块，快速打开脚本窗口。

搜索脚本

•        控制台头部右侧的搜索栏，支持SQL脚本名称的全局搜索和条件筛选，点击搜索结果中的脚本可快速跳转到编辑脚本页。

•        查询窗口中，打开脚本列表后，通过搜索栏搜索脚本名称。

管理员模式

背景信息

风险管控、SQL规范、查询次数限制、查询行数限制等功能可以增强数据库的安全性和稳定性，防止危险操作的发生。但在一些紧急的运维场景下，上述功能也会给系统管理员、运维管理员快速处理故障带来不便。因此，具备权限的管理员可以进入管理员模式执行SQL，不会受到风险规范等功能的限制。

前提条件

•        组织版本为企业版。

•        用户具备使用管理员模式的权限。菜单权限请参考权限说明。

注意事项

管理员模式下在查询窗口执行SQL时将不受各种规则、规范等的限制，无需审批可直接执行，请注意操作风险。

操作步骤

1.    用户登录DMS系统。

2.    在左侧菜单栏依次选择 开发空间 > 查询窗口 。

3.    选择具体的库/模式进入查询窗口主界面后，点击SQL编辑框上方的管理员模式按钮。

4.    在打开的管理员模式确认弹窗中点击确定按钮，即可进入管理员模式界面。如需退出，请点击退出管理员模式按钮即可。