安装配置和启动GDS_数据仓库服务 GaussDB(DWS)_工具指南_GDS并行数据加载工具_华为云

(1)

工具指南

文档版本 02

发布日期 2022-01-20

(2)

非经本公司书面许可，任何单位和个人不得擅自摘抄、复制本文档内容的部分或全部，并不得以任何形式传播。

商标声明

和其他华为商标均为华为技术有限公司的商标。

本文档提及的其他所有商标或注册商标，由各自的所有人拥有。

注意

您购买的产品、服务或特性等应受华为公司商业合同和条款的约束，本文档中描述的全部或部分产品、服务或特性可能不在您的购买或使用范围之内。除非合同另有约定，华为公司对本文档内容不做任何明示或暗示的声明或保证。

由于产品版本升级或其他原因，本文档内容会不定期进行更新。除非另有约定，本文档仅作为使用指导，本文档中的所有陈述、信息和建议不构成任何明示或暗示的担保。

(3)

1 ^工具简介

本手册介绍数据仓库服务的工具使用，工具简介及版本配套关系如表1-1所示。

表1-1 工具简介

工具名称工具简介

gsql 一款运行在Linux操作系统的命令行工具，用于连接DWS集群中的数据库，并对数据库进行操作和维护。

Data Studio 用于连接数据库的客户端工具，有着丰富的GUI界面，能够管理数据库和数据库对象，编辑、运行、调试SQL脚本，查看执行计划等。Data Studio工具可运行在32位或64位windows操作系统上，解压软件包后免安装即可使用。

GDS 一款运行在Linux操作系统的命令行工具，通过和外表机制的配合，实现数据的高速导入导出。GDS工具包需要安装在数据源文件所在的服务器上，数据源文件所在的服务器称为数据服务器，

也叫GDS服务器。

DSC 用于将Teradata或Oracle数据库中的sql脚本迁移为适用于 GaussDB(DWS)的sql脚本，便于在GaussDB(DWS)中重建数据库。DSC工具是运行在Linux操作系统的命令行工具，解压软件包免安装即可使用。

(12)

2 ^工具下载

步骤1 登录GaussDB(DWS) 管理控制台。

通过访问以下地址登录GaussDB(DWS) 管理控制台：https://

console.huaweicloud.com/dws。

步骤2 在左侧导航栏中，单击“连接管理”。

步骤3 在“下载客户端和驱动”区域，请根据计算机的操作系统，选择对应版本的工具进行下载。

此处可以下载以下工具：

● gsql命令行客户端：gsql工具包中包含了gsql客户端工具、GDS并行数据加载工具以及gs_dump、gs_dumpall和gs_restore工具。

● Data Studio图形界面客户端

● DSC迁移工具

对于gsql客户端工具、Data Studio客户端工具，存在多个历史版本，单击“历史版本”可根据集群版本下载相应版本的工具。GaussDB(DWS) 集群可向下兼容gsql、

Data Studio工具，建议按集群版本下载配套的工具版本。

图2-1 下载客户端

----结束

(13)

3 gsql 命令行客户端工具

3.1 gsql 概述

基本功能

● 连接数据库：通过gsql客户端远程连接GaussDB(DWS)数据库。

说明

gsql创建连接时，会有5分钟超时时间。如果在这个时间内，数据库未正确地接受连接并对身份进行认证，gsql将超时退出。

针对此问题，可以参考常见问题处理。

● 执行SQL语句：支持交互式地键入并执行SQL语句，也可以执行一个文件中指定的 SQL语句。

● 执行元命令：元命令可以帮助管理员查看数据库对象的信息、查询缓存区信息、

格式化SQL输出结果，以及连接到新的数据库等。元命令的详细说明请参见元命令参考。

高级特性

gsql的高级特性如表3-1所示。

(14)

表3-1 gsql 高级特性 特性名称描述

变量 gsql提供类似于Linux的shell命令的变量特性，可以使用gsql的元命令

\set设置一个变量，格式如下：

\set varname value

要删除一个变量请使用如下方式：

\unset varname 说明

● 变量只是简单的名称/值对，值的长度由特殊变量VAR_MAX_LENGTH决定，

详细参见表3-2。

● 变量名称必须由字母（包括非拉丁字母）、数字和下划线组成，且对大小写敏感。

● 如果使用\set varname的格式（不带第二个参数），则只是设置这个变量而没有给变量赋值。

● 可以使用不带参数的\set来显示所有变量的值。

变量的示例和详细说明请参见变量。

SQL代换利用gsql的变量特性，可以将常用的SQL语句设置为变量，以简化操作。

SQL代换的示例和详细说明请参见SQL代换。

自定义提示

符 gsql使用的提示符支持用户自定义。可以通过修改gsql预留的三个变量 PROMPT1、PROMPT2、PROMPT3来改变提示符。

这三个变量的值可以用户自定义，也可以使用gsql预定义的值。详细请参见提示符。

客户端操作历史记录

gsql支持客户端操作历史记录，当客户端连接时指定“-r”参数，此功能被打开。可以通过\set设置记录历史的条数，例如，\set HISTSIZE 50，将记录历史的条数设置为50，\set HISTSIZE 0，不记录历史。

说明

● 客户端操作历史记录条数默认设置为32条，最多支持记录500条。当客户端交互式输入包含中文字符时，只支持UTF-8 的编码环境。

● 出于安全考虑，将包含PASSWORD、IDENTIFIED敏感词的记录识别为敏感信息，不会记录到历史信息中，即不能通过上下翻回显。

● 变量

可以使用gsql元命令\set设置一个变量。例如把变量foo的值设置为bar：

\set foo bar

要引用变量的值，在变量前面加冒号。例如查看变量的值：

\echo :foo bar

这种变量的引用方法适用于规则的SQL语句和元命令。

在使用命令行参数--dynamic-param（详见表3-7），或设置特殊变量

DYNAMIC_PARAM_ENABLE（详见表3-2）为true时，可通过执行SQL语句设置变量。变量名为SQL执行结果的列名，也可使用${}方式引用。例如：

\set DYNAMIC_PARAM_ENABLE true SELECT 'Jack' AS "Name";

Name ---

(15)

Jack (1 row)

\echo ${Name}

Jack

上述示例中，通过SELECT语句执行设置Name变量，并在后面使用${}的引用方式获得变量Name的值。示例中通过特殊变量DYNAMIC_PARAM_ENABLE控制这一功能，也可通过命令行参数--dynamic-param控制，如gsql -d postgres -p 25308 --dynamic-param -r。

说明

● SQL执行失败时，不设置变量。

● SQL执行结果为空，以列名设置变量，赋值空字符串。

● SQL执行结果为一条记录，以列名设置变量，赋值对应字符串。

● SQL执行结果为多条记录，以列名设置变量，使用特定字符串拼接，然后赋值。特定字符串由特殊变量RESULT_DELIMITER（详见表3-2）控制，默认为“,”。

执行SQL语句设置变量示例：

