安装配置Data Studio
本节介绍使用Data Studio时要遵循的安装和配置步骤，以及配置服务器以调试PL/SQL函数的步骤。
安装前准备
登录GaussDB(DWS) 管理控制台，在“连接管理”界面下载Data Studio软件包。
安装Data Studio
解压安装包后即可运行Data Studio。
执行以下步骤安装Data Studio：
- 解压所需软件包（32位或64位），分别放至Program Files或Program Files（x86）文件夹中。如果用户需用其他文件夹，管理员应控制用户对该文件夹的访问权限。
解压后可以获取如下文件和文件夹：
- 定位并双击Data Studio.exe，启动Data Studio客户端。
要创建新的数据库连接，请参见添加连接。
配置Data Studio
通过Data Studio.ini文件来配置Data Studio：
参数如有修改，需重新启动Data Studio方可查看。配置文件中添加的无效参数会被Data Studio忽略。如下描述的所有参数为可选参数。
下表为Data Studio相关的配置参数列表。
|
参数 |
说明 |
取值范围 |
默认值 |
|---|---|---|---|
|
-startup |
加载Data Studio所需的.jar文件。各版本所需的文件不同。 |
不适用 |
plugins/org.eclipse.equinox.launcher_1.3.100.v20150511-1540.jar |
|
--launcher.library |
加载Data Studio所需的库。各版本所需的库不同。 |
不适用 |
取决于所使用安装包，可能为plugins/org.eclipse.equinox.launcher.win32.win32.x86_1.1.300.v20150602-1417或plugins/org.eclipse.equinox.launcher.win32.win32.x86_64_1.1.300.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 |
虚拟机参数的起始位置。
说明：
-vmargs参数必须配置于配置文件的末尾。 |
不适用 |
不适用 |
|
-vm |
定义文件名（javaw.exe）和Java的相对路径。 |
不适用 |
不适用 |
|
-Dosgi.requiredJavaVersion |
运行Data Studio所需的最低Java版本。请勿修改该参数值。 |
不适用 |
1.5
说明：
推荐的Java版本为1.8。 |
|
-Xms |
Data Studio消耗的初始堆空间。该值必须是1024的倍数，大于40 MB，且小于或等于-Xmx。在值的末尾加上字母k或K可表示千字节，加上m或M表示可表示兆字节，g或G可表示千兆字节。例如： -Xms40m -Xms120m 有关详情，请参见Java文档。 |
不适用 |
-Xms40m |
|
-Xmx |
Data Studio消耗的最大堆空间。可根据可用的RAM空间调整该值。在值的末尾加上字母k或K可表示千字节，加上m或M表示可表示兆字节，g或G可表示千兆字节。例如： -Xmx1200m -Xmx1000m 有关详情，请参见Java文档。 |
不适用 |
-Xmx1200m |
|
-OLTPVersionOldST |
用于用户配置老版本的OLTP版本，用户可以通过登录gsql，运行SELECT VERSION()，将获取到的版本号更新ini文件中的OLTPVersionOldST参数值。 |
- |
- |
|
-OLTPVersionNewST |
用于用户配置新版本的OLTP版本，用户可以通过登录gsql，运行SELECT VERSION()，将获取到的版本号更新ini文件中的OLTPVersionNewST参数值。 |
- |
- |
|
-testability |
开启可测试性需求特性。在该版本中，该功能启用后：
该参数默认不可用，需手动添加。 |
True/False |
False |
|
-Duser.language |
定义Data Studio的语言设置。在语言设置更改后添加此参数。 |
zh/en |
不适用 |
|
-Duser.country |
定义Data Studio的国家/地区设置。在语言设置更改后添加此参数。 |
CN/IN |
不适用 |
|
-Dorg.osgi.framework.bundle.parent=ext |
指定boot delegation使用的类加载器。 |
boot/app/ext |
boot |
|
-Dosgi.framework.extensions=org.eclipse.fx.osgi |
指定框架扩展名称列表。框架扩展bundle是系统bundle（org.eclipse.osgi）的fragment。用户可以使用该框架的其他类。 |
不适用 |
不适用 |
- 如果用户收到SocketException : Bad Address: Connect消息：
则用户需检查客户端是否通过IPv6或IPv4协议建立到服务器的连接。用户还可以根据通过在.ini文件中配置以下参数来建立连接：
-Djava.net.preferIPv4Stack=true
-Djava.net.preferIPv6Stack=false
表2列举支持的通信场景。
第一行和第一列分别代表尝试通信的不同节点类型，x表示相关节点可以互相通信。
设置日志文件创建位置
- 打开Data Studio.ini文件。
- 用-logfolder指定日志文件路径。
例如：
-logfolder=c:\test1
示例中，Data Studio.log文件创建在c:\test1\用户名\logs路径下。
如果用户没有Data Studio.ini文件中指定路径的访问权限，则Data Studio会关闭，并弹框显示以下信息。
出现以下情况时，Data Studio.log文件在Data Studio\User Data\用户名\logs文件夹中创建：
有关服务器日志详情，请参见服务器手册。
可使用任何文本编辑器打开并查看Data Studio.log文件。
记录故障日志
配置-detailLogging参数，控制是否将错误、异常或者throwable的堆栈运行详情记录在日志文件中
-detailLogging=false
如果标志值为‘true’，错误、异常或者throw-able的堆栈运行详情将记录在日志文件中。
如果标志值为‘false’，错误、异常或者throw-able的堆栈运行详情将不会记录在日志文件中。
日志消息描述
日志消息描述如下图所示：
Data Studio.log文件大小达到最大值10000 KB时，系统会自动创建一个文件并另存为Data Studio.log.1。Data Studio.log中的日志将存储在Data Studio.log.1文件中。当Data Studio.log文件再次达到最大值，系统继续自动创建一个文件并另存为Data Studio.log.2。最新日志持续写入Data Studio.log文件。以此类推，此过程将一直持续，直到Data Studio.log.5文件达到最大值，该循环重新开始。Data Studio将删除最早的日志文件，即Data Studio.log.1。例如，Data Studio.log.5重命名为Data Studio.log.4，Data Studio.log.4重命名为Data Studio.log.3，以此类推。
如需启用服务器日志文件的性能日志记录功能，需启用配置参数log_min_messages，且设置为data/postgresql.conf配置文件中的debug1，即log_min_messages = debug1。
不同日志级别类型
Data Studio.log文件中所显示的不同类型的日志级别如下：
- TRACE：相比DEBUG级别，TRACE级别提供更为详细的信息。
- DEBUG：DEBUG级别指粒状信息事件，对调试应用程序最为有用。
- INFO：INFO级别指着重显示应用进程的消息。
- WARN：WARN级别指潜在的有害情况。
- ERROR：ERROR级别指错误事件。
- FATAL：FATAL级别指事件造成应用终止。
- ALL：ALL级别指启用所有日志级别。
- OFF：OFF级别指禁用所有日志级别和ALL级别相反。
- 如果用户输入无效的日志级别值，日志级别会设置为WARN。
- 如果用户未指定日志级别，日志级别会设置为WARN。
日志记录会输出高于或等于其日志级别的所有消息。
标准log4j级别的顺序如下：
|
- |
FATAL |
ERROR |
WARN |
INFO |
DEBUG |
TRACE |
|---|---|---|---|---|---|---|
|
OFF |
x |
x |
x |
x |
x |
x |
|
FATAL |
√ |
x |
x |
x |
x |
x |
|
ERROR |
√ |
√ |
x |
x |
x |
x |
|
WARN |
√ |
√ |
√ |
x |
x |
x |
|
INFO |
√ |
√ |
√ |
√ |
x |
x |
|
DEBUG |
√ |
√ |
√ |
√ |
√ |
x |
|
TRACE |
√ |
√ |
√ |
√ |
√ |
√ |
|
ALL |
√ |
√ |
√ |
√ |
√ |
√ |
|
√ - 创建日志文件 x- 不创建日志文件 |
||||||
