Gauss DB除了gsql命令行操作，还支持一款GUI工具：Data Studio。
Data Studio主要为数据库开发人员提供以下功能：
浏览数据库对象。
创建和管理数据库对象（例如：数据库、schema、表、索引）。
执行SQL语句和SQL脚本。
编辑和执行PL/SQL语句。
使用Data Studio连接数据库属远程连接，因此需要GaussDB 200已经做了支持远程连接的配置。
Data Studio的使用方法请参见随工具配套发布的《Data Studio用户手册》。
今天就分享一下如何使用Data Studio。
获取Data Studio软件包
https://support.huawei.com/enterprise/zh/software/250590638-ESW2000136080
image.png
安装 Data Studio
解压安装包后即可运行Data Studio
image.png
- 结构说明
| 文件夹/文件 | 说明 |
|---|---|
| configuration | 包含应用启动信息和所需Eclipse插件路径信息。 |
| db_assistant | 包含“SQL助手”功能相关的文件。 |
| docs | ● 包含《Data Studio用户手册.pdf》，本手册详细介绍了如何使用Data Studio 工具。● 包含在Data Studio中使用的开源软件 的版权声明、许可证和书面邀约。 |
| features | 包含Eclipse（如富客户端协议GUI）和 Data Studio特性。 |
| p2 | p2包含的文件用于提供和管理基于Eclipse 和Equinox的应用。 |
| plugins | 包含必须的Eclipse和Data Studio插件。 |
| tools | 包含Data Studio的依赖工具。 |
| UserData | ● Autosave ● Logs/ ● Preferences/ ● Profile/ – History/ ● Security/ 包含每个使用Data Studio的OS用户各自 的文件夹。 Autosave：包含自动保存的查询和函数/ 过程信息。 Logs：包含Data Studio.log文件，该文件 保存Data Studio所有操作的日志信息。 Preferences：包含Preferences.prefs文 件，内容为自定义的首选项。 Profile：包含connection.properties文 件、SQL执行历史、Profiles.txt文件，用于 管理Data Studio中的连接信息。 Security：包含Data Studio安全管理所需 文件。 说明 ● User Data文件夹在首个用户用Data Studio 打开实例后创建。 ● 日志文件夹、语言、内存设置、日志级别对 所有用户生效。 ● Data Studio启动后，会创建日志文件夹、 Data Studio.log 文件、Preferences文件 夹、Preferences.prefs文件、Profile文件 夹、connection.properties文件、 Profiles.txt文件和security文件夹。 ● 如果Data Studio.ini文件中指定了日志文件 夹路径，日志会在指定路径创建。 ● 如果您因安全密钥被损坏，无法登录Data Studio，请按如下步骤生成新的安全秘钥： 1. 从Data Studio文件夹下的UserData文件 夹中删除security文件夹。 2. 重启Data Studio。 |
| artifacts.xm | 包含产品编译版本信息。 |
| changelog.txt | 包含当前版本的详细变更信息。 |
| DataStudio.exe/DataStudio.sh | 支持连接服务器并执行各种操作，如管理 数据库对象、编辑或执行PL/SQL程序。 |
| Data Studio.ini | 包含Data Studio工具运行时的配置信息。 |
| readme.txt | 包含当前版本的功能和修复的问题。 |
- 双击Data Studio.exe启动
配置 Data Studio
通过Data Studio.ini文件来配置Data Studio，下表为Data Studio相关的配置参数列表。
| 参数 | 说明 | 取值范围 | 默认值 |
|---|---|---|---|
| -startup | 加载DataStudio所需的.jar文件。各版本所需的文件不同。 | 不适用 | plugins/ org.eclipse.equinox .launcher_1.3.100.v 20150511-1540.jar |
| --launcher.library | 加载Data Studio所需的 库。各版本所需的库不同。 | 不适用 | 取决于所使用安装包，可能为 plugins/ org.eclipse.equinox .launcher.win32.win32.x86_1.1.300.v2 0150602-1417 或 plugins/ org.eclipse.equinox .launcher.win32.win32.x86_64_1.1.30 0.v20150602-1417 |
| -clearPersistedState | 删除当前用户界面上的所 有缓存内容，重新加载Data Studio。 | 不适用 | 不适用，建议增加该参数。 |
| -consoleLineCount | “消息”窗口显示的大行数。 | 1-5000 | 1000 |
| -logfolder | 创建日志文件夹。用户可指定日志文件的保存路径，如果使用默认值“.”，则在 Data Studio \User data \ < 用户名 > \ logs 创建文件夹。 | 不适用 | - |
| -loginTimeout | 定义创建连接的等待时间，单位为秒。在该参数指定的时长内，Data Studio会不断尝试连接数据库。如果超时，会提示 超时或连接失败。 | 不适用 | 180 |
| -data | 会话的实例数据位置。 | 不适用 | @none |
| @user.home/MyAppWorkspace | 启动Data Studio时，在此位置创建Eclipse工作区。其中，@user.home指的是 C:/Users/<username>路 径。 Eclipse日志文件保存在以下位置：@user.home/MyAppWorkspace/.metadata | 不适用 | 不适用 |
| -detailLogging | 日志记录错误消息。如果 设为True，则日志记录所有错误消息。如果设为False，则日志仅记录Data Studio中明确指定的错误 消息。默认情况下不添加此参数，如需记录日志，可以手动设置此参数。 | True/False | False |
| -logginglevel | 基于指定的值创建日志文件。如果该值设为取值范围外的任意值或为空，则 使用默认值WARN。有关详情，请参见“不同日志 级别类型”。 默认情况下不添加此参数，如需记录日志，可以手动设置此参数。 | FATAL、 ERROR、 WARN、 INFO、 DEBUG TRACE、 ALL和OFF | WARN |
| -focusOnFirstResult | 自动定位“结果”页签。 如果设为false，则自动定 位到新打开的“结果”页签。如果设为true，则禁用自动定位功能。 | True/False | False |
- 以上所有参数必须配置在-vmargs参数之前。
- startup和launcher.library参数必须分别配置为第一和第二个参数。
| 参数 | 说明 | 取值范围 | 默认值 |
|---|---|---|---|
| -vmargs | 虚拟机参数的起始位置。 说明-vmargs参数必须配置于配置文件的末尾。 | 不适用 | 不适用 |
| -vm <file name (javaw.exe) with relative path to Java executable> | 定义文件名（javaw.exe） 和Java的相对路径。 | 不适用 | 不适用 |
| -Dosgi.requiredJav aVersion | 运行Data Studio所需的 低Java版本。请勿修改该 参数值。 | 不适用 | 1.5。推荐的Java版本为 1.8.0_141。 |
| -Xms | Data Studio消耗的初始堆空间。该值必须是1024的倍数，大于40 MB，且小于或等于-Xmx。在值的末尾加上字母k或K可表示千字节，加上m或M表示可表示兆字节，g或G可表示千兆字节。例如：-Xms40m -Xms120m | 不适用 | -Xms40m |
| -Xmx | Data Studio消耗的大堆空间。可根据可用的RAM空间调整该值。在值的末尾加上字母k或K可表示千字节，加上m或M表示可表示兆字节，g或G可表示千兆字节。例如：-Xmx1200m -Xmx1000m。 | 不适用 | -Xmx1200m |
| -OLTPVersionOldST | 用于用户配置老版本的OLTP版本，用户可以通过登录gsql，运行SELECT VERSION()，将获取到的版本号更新ini文件中的 OLTPVersionOldST参数值。 | - | Data |
| -OLTPVersionNewST | 用于用户配置新版本的OLTP版本，用户可以通过登录gsql，运行SELECT VERSION()，将获取到的版本号更新ini文件中的 OLTPVersionNewST参数 值。 | - | - |
| -testability | 开启可测试性需求特性。在该版本中，该功能启用后：● 用户可使用“Ctrl+空格”快捷键复制近触发的自动建议操作。● 在选择了“包含 ANALYZE结果”的场景下，“执行计划和开销”将以树形样式和图形化样式展示。该参数默认不可用，需手动添加。 | True/False | False |
| -Duser.language | 定义Data Studio的语言设置。在语言设置更改后添加此参数。 | zh/en | 不适用 |
| -Duser.country | 定义Data Studio的国家/地区设置。在语言设置更改后添加此参数。 | CN/IN | 不适用 |
| Dorg.osgi.framew ork.bundle.parent =ext | 指定boot delegation使用 的类加载器。 | boot/app/ext | boot |
| Dosgi.framework. extensions=org.e clipse.fx.osgi | 指定框架扩展名称列表。框架扩展bundle是系统bundle（org.eclipse.osgi）的fragment。作为fragment，用户可以提供使用该框架的其他类。 | 不适用 | 不适用 |
配置白名单
如果不是本机连接，需要配置远程连接ip地址。
配置pg_hba.conf文件，允许用户通过本地的Windows操作系统机器连接数据库。
以操作系统用户omm登录集群任一主机以操作系统用户omm登录MPPDB服务所在的任一节点。执行source ${BIGDATA_HOME}/mppdb/.mppdbgs_profile命令启动环境变量。
设置允许用户通过本地的Windows操作系统机器连接数据库服务器。 例如，允许“jack”用户以“ 192.168.1.1 ”IP地址的客户端远程连接数据库。
gs_guc set -Z coordinator -N all -I all -h "host all jack 192.168.1.1/32 sha256"
- -Z coordinator表示实例类型为coordinator。、
- -N all表示集群的所有主机。
- -I all表示主机中的所有实例。
- -h表示指定需要在“pg_hba.conf”增加的语句。
- host all表示允许客户端连接到数据库集群中任意一个CN所在的主机。
- jack表示访问数据库的用户。您可以使用如下命令提前创建“jack”用户。
CREATE USER jack PASSWORD ' Gaussdba@Mpp '; - 192.168.1.1/32表示允许IP地址为192.168.1.1的主机连接。请将IP地址更改为本地Windows主机的的IP地址。在使用过程中，请根据用户的网络进行配置修改。例如：设为192.168.1.1/32表示为特定主机添加连接数据库的权限；设为192.168.1.0/24，192.168.0.0/16，或192.0.0.0/8表示为特定网段的所有主机添加连接数据库的权限。
- sha256表示连接时jack用户的密码使用sha256算法加密。
配置支持调试 PL/SQL函数
- 以操作系统用户omm登录GaussDB AElkDWS集群任一主机。执行source ${BIGDATA_HOME}/mppdb/.mppdbgs_profile命令启动环境变量。
- 配置postgresql.conf文件，支持调试PL/SQL函数。
gs_guc set -Z coordinator -N all -c "shared_preload_libraries = '\$libdir/plugin_debugger'" -I all - 请重启集群，使配置生效。
gs_om -t stop && gs_om -t start