\set DYNAMIC_PARAM_ENABLE true

CREATE TABLE student (id INT, name VARCHAR(32)) DISTRIBUTE BY HASH(id);

CREATE TABLE

INSERT INTO student VALUES (1, 'Jack'), (2, 'Tom'), (3, 'Jerry');

INSERT 0 3

-- 执行失败时，不设置变量

SELECT id, name FROM student ORDER BY idi;

ERROR: column "idi" does not exist

LINE 1: SELECT id, name FROM student ORDER BY idi;

^

\echo ${id} ${name}

${id} ${name}

-- 执行结果为多条记录时，使用特定字符串拼接 SELECT id, name FROM student ORDER BY id;

id | name ----+--- 1 | Jack 2 | Tom 3 | Jerry (3 rows)

\echo ${id} ${name}

1,2,3 Jack,Tom,Jerry -- 执行结果为一条记录时

SELECT id, name FROM student where id = 1;

id | name ----+--- 1 | Jack (1 row)

\echo ${id} ${name}

1 Jack

-- 执行结果为空时，赋值空字符串

SELECT id, name FROM student where id = 4;

id | name ----+--- (0 rows)

\echo ${id} ${name}

gsql预定义了一些特殊变量，同时也规划了变量的取值。为了保证和后续版本最大限度地兼容，请避免以其他目的使用这些变量。所有特殊变量见表3-2。

(16)

说明

● 所有特殊变量都由大写字母、数字和下划线组成。

● 要查看特殊变量的默认值，请使用元命令\echo :varname（例如\echo :DBNAME）。

表3-2 特殊变量设置

变量设置方法变量说明

DBNAME \set DBNAME dbname 当前连接的数据库的名字。每次连接数据库时都会被重新设置。

ECHO \set ECHO all | queries ● 如果设置为all，只显示查询信息。设置

为all等效于使用gsql连接数据库时指定-a参数。

● 如果设置为queries，显示命令行和查询信息。等效于使用gsql连接数据库时指定-e参数。

ECHO_HIDD EN

\set ECHO_HIDDEN

on | off | noexec 当使用元命令查询数据库信息（例如\dg）

时，此变量的取值决定了查询的行为：

● 设置为on，先显示元命令实际调用的查询语句，然后显示查询结果。等效于使用gsql连接数据库时指定-E参数。

● 设置为off，则只显示查询结果。

● 设置为noexec，则只显示查询信息，不执行查询操作。

ENCODING \set ENCODING

encoding 当前客户端的字符集编码。

FETCH_COU NT

\set FETCH_COUNT

variable ● 如果该变量的值为大于0的整数，假设

为n，则执行SELECT语句时每次从结果集中取n行到缓存并显示到屏幕。

● 如果不设置此变量，或设置的值小于等于0，则执行SELECT语句时一次性把结果都取到缓存。

说明

设置合理的变量值，将减少内存使用量。一般来说，设为100到1000之间的值比较合理。

HISTCONTR OL

\set HISTCONTROL ignorespace | ignoredups | ignoreboth | none

● ignorespace：以空格开始的行将不会写入历史列表。

● ignoredups：与以前历史记录里匹配的行不会写入历史记录。

● ignoreboth、none或者其他值：所有以交互模式读入的行都被保存到历史列表。

说明none表示不设置HISTCONTROL。

(17)

变量设置方法变量说明

HISTFILE \set HISTFILE filename 此文件用于存储历史名列表。缺省值是

~/.bash_history。

HISTSIZE \set HISTSIZE size 保存在历史命令里命令的个数。缺省值是 500。

HOST \set HOST hostname 已连接的数据库主机名称。

IGNOREEOF \set IGNOREEOF

variable ● 若设置此变量为数值，假设为10，则在

gsql中输入的前9次EOF字符（通常是 Ctrl+C组合键）都会被忽略，在第10次按Ctrl+C才能退出gsql程序。

● 若设置此变量为非数值，则缺省为10。

● 若删除此变量，则向交互的gsql会话发送一个EOF终止应用。

LASTOID \set LASTOID oid 最后影响的oid值，即为从一条INSERT或 lo_import命令返回的值。此变量只保证在下一条SQL语句的结果显示之前有效。

ON_ERROR_

ROLLBACK

\set

ON_ERROR_ROLLBAC K on | interactive | off

● 如果是on，当一个事务块里的语句产生错误的时候，这个错误将被忽略而事务继续。

● 如果是interactive，这样的错误只是在交互的会话里忽略。

● 如果是off（缺省），事务块里一个语句生成的错误将会回滚整个事务。

on_error_rollback-on模式是通过在一个事务块的每个命令前隐含地发出一个 SAVEPOINT的方式工作的，在发生错误的时候回滚到该事务块。

ON_ERROR_

STOP

\set ON_ERROR_STOP

on | off ● on：命令执行错误时会立即停止，在交

互模式下，gsql会立即返回已执行命令的结果。

● off（缺省）：命令执行错误时将会跳过错误继续执行。

PORT \set PORT port 正连接数据库的端口号。

USER \set USER username 当前用于连接的数据库用户。

(18)

变量设置方法变量说明 VERBOSITY \set VERBOSITY

terse | default | verbose

这个选项可以设置为值terse、default、

verbose之一以控制错误报告的冗余行。

● terse：仅返回严重且主要的错误文本以及文本位置（一般适合于单行错误信息）。

● default：返回严重且主要的错误文本及其位置，还包括详细的错误细节、错误提示（可能会跨越多行）。

● verbose：返回所有的错误信息。

VAR_NOT_F OUND

\set

VAR_NOT_FOUND default | null | error

可以设置为default、null、error之一以控制引用变量不存在时的处理方式。

● default：不做变量替换，保持原有字符串。

● null：将原有字符串替换为空字符串。

● error：输出报错信息，保持原有字符串。

VAR_MAX_LE NGTH

\set

VAR_MAX_LENGTH variable

用于控制变量值的长度，默认为4096。如果变量值的长度超过该值，变量值会被截断，并输出告警信息。

ERROR_LEVE L

\set ERROR transaction | statement

表示ERROR标识成功或者失败类型，取值为transaction或statement，默认为 transaction。

● statement：ERROR记录上一条SQL语句是否执行成功。

● transaction：ERROR记录上一条SQL语句是否执行成功，或上一个事务内部执行是否出错。

ERROR \set ERROR true | false 表示上一条SQL语句执行成功或失败，或上一个事务内部执行是否出错，成功取值 false，失败取值true，默认为false。执行 SQL语句更新，不建议手动设置。

LAST_ERROR _SQLSTATE

\set

LAST_ERROR_SQLSTA TE state

表示上一条执行失败的SQL语句的错误状态码，默认为‘00000’。执行SQL语句更新，不建议手动设置。

LAST_ERROR _MESSAGE

\set

LAST_ERROR_MESSAG E message

表示上一条执行失败的SQL语句的错误信息，默认为空字符串。执行SQL语句更新，不建议手动设置。

(19)

变量设置方法变量说明 ROW_COUN

T

\set ROW_COUNT

count ● ERROR_LEVEL为statement时，表示上

一条SQL语句执行返回的行数或受影响的行数。

● ERROR_LEVEL为transaction时，如果事务结束时内部有错，表示事务内最后一个SQL语句执行返回的行数或受影响的行数，否则表示上一条SQL语句执行返回的行数或受影响的行数。

如果SQL语句执行失败设置为0，默认为 0。执行SQL语句更新，不建议手动设置。

SQLSTATE \set SQLSTATE state ● ERROR_LEVEL为statement时，表示上一条SQL语句执行的状态码。

● ERROR_LEVEL为transaction时，如果事务结束时内部有错，表示事务内最后一个SQL语句执行的状态码，否则表示上一条SQL语句执行的状态码。

默认为‘00000’。执行SQL语句更新，不建议手动设置。

LAST_SYS_C ODE

\set LAST_SYS_CODE

code 表示上一条系统命令执行的返回值，默认为0。使用元命令\!调用系统命令更新，不建议手动设置。

DYNAMIC_P ARAM_ENAB LE

\set

DYNAMIC_PARAM_EN ABLE true | false

用于控制执行SQL语句生成变量和${}变量引用方式，默认为fasle。

● true：执行SQL语句生成变量，支持${}

变量引用方式。

● false：执行SQL语句不生成变量，不支持${}变量引用方式。

RESULT_DELI MITER

\set

RESULT_DELIMITER delimiter

执行SQL语句生成变量时，多条记录之间的拼接使用该参数控制，默认为“,”。

(20)

变量设置方法变量说明 COMPARE_S

TRATEGY

\set

COMPARE_STRATEGY default | natural | equal

用于控制\if表达式中大小比较的策略，默认为default。

● default：默认的比较策略，只支持字符串或数字比较，不支持混合比较。单引号内的按照字符串处理，单引号外的按照数字处理。

● natural：在default的基础上，包含动态变量的按照字符串处理。当比较操作符有一侧是数字，尝试将另一侧转换为数字，然后比较。如果转换失败，报错且比较结果为假。

● equal：只支持等值比较，所有情况按照字符串比较。

详细说明和使用示例请参考\if条件块比较规则说明与示例。

COMMAND_

ERROR_STOP

\set

COMMAND_ERROR_S TOP on | off

用于控制元命令执行错误时是否报错退出，默认不退出。

使用示例请参考

COMMAND_ERROR_STOP使用示例。

– 特殊变量ERROR_LEVEL和ERROR使用示例：

当ERROR_LEVEL为statement时，ERROR只记录上一条SQL语句是否执行成功。

示例如下，当事务中出现SQL执行报错，事务结束时，ERROR值为false。此时的 ERROR只记录上一个SQL语句end是否执行成功。

\set ERROR_LEVEL statement begin;

BEGIN select 1 as ;

ERROR: syntax error at or near ";"

LINE 1: select 1 as ; ^ end;ROLLBACK

\echo :ERROR false

当ERROR_LEVEL为transaction时，ERROR可以捕获事务内的SQL执行错误。示例如下，事务中出现SQL执行报错，事务结束时，ERROR值为true。

\set ERROR_LEVEL transaction begin;

BEGIN select 1 as ;

ERROR: syntax error at or near ";"

LINE 1: select 1 as ; ^ end;ROLLBACK

\echo :ERROR true

– 特殊变量COMMAND_ERROR_STOP使用示例：

当COMMAND_ERROR_STOP为on时，元命令执行错误时，报错退出。开启时能有效的识别到元命令的执行错误。

(21)

当COMMAND_ERROR_STOP为off时，元命令执行错误时，打印相关信息不退出，脚本继续执行。

\set COMMAND_ERROR_STOP on

\i /home/omm/copy_data.sql select id, name from student;

如上脚本中COMMAND_ERROR_STOP设置为on，元命令报错之后输出错误信息，脚本不再执行。

gsql:test.sql:2: /home/omm/copy_data.sql: Not a directory

如果COMMAND_ERROR_STOP设置为off，元命令报错之后输出错误信息，继续执行SELECT语句。

gsql:test.sql:2: /home/omm/copy_data.sql: Not a directory id | name

----+--- 1 | Jack (1 row)

● SQL代换

像元命令的参数一样，gsql变量的一个关键特性是可以把gsql变量替换成正规的 SQL语句。此外，gsql还提供为变量更换新的别名或其他标识符等功能。使用SQL 代换方式替换一个变量的值可在变量前加冒号。例如：

\set foo 'HR.areaS' select * from :foo;

area_id | area_name ---+--- 4 | Iron

3 | Desert 1 | Wood 2 | Lake (4 rows)

执行以上命令，将会查询HR.areaS表。

须知

变量的值是逐字复制的，甚至可以包含不对称的引号或反斜杠命令。所以必须保证输入的内容有意义。

● 提示符

通过表3-3的三个变量可以设置gsql的提示符，这些变量是由字符和特殊的转义字符所组成。

表3-3 提示符变量

变量描述示例

PROMPT1 gsql请求一个新命令时使用的正常提示符。

PROMPT1的默认值为：

%/%R%#

使用变量PROMPT1切换提示符：

● 提示符变为[local]：

\set PROMPT1 %M

[local:/tmp/gaussdba_mppdb]

● 提示符变为name：

\set PROMPT1 name name

● 提示符变为=：

\set PROMPT1 %R

=

(22)

变量描述示例 PROMPT2 在一个命令输入期待更多

输入时（例如，查询没有用一个分号结束或者引号不完整）显示的提示符。

使用变量PROMPT2显示提示符：

\set PROMPT2 TEST select * from HR.areaS TEST;

area_id | area_name ---+--- 1 | Wood

2 | Lake 4 | Iron 3 | Desert (4 rows))

PROMPT3 当执行COPY命令，并期望在终端输入数据时（例如，COPY FROM

STDIN），显示提示符。

使用变量PROMPT3显示COPY提示符：

\set PROMPT3 '>>>>' copy HR.areaS from STDIN;

Enter data to be copied followed by a newline.

End with a backslash and a period on a line by itself.

>>>>1 aa

>>>>2 bb

>>>>\.

提示符变量的值是按实际字符显示的，但是，当设置提示符的命令中出现“%”

时，变量的值根据“%”后的字符，替换为已定义的内容，已定义的提示符请参见表3-4。

表3-4 已定义的替换

符号符号说明

%M 主机的全名（包含域名），若连接是通过Unix域套接字进行的，

则全名为[local]，若Unix域套接字不是编译的缺省位置，就是 [local:/dir/name]。

%m 主机名删去第一个点后面的部分。若通过Unix域套接字连接，则为[local]。

%> 主机正在侦听的端口号。

%n 数据库会话的用户名。

%/ 当前数据库名称。

%~ 类似 %/，如果数据库是缺省数据库时输出的是波浪线~。

%# 如果会话用户是数据库系统管理员，使用#，否则用>。

%R ● 对于PROMPT1通常是“=”，如果是单行模式则是“^”，如果会话与数据库断开（如果\connect失败可能发生）则是

“!”。

● 对于PROMPT2该序列被“ -”、“ *”、单引号、双引号或

“$”(取决于gsql是否等待更多的输入：查询没有终止、正在一个 /* ... */ 注释里、正在引号或者美元符扩展里)代替。

(23)

符号符号说明

%x 事务状态：

● 如果不在事务块里，则是一个空字符串。

● 如果在事务块里，则是“*”。

● 如果在一个失败的事务块里则是“!”。

● 如果无法判断事务状态时为“?”（比如没有连接）。

%digits 指定字节值的字符将被替换到该位置。

%:name gsql变量“name”的值。

%comma

nd command的输出，类似于使用“^”替换。

%[ . . . %] 提示可以包含终端控制字符，这些字符可以改变颜色、背景、提示文本的风格、终端窗口的标题。例如，

potgres=> \set PROMPT1 '%[%033[1;33;40m%]%n@%/%R%

[%033[0m%]%#'

这个句式的结果是在VT100兼容的可显示彩色的终端上的一个宽体

（1;）黑底黄字（33;40）。

环境变量

表3-5 与 gsql 相关的环境变量

名称描述

COLUMNS 如果\set columns为0，则由此参数控制wrapped格式的宽度。这个宽度用于决定在自动扩展的模式下，是否要把宽输出模式变成竖线的格式。

PAGER 如果查询结果无法在一页显示，它们就会被重定向到这个命令。可以用\pset命令关闭分页器。典型的是用命令more 或less来实现逐页查看。缺省值是平台相关的。

说明less的文本显示，受系统环境变量LC_CTYPE影响。

PSQL_EDITOR \e和\ef命令使用环境变量指定的编辑器。变量是按照列出的先后顺序检查的。在Unix系统上默认的编辑工具是vi。

EDITOR VISUAL

PSQL_EDITOR_LINEN

UMBER_ARG 当\e和\ef带上一行数字参数使用时，这个变量指定的命令行参数用于向编辑器传递起始行数。像Emacs或vi这样的编辑器，这只是个加号。如果选项和行号之间需要空白，在变量的值后加一个空格。例如：

PSQL_EDITOR_LINENUMBER_ARG = '+' PSQL_EDITOR_LINENUMBER_ARG='--line '

Unix系统默认的是+。

(24)

名称描述

PSQLRC 用户的.gsqlrc文件的交互位置。

SHELL 使用\!命令跟shell执行的命令是一样的效果。

TMPDIR 存储临时文件的目录。缺省是/tmp。

3.2 使用指导

下载安装 gsql 并使用 gsql 连接集群数据库

关于gsql的下载、安装以及连接集群数据库的具体操作，请参见《数据仓库服务管理指南》中的使用gsql命令行客户端连接集群。

示例

以把一个查询分成多行输入为例。注意提示符的变化：

postgres=# CREATE TABLE HR.areaS(

postgres(# area_ID NUMBER, postgres(# area_NAME VARCHAR2(25) postgres-# )tablespace EXAMPLE;

CREATE TABLE

查看表的定义：

\d HR.areaS

Table "hr.areas"

向HR.areaS表插入四行数据：

INSERT INTO HR.areaS (area_ID, area_NAME) VALUES (1, 'Wood');

INSERT 0 1

INSERT INTO HR.areaS (area_ID, area_NAME) VALUES (2, 'Lake');

INSERT 0 1

INSERT INTO HR.areaS (area_ID, area_NAME) VALUES (3, 'Desert');

INSERT 0 1

INSERT INTO HR.areaS (area_ID, area_NAME) VALUES (4, 'Iron');

INSERT 0 1

切换提示符：

\set PROMPT1 '%n@%m %~%R%#' dbadmin@[local] postgres=#

查看表：

dbadmin@[local] postgres=#SELECT * FROM HR.areaS;

area_id | area_name ---+--- 1 | Wood

4 | Iron 2 | Lake 3 | Desert (4 rows)

可以用\pset命令以不同的方法显示表：

(25)

dbadmin@[local] postgres=#\pset border 2 Border style is 2.

+---+---+

| area_id | area_name | +---+---+

| 1 | Wood |

| 2 | Lake |

| 3 | Desert |

| 4 | Iron |

+---+---+

(4 rows)

dbadmin@[local] postgres=#\pset border 0 Border style is 0.

area_id area_name --- --- 1 Wood

2 Lake 3 Desert 4 Iron (4 rows)

使用元命令：

dbadmin@[local] postgres=#\a \t \x Output format is unaligned.

Showing only tuples.

Expanded display is on.

dbadmin@[local] postgres=#

3.3 获取帮助

操作步骤

● 连接数据库时，可以使用如下命令获取帮助信息。

gsql --help

显示如下帮助信息：

...

Usage:

gsql [OPTION]... [DBNAME [USERNAME]]

General options:

-c, --command=COMMAND run only single command (SQL or internal) and exit -d, --dbname=DBNAME database name to connect to (default: "postgres") -f, --file=FILENAME execute commands from file, then exit

...

● 连接到数据库后，可以使用如下命令获取帮助信息。

help

显示如下帮助信息：

You are using gsql, the command-line interface to gaussdb.

Type: \copyright for distribution terms

(26)

\h for help with SQL commands \? for help with gsql commands

\g or terminate with semicolon to execute query \q to quit

任务示例

步骤1 查看gsql的帮助信息。具体执行命令请参见表3-6。

表3-6 使用 gsql 联机帮助

描述示例

查看版权信息 \copyright 查看GaussDB(DWS)支

持的SQL语句的帮助查看GaussDB(DWS)支持的SQL语句的帮助例如，查看GaussDB(DWS)支持的所有SQL语句：

\hAvailable help:

ABORT ALTER DATABAE

ALTER DATA SOURCE ... ...

例如，查看CREATE DATABASE命令的参数可使用下面的命令：\help CREATE DATABASE

Command: CREATE DATABASE Description: create a new database Syntax:

CREATE DATABASE database_name [ [ WITH ] {[ OWNER [=] user_name ]|

[ TEMPLATE [=] template ]|

[ ENCODING [=] encoding ]|

[ LC_COLLATE [=] lc_collate ]|

[ LC_CTYPE [=] lc_ctype ]|

[ DBCOMPATIBILITY [=] compatibility_type ]|

[ TABLESPACE [=] tablespace_name ]|

[ CONNECTION LIMIT [=] connlimit ]}[...] ];

查看gsql命令的帮助例如，查看gsql支持的命令：

\?General

\copyright show PostgreSQL usage and distribution terms \g [FILE] or ; execute query (and send results to file or |pipe) \h(\help) [NAME] help on syntax of SQL commands, * for all commands

\q quit gsql ... ...

----结束

3.4 命令参考

详细的gsql参数请参见表3-7、表3-8、表3-9和表3-10。

(27)

表3-7 常用参数

参数参数说明取值范围

-c, --

command=CO MMAND

声明gsql要执行一条字符串命令然后退出。 -

-C, --set-

file=FILENAME 使用文件作为命令源而不是交互式输入，

gsql处理完文件后不退出，继续处理其他内容。

绝对路径或相对路径，且满足操作系统路径命名规则。

-d, --

dbname=DBNA ME

指定想要连接的数据库名称。字符串。

-D, --dynamic-

param 用于控制执行SQL语句设置变量和${}变量引用方式，具体示例参见变量。

-

-f, --

file=FILENAME 使用文件作为命令源而不是交互式输入。

gsql将在处理完文件后结束。如果

FILENAME是-（连字符），则从标准输入读取。

-l, --list 列出所有可用的数据库，然后退出。 - -v, --set, --

variable=NAME

=VALUE

设置gsql变量NAME为VALUE。

变量的示例和详细说明请参见变量。

-

-X, --no-gsqlrc 不读取启动文件（系统范围的gsqlrc或者用户的~/.gsqlrc都不读取）。

说明启动文件默认为~/.gsqlrc，或通过PSQLRC环境变量指定。

-

-1 ("one"), -- single- transaction

当gsql使用-f选项执行脚本时，会在脚本的开头和结尾分别加上START

TRANSACTION/COMMIT用以把整个脚本当作一个事务执行。这将保证该脚本完全执行成功，或者脚本无效。

说明如果脚本中已经使用了START TRANSACTION，

COMMIT，ROLLBACK，则该选项无效。

-

-?, --help 显示关于gsql命令行参数的帮助信息然后退

出。 -

-V, --version 打印gsql版本信息然后退出。 -

(28)

表3-8 输入和输出参数

-a, --

echo-all 在读取行时向标准输出打印所有内容。

注意使用此参数可能会暴露部分SQL语句中的敏感信息，如创建用户语句中的password信息等，请谨慎使用。

-

-e, -- echo- queries

把所有发送给服务器的查询同时回显到标准输出。

-

-E, -- echo- hidden

回显由\d和其他反斜杠命令生成的实际查询。 -

-k, -- with- key=KEY

使用gsql对导入的加密文件进行解密。

须知对于本身就是shell命令中的关键字符如单引号（'）或双引号（"），Linux shell会检测输入的单引号（'）或双引号

（"）是否匹配。如果不匹配，shell认为用户没有输入完毕，会一直等待用户输入，从而不会进入到gsql程序。

-

-L, --log- file=FILE NAME

除了正常的输出源之外，把所有查询输出记录到文件FILENAME中。

注意

● 使用此参数可能会暴露部分SQL语句中的敏感信息，如创建用户语句中的password信息等，请谨慎使用。

● 此参数只保留查询结果到相应文件中，主要目标是为了查询结果能够更好更准确地被其他调用者（例如自动化运维脚本）解析；而不是保留gsql运行过程中的相关日志信息。

-m, -- maintena nce

允许在两阶段事务恢复期间连接集群。

说明

该选项是一个开发选项，禁止用户使用，只限专业技术人员使用，功能是：使用该选项时，gsql可以连接到备机，

用于校验主备机数据的一致性。

-

-n, --no-

libedit 关闭命令行编辑。 -

-o, -- output=FI LENAME

将所有查询输出重定向到文件FILENAME。绝对路径或相对路径，且满足操作系统路径命名规则。

-q, --

quiet 安静模式，执行时不会打印出额外信息。缺省时gsql将打印许多其他输出信息。

(29)

参数参数说明取值范围 -s, --

single- step

单步模式运行。意味着每个查询在发往服务器之前都要提示用户，用这个选项也可以取消执行。此选项主要用于调试脚本。

-

-S, -- single- line

单行运行模式，这时每个命令都将由换行符结束，

像分号那样。 -

表3-9 输出格式参数

-A, --no-

align 切换为非对齐输出模式。缺省为对齐

输出模式。

-F, --field- separator=S TRING

设置域分隔符（默认为“|”）。 -

-H, --html 打开HTML格式输出。 -

-P, -- pset=VAR[=

ARG]

在命令行上以\pset的风格设置打印选项。

说明

这里必须用等号而不是空格分隔名称和值。例如，把输出格式设置为LaTeX，可以键入-P format=latex

-

-R, --record- separator=S TRING

设置记录分隔符。 -

-r 开启客户端操作历史记录功能。缺省为关

闭。

-t, --tuples-

only 只打印行。 -

-T, --table-

attr=TEXT 允许声明放在HTML table标签里的选项。

使用时请搭配参数“-H,--html”，指定为HTML格式输出。

-

-x, --

expanded 打开扩展表格式模式。 -

-z, --field- separator- zero

设置非对齐输出模式的域分隔符为空。

使用时请搭配参数“-A, --no-align”，指定为非对齐输出模式。

-

(30)

参数参数说明取值范围 -0, --record-

separator- zero

设置非对齐输出模式的记录分隔符为空。

使用时请搭配参数“-A, --no-align”，指定为非对齐输出模式。

-

-g 显示所有SQL语句和指定文件的分隔符。

说明-g参数必须和-f参数一起设置。

-

表3-10 连接参数

-h, --

host=HOSTNAM E

指定正在运行服务器的主机名或者Unix域套接字的路径。

如果省略主机名，

gsql将通过Unix域套接字与本地主机的服务器相联，或者在没有Unix域套接字的机器上，通过TCP/IP与 localhost连接。

-p, --port=PORT 指定数据库服务器的端口号。

可以通过port参数修改默认端口号。

默认为8000。

-U, --

username=USER NAME

指定连接数据库的用户。

说明

● 通过该参数指定用户连接数据库时，需要同时提供用户密码用以身份验证。您可以通过交换方式输入密码，或者通过-W参数指定密码。

● 用户名中包含有字符$，需要在字符$前增加转义字符才可成功连接数据库。

字符串。默认使用与当前操作系统用户同名的用户。

-W, --

password=PASS WORD

当使用-U参数连接远端数据库时，可通过该选项指定密码。

说明用户密码中包含特殊字符“\”和"`"时，需要增加转义字符才可成功连接数据库。

如果用户未输入该参数，但是数据库连接需要用户密码，这时将出现交互式输入，请用户输入当前连接的密码。该密码最长长度为999字节，受限于GUC参数password max length的最大值。

符合密码复杂度要求。

3.5 元命令参考

介绍使用GaussDB(DWS)数据库命令行交互工具登录数据库后，gsql所提供的元命令。所谓元命令就是在gsql里输入的任何以不带引号的反斜杠开头的命令。

(31)

注意事项

● 一个gsql元命令的格式是反斜杠后面紧跟一个动词，然后是任意参数。参数命令动词和其他参数以任意个空白字符间隔。

● 要在参数里面包含空白，必须用单引号把它引起来。要在这样的参数里包含单引号，可以在前面加一个反斜杠。任何包含在单引号里的内容都会被进一步进行类似C语言的替换：\n（新行）、\t（制表符）、\b（退格）、\r（回车）、\f（换页）、\digits（八进制表示的字符）、\xdigits（十六进制表示的字符）。

● 用""包围的内容被当做一个命令行传入shell。该命令的输出（删除了结尾的新行）被当做参数值。

● 如果不带引号的参数以冒号（:）开头，它会被当做一个gsql变量，并且该变量的值最终会成为真正的参数值。

● 有些命令以一个SQL标识的名称（比如一个表）为参数。这些参数遵循SQL语法关于双引号的规则：不带双引号的标识强制转换成小写，而双引号保护字母不进行大小写转换，并且允许在标识符中使用空白。在双引号中，成对的双引号在结果名字中分析成一个双引号。比如，FOO"BAR"BAZ解析成fooBARbaz；而

"Aweird""name"解析成A weird"name。

● 对参数的分析在遇到另一个不带引号的反斜杠时停止。这里会认为是一个新的元命令的开始。特殊的双反斜杠序列（\\）标识参数的结尾并将继续分析后面的SQL 语句（如果存在）。这样SQL和gsql命令可以自由的在一行里面混合。但是在任何情况下，一条元命令的参数不能延续超过行尾。

元命令

元命令的详细说明请参见表3-11、表3-12、表3-13、表3-14、表3-16、表3-18、表

3-19、表3-20和表3-22。

须知

以下命令中所提到的FILE代表文件路径。此路径可以是绝对路径（如/home/gauss/

file.txt），也可以是相对路径（file.txt，file.txt会默认在用户执行gsql命令所在的路径下创建）。

表3-11 一般的元命令

\copyright 显示GaussDB(DWS)的版本和版权信息。 -

\g [FILE] or ; 执行查询（并将结果发送到文件或管

道）。 -

\h(\help)

[NAME] 给出指定SQL语句的语法帮助。如果没有给出NAME，

gsql将列出可获得帮助的所有命令。如果 NAME是一个星号

（*），则显示所有 SQL语句的语法帮助。

(32)

\parallel [on

[num]|off] 控制并发执行开关。

● on：打开控制并发执行开关，且最大并发数为num。

● off：关闭控制并发执行开关。

说明

● 不支持事务中开启并发执行以及并发中开启事务。

● 不支持\d这类元命令的并发。

● 并发select返回结果混乱问题，此为客户可接受，core、进程停止响应不可接受。

● 不推荐在并发中使用set语句，否则导致结果与预期不一致。

● 不支持创建临时表！如需使用临时表，需要在开启parallel之前创建好，并在parallel内部使用。parallel内部不允许创建临时表。

● \parallel执行时最多会启动num个独立的 gsql进程连接服务器。

● \parallel中所有作业的持续时间不能超过 session_timeout，否则可能会导致并发执行过程中断连。

num的默认值：

1024。

须知

● 服务器能接受的最大连接数受max_connection及当前已有连接数限制。

● 设置num时请考虑服务器当前可接受的实际连接数合理指定。

\q [value] 退出gsql程序。在一个脚本文件里，只在脚本终止的时候执行。退出码可由value值决定。

-

表3-12 查询缓存区元命令

参数参数说明

\e [FILE] [LINE] 使用外部编辑器编辑查询缓冲区（或者文件）。

\ef [FUNCNAME [LINE]] 使用外部编辑器编辑函数定义。如果指定了LINE

（即行号），则光标会指到函数体的指定行。

\p 打印当前查询缓冲区到标准输出。

\r 重置（或清空）查询缓冲区。

\w FILE 将当前查询缓冲区输出到文件。

(33)

表3-13 输入/输出元命令

参数参数说明

\copy { table [ ( column_list ) ] | ( query ) } { from | to }

{ filename | stdin | stdout | pstdin

| pstdout } [ with ] [ binary ] [ oids ] [ delimiter [ as ]

'character' ] [ null [ as ] 'string' ] [ csv [ header ] [ quote [ as ] 'character' ] [ escape [ as ] 'character' ] [ force quote column_list | * ] [ force not null column_list ] ]

在任何psql客户端登录数据库成功后可以执行导入导出数据，这是一个运行SQL COPY命令的操作，但不是读取或写入指定文件的服务器，而是读取或写入文件，并在服务器和本地文件系统之间路由数据。这意味着文件的可访问性和权限是本地用户的权限，而不是服务器的权限，并且不需要数据库初始化用户权限。

说明\COPY只适合小批量，格式良好的数据导入，容错能力较差。导入数据应优先选择GDS或COPY。

\echo [STRING] 把字符串写到标准输出。

\i FILE 从文件FILE中读取内容，并将其当作输入，执行查询。

\i+ FILE KEY 执行加密文件中的命令。

\ir FILE 和\i类似，只是相对于存放当前脚本的路径。

\ir+ FILE KEY 和\i+类似，只是相对于存放当前脚本的路径。

\o [FILE] 把所有的查询结果发送到文件里。

\qecho [STRING] 把字符串写到查询结果输出流里。

说明

表3-14中的选项S表示显示系统对象，+表示显示对象附加的描述信息。PATTERN用来指定要被显示的对象名称。

表3-14 显示信息元命令

参数参数说明取值范围示例

\d[S+] 列出当前search_path中模式下所有的表、视图和序列。

当search_path中不同模式存在同名对象时，只显示 search_path中位置靠前模式下的同名对象。

- 列出当前

search_path中模式下所有的表、视图和序列。

\d

\d[S+]

NAME 列出指定表结构、视图结构

和索引的结构。 - 假设存在表a，列

出指定表a的表结构。 \dtable+ a

(34)

\d+[PATTER N]

列出所有表、视图和索引。如果声明了

PATTERN，只显示名字匹配PATTERN 的表、视图和索引。

列出所有名称以f开头的表、视图和索引。\d+ f*

\da[S]

[PATTER N]

列出所有可用的聚集函数，

以及它们操作的数据类型和返回值类型。

如果声明了

PATTERN，只显示名字匹配PATTERN 的聚集函数。

列出所有名称以f开头可用的聚集函数，以及它们操作的数据类型和返回值类型。\da f*

\db[+]

[PATTER N]

列出所有可用的表空间。如果声明了

PATTERN，只显示名字匹配PATTERN 的表空间。

列出所有名称以p 开头的可用表空间。\db p*

\dc[S+]

[PATTER N]

列出所有字符集之间的可用转换。

如果声明了

PATTERN，只显示名字匹配PATTERN 的转换。

列出所有字符集之间的可用转换。

\dc *

\dC[+]

[PATTER N]

列出所有类型转换。如果声明了

PATTERN，只显示名字匹配PATTERN 的转换。

列出所有名称以c 开头的类型转换。

\dC c*

\dd[S]

[PATTER N]

显示所有匹配PATTERN的描述。

如果没有给出参数，则显示所有可视对象。“对象”

包括：聚集、函数、操作符、类型、关系(表、视图、索引、序列、

大对象)、规则。

列出所有可视对象。\dd

\ddp[PATTER N]

显示所有默认的使用权限。如果指定了

PATTERN，只显示名字匹配PATTERN 的使用权限。

列出所有默认的使用权限。\ddp

\dD[S+]

[PATTER N]

列出所有可用域。如果声明了

PATTERN，只显示名字匹配PATTERN 的域。

列出所有可用域。

\dD

\ded[+]

[PATTER N]

列出所有的Data Source对象。

如果声明了

PATTERN，只显示名字匹配PATTERN 的对象。

列出所有的Data Source对象。

\ded

(35)

\det[+]

[PATTER N]

列出所有的外部表。如果声明了

PATTERN，只显示名字匹配PATTERN 的表。

列出所有的外部表。\det

\des[+]

[PATTER N]

列出所有的外部服务器。如果声明了

PATTERN，只显示名字匹配PATTERN 的服务器。

列出所有的外部服务器。\des

\deu[+]

[PATTER N]

列出用户映射信息。如果声明了

PATTERN，只显示名字匹配PATTERN 的信息。

列出用户映射信息。\deu

\dew[+]

[PATTER N]

列出封装的外部数据。如果声明了

PATTERN，只显示名字匹配PATTERN 的数据。

列出封装的外部数据。\dew

\df[ant w][S+]

[PATTER N]

列出所有可用函数，以及它们的参数和返回的数据类型。a代表聚集函数，n代表普通函数，t代表触发器，w 代表窗口函数。

如果声明了

PATTERN，只显示名字匹配PATTERN 的函数。

列出所有可用函数，以及它们的参数和返回的数据类型。\df

\dF[+]

[PATTER N]

列出所有的文本搜索配置信息。

如果声明了

PATTERN，只显示名字匹配PATTERN 的配置信息。

列出所有的文本搜索配置信息。

\dF+

\dFd[+]

[PATTER N]

列出所有的文本搜索字典。如果声明了

PATTERN，只显示名字匹配PATTERN 的字典。

列出所有的文本搜索字典。\dFd

\dFp[+]

[PATTER N]

列出所有的文本搜索分析器。

如果声明了

PATTERN，只显示名字匹配PATTERN 的分析器。

列出所有的文本搜索分析器。

\dFp

\dFt[+]

[PATTER N]

列出所有的文本搜索模板。如果声明了

PATTERN，只显示名字匹配PATTERN 的模板。

列出所有的文本搜索模板。\dFt

\dg[+]

[PATTER N]

列出所有数据库角色。

说明

因为用户和群组的概念被统一为角色，所以这个命令等价于

\du。为了和以前兼容，所以保留两个命令。

如果指定了

PATTERN，只显示名字匹配PATTERN 的角色。

列出名字为‘j_e’

所有数据库角色。

\dg j?e

(36)

\dl \lo_list的别名，显示一个大

对象的列表。 - 列出所有的大对

象。\dl

\dL[S+]

[PATTER N]

列出可用的程序语言。如果指定了

PATTERN，只列出名字匹配PATTERN 的语言。

列出可用的程序语言。\dL

\dn[S+]

[PATTER N]

列出所有的模式（名字空

间）。如果声明了

PATTERN，只列出名字匹配PATTERN 的模式名。缺省时，只列出用户创建的模式。

列出所有名称以d 开头的模式以及相关信息。 \dn+ d*

\do[S]

[PATTER N]

列出所有可用的操作符，以及它们的操作数和返回的数据类型。

如果声明了

PATTERN，只列出名字匹配PATTERN 的操作符。缺省时，只列出用户创建的操作符。

列出所有可用的操作符，以及它们的操作数和返回的数据类型。\do

\dO[S+]

[PATTER N]

列出排序规则。如果声明了

PATTERN，只列出名字匹配PATTERN 的规则。缺省时，

只列出用户创建的规则。

列出排序规则。

\dO

\dp[PATTER N]

列出一列可用的表、视图以及相关的权限信息。

\dp显示结果如下：

rolename=xxxx/yyyy --赋予一个角色的权限=xxxx/yyyy --赋予public的权限

xxxx表示赋予的权限，yyyy表示授予这个权限的角色。权限的参数说明请参见表

3-15。

如果指定了

PATTERN，只列出名字匹配PATTERN 的表、视图。

列出一列可用的表、视图以及相关的权限信息。

\dp

\drds [PATTER N1[PATTER N2]]

列出所有修改过的配置参数。这些设置可以是针对角色的、针对数据库的或者同时针对两者的。PATTERN1和 PATTERN2表示要列出的角色 PATTERN和数据库

PATTERN。

如果声明了

PATTERN，只列出名字匹配PATTERN 的规则。缺省或指定*时，则会列出所有设置。

列出数据库所有修改过的配置参数。

\drds *

\dT[S+]

[PATTER N]

列出所有的数据类型。如果指定了

PATTERN，只列出名字匹配PATTERN 的类型。

列出所有的数据类型。\dT

(37)

\du[+]

[PATTER N]

列出所有数据库角色。

说明

因为用户和群组的概念被统一为角色，所以这个命令等价于

\dg。为了和以前兼容，所以保留两个命令。

如果指定了

PATTERN，则只列出名字匹配

PATTERN的角色。

列出所有数据库角色。\du

\dE[S+]

[PATTER N]

\di[S+]

[PATTER N]

\ds[S+]

[PATTER N]

\dt[S+]

[PATTER N]

\dv[S+]

[PATTER N]

这一组命令，字母E，i，s，t 和v分别代表着外部表，索引，序列，表和视图。可以以任意顺序指定其中一个或者它们的组合来列出这些对象。例如：\dit列出所有的索引和表。在命令名称后面追加+，则每一个对象的物理尺寸以及相关的描述也会被列出。

说明

本版本暂时不支持序列。

如果指定了

PATTERN，只列出名称匹配该

PATTERN的对象。

默认情况下只会显示用户创建的对象。通过PATTERN 或者S修饰符可以把系统对象包括在内。

列出所有的索引和视图。\div

\dx[+]

[PATTER N]

列出安装数据库的扩展信息。

如果指定了

PATTERN，则只列出名字匹配

PATTERN的扩展信息。

列出安装数据库的扩展信息。

\dx

\l[+] 列出服务器上所有数据库的名字、所有者、字符集编码以及使用权限。

- 列出服务器上所有

数据库的名字、所有者、字符集编码以及使用权限。

\l

\sf[+]

FUNCN AME

显示函数的定义。

说明

对于带圆括号的函数名，需要在函数名两端添加双引号，并且在双引号后面加上参数类型列表。

参数类型列表两端添加圆括号。

- 假设存在函数

function_a和函数名带圆括号的函数 func()name，列出函数的定义。

\sf function_a

\sf "func()name"(argtype1, argtype2)

\z[PATTER N]

列出数据库中所有表、视图和序列，以及它们相关的访问特权。

如果给出任何 pattern ，则被当成一个正则表达式，只显示匹配的表、视图、序列。

列出数据库中所有表、视图和序列，

以及它们相关的访问特权。\z

(38)

表3-15 权限的参数说明

参数参数说明

r SELECT：允许对指定的表、视图读取数据。

w UPDATE：允许对指定表更新字段。

a INSERT：允许对指定表插入数据。

d DELETE：允许删除指定表中的数据。

D TRUNCATE：允许清理指定表中的数据。

x REFERENCES：允许创建外键约束。

t TRIGGER：允许在指定表上创建触发器。

X EXECUTE：允许使用指定的函数，以及利用这些函数实现的操作符。

U USAGE：

● 对于过程语言，允许用户在创建函数时，指定过程语言。

● 对于模式，允许访问包含在指定模式中的对象。

● 对于序列，允许使用nextval函数。

C CREATE：

● 对于数据库，允许在该数据库里创建新的模式。

● 对于模式，允许在该模式中创建新的对象。

● 对于表空间，允许在其中创建表，以及允许创建数据库和模式的时候把该表空间指定为其缺省表空间。

c CONNECT：允许用户连接到指定的数据库。

T TEMPORARY：允许创建临时表。

A ANALYZE|ANALYSE：允许分析表。

arwdDxtA ALL PRIVILEGES：一次性给指定用户/角色赋予所有可赋予的权限。

* 给前面权限的授权选项。

表3-16 格式化元命令

参数参数说明

\a 对齐模式和非对齐模式之间的切换。

\C [STRING] 把正在打印的表的标题设置为一个查询的结果或者取消这样的设置。

\f [STRING] 对于不对齐的查询输出，显示或者设置域分隔符。

(39)

参数参数说明

\H ● 若当前模式为文本格式，则切换为HTML输出格

式。

● 若当前模式为HTML格式，则切换回文本格式。

\pset NAME [VALUE] 设置影响查询结果表输出的选项。NAME的取值见表

3-17。

\t [on|off] 切换输出的字段名的信息和行计数脚注。

\T [STRING] 指定在使用HTML输出格式时放在table标签里的属性。如果参数为空，不设置。

\x [on|off|auto] 切换扩展行格式。

表3-17 可调节的打印选项

选项选项说明取值范围

border value必须是一个数字。通常这个数字越大，表的边界就越宽线就越多，但是这个取决于特定的格式。

● 在HTML格式下，取值范围为大于0的整数。

● 在其他格式下，取值范围：

– 0：无边框 – 1：内部分隔线 – 2：台架 expanded (或

x) 在正常和扩展格式之间切换。 ● 当打开扩展格式时，查询结果用两列显示，字段名称在左、数据在右。这个模式在数据无法放进通常的"水平"模式的屏幕时很有用。

● 在正常格式下，当查询输出的格式比屏幕宽时，用扩展格式。正常格式只对aligned 和wrapped格式有用。

fieldsep 声明域分隔符来实现非对齐输出。这样就可以创建其他程序希望的制表符或逗号分隔的输出。要设置制表符域分隔符，

键入\pset fieldsep '\t'。缺省域分隔符是 '|' (竖条符)。

-

fieldsep_zero 声明域分隔符来实现非对齐输

出到零字节。 -

footer 用来切换脚注。 -

(40)

选项选项说明取值范围 format 设置输出格式。允许使用唯一

缩写（这意味着一个字母就够了）。

取值范围：

● unaligned：写一行的所有列在一条直线上中，当前活动字段分隔符分隔。

● aligned：此格式是标准的，

可读性最好的文本输出。

● wrapped：类似aligned，但是包装跨行的宽数据值，使其适应目标字段的宽度输出。

● html：把表输出为可用于文档里的对应标记语言。输出不是完整的文档。

● latex：把表输出为可用于文档里的对应标记语言。输出不是完整的文档。

● troff-ms：把表输出为可用于文档里的对应标记语言。输出不是完整的文档。

null 打印一个字符串，用来代替一

个null值。缺省是什么都不打印，这样很容

易和空字符串混淆。

numericlocale 切换分隔小数点左边的数值的

区域相关的分组符号。 ● on：显示指定的分隔符。

● off：不显示分隔符。

忽略此参数，显示默认的分隔符。

pager 控制查询和gsql帮助输出的分页器。如果设置了环境变量 PAGER，输出将被指向到指定程序，否则使用系统缺省。

● on：当输出到终端且不适合屏幕显示时，使用分页器。

● off：不使用分页器。

● always：当输出到终端无论是否符合屏幕显示时，都使用分页器。

recordsep 声明在非对齐输出格式时的记

录分隔符。 -

recordsep_zero 声明在非对齐输出到零字节时

的记录分隔符。 -

tableattr（或

T）声明放在html输出格式中 HTML table标签的属性（例如：cellpadding或bgcolor）。

注意：这里可能不需要声明 border，因为已经在\pset border里用过了。如果没有给出value，则不设置表的属性。

-

安装配置和启动GDS_数据仓库服务 GaussDB(DWS)_工具指南_GDS并行数据加载工具_华为云

工具指南

目录

1 工具简介...1

2 工具下载...2

3 gsql 命令行客户端工具...3

4 Data Studio 数据库集成开发工具... 46

5 GDS 并行数据加载工具... 242

6 DSC SQL 语法迁移工具...258

7 服务端工具... 629

1 ^工具简介

2 ^工具下载

console.huaweicloud.com/dws。

3 gsql 命令行客户端工具

3.1 gsql 概述

基本功能

高级特性

COMMAND_ERROR_STOP使用示例。

环境变量

3.2 使用指导

下载安装 gsql 并使用 gsql 连接集群数据库

示例

3.3 获取帮助

操作步骤

任务示例

3.4 命令参考

3.5 元命令参考

注意事项

元命令

3-19、表3-20和表3-22。

3-15。

3-17。

安装配置和启动GDS_数据仓库服务 GaussDB(DWS)_工具指南_GDS并行数据加载工具_华为云

工具指南

目 录

1 工具简介...1

2 工具下载...2

3 gsql 命令行客户端工具...3

4 Data Studio 数据库集成开发工具... 46

5 GDS 并行数据加载工具... 242

6 DSC SQL 语法迁移工具...258

7 服务端工具... 629

1 工具简介

2 工具下载

console.huaweicloud.com/dws。

3 gsql 命令行客户端工具

3.1 gsql 概述

基本功能

高级特性

COMMAND_ERROR_STOP使用示例。

环境变量

3.2 使用指导

下载安装 gsql 并使用 gsql 连接集群数据库

示例

3.3 获取帮助

操作步骤

任务示例

3.4 命令参考

3.5 元命令参考

注意事项

元命令

3-19、表3-20和表3-22。

3-15。

3-17。

目录

1 ^工具简介

2 ^工具下载