高斯数据库架构高斯数据库语法

转载

代码工匠大师 2023-11-23 15:08:05

元命令参考

注意：要在参数里面包含空白，必须用单引号把它引起来。要在这样的参数里包含单引号，可以在前面加一个反斜杠。不带双引号的标识强制成小写，而双引号保护字母不进行大小写转换，并且允许在标识符中使用空白。

注意：以下命令中所提到的文件代表文件路径。此路径可以是绝对路径（如/home/gauss/file.txt），也可以是相对路径（file.txt，file.txt会设置为用户执行GSQL命令所在的路径下创建）。

表1一般的元命令

参数	参数说明	取值范围
\copyright	显示GaussDB的版本和版权信息。	-
\g [FILE] [\|command ]	把当前的查询输入缓冲区的内容发送给服务器并且把查询的输出存储到可选的filename或者把输出重定向到一个独立的执行command的Unix shell。	-
\h [NAME]	给出指定SQL命令的语法帮助。	如果没有给出NAME，gsql将列出可获得帮助的所有命令。如果NAME是一个星号（*），则显示所有SQL命令的语法帮助。
\q	退出gsql程序。在一个脚本文件里，只在脚本终止的时候执行。	-

表2 查询缓存区元命令

参数	参数说明	取值范围
\e [FILE] [LINE]	使用外部编辑器编辑查询缓冲区（或者文件）。	-
\ef [FUNCNAME [LINE]]	使用外部编辑器编辑函数定义。如果指定了LINE（即行号），则光标会指到函数体的指定行。	-
\p	打印当前查询缓冲区到标准输出。	-
\r	重置（或清空）查询缓冲区。	-
\w FILE	将当前查询缓冲区输出到文件。	-

表3 输入/输出元命令

参数	参数说明	取值范围
\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 ] ]	gsql会读写文件来完成本地文件和服务器之间数据传输。	-
\echo [STRING]	把字符串写到标准输出。	-
\i FILE	从文件FILE中读取内容，并将其当作键盘输入，执行查询。	-
\i+ FILE KEY	执行加密文件中的命令。	-
\ir FILE	和\i类似，只是相对于存放当前脚本的路径。	-
\ir+ FILE KEY	和\i+类似，只是相对于存放当前脚本的路径。	-
\o [FILE]	把所有的查询结果发送到文件里或者管道。	-
\qecho [STRING]	把字符串写到查询结果输出流里。	-

表4 显示信息元命令

选项S表示显示系统对象，+表示显示对象附加的描述信息。

参数	参数说明	取值范围
\d[S+]	列出当前search_path中模式下所有的表、视图和序列。当search_path中不同模式存在同名对象时，只显示search_path中位置靠前模式下的同名对象，超级用户也是这样。	-
\d[S+] NAME	描述表、视图、序列和索引。	-
\da[S] [PATTERN]	列出所有可用的聚集函数，以及它们操作的数据类型和返回值类型。	如果声明了PATTERN，只显示名字匹配PATTERN的聚集函数。
\db[+] [PATTERN]	列出所有可用的表空间。	如果声明了PATTERN，只显示名字匹配PATTERN的表空间。
\dc[S+] [PATTERN]	列出所有字符集之间的可用转换。	如果声明了PATTERN，只显示名字匹配PATTERN的转换。
\dC[+] [PATTERN]	列出所有类型转换。	如果声明了PATTERN，只显示名字匹配PATTERN的转换。
\dd[S] [PATTERN]	显示所有匹配pattern的描述。	如果没有给出参数，则显示所有可视对象。“对象”包括：聚集、函数、操作符、类型、关系(表、视图、索引、序列、大对象)、规则、触发器。
\ddp [PATTERN]	显示所有默认的使用权限。	如果指定了PATTERN，只显示名字匹配PATTERN的使用权限。
\dD[S+] [PATTERN]	列出所有可用域。	如果声明了PATTERN，只显示名字匹配PATTERN的域。
\det[+] [PATTERN]	列出所有的外部表。	如果声明了PATTERN，只显示名字匹配PATTERN的表。
\des[+] [PATTERN]	列出所有的外部服务器。	如果声明了PATTERN，只显示名字匹配PATTERN的服务器。
\deu[+] [PATTERN]	列出用户映射信息。	如果声明了PATTERN，只显示名字匹配PATTERN的信息。
\dew[+] [PATTERN]	列出封装的外部数据。	如果声明了PATTERN，只显示名字匹配PATTERN的数据。
\df [PATTERN]	列出所有可用函数，以及它们的参数和返回的数据类型。	如果声明了PATTERN，只显示名字匹配PATTERN的函数。
\dF[+] [PATTERN]	列出所有的文本搜索配置信息。	如果声明了PATTERN，只显示名字匹配PATTERN的配置信息。
\dFd[+] [PATTERN]	列出所有的文本搜索字典。	如果声明了PATTERN，只显示名字匹配PATTERN的字典。
\dFp[+] [PATTERN]	列出所有的文本搜索分析器。	如果声明了PATTERN，只显示名字匹配PATTERN的分析器。
\dFt[+] [PATTERN]	列出所有的文本搜索模板。	如果声明了PATTERN，只显示名字匹配PATTERN的模板。
\dg[+] [PATTERN]	列出所有数据库角色。说明：因为用户和群组的概念被统一为角色，所以这个命令等价于\du。为了和以前兼容，所以保留两个命令。	如果指定了PATTERN，只显示名字匹配PATTERN的角色。
\dl	\lo_list的别名，显示一个大对象的列表。	-
\dL[S+] [PATTERN]	列出可用的程序语言。	如果指定了PATTERN，只列出名字匹配PATTERN的语言。
\dn[S+] [PATTERN]	列出所有的模式（名字空间）。	如果声明了PATTERN，只列出名字匹配PATTERN的模式名。缺省时，只列出用户创建的对象。
\do[S] [PATTERN]	列出所有可用的操作符，以及它们的操作数和返回的数据类型。	如果声明了PATTERN，只列出名字匹配PATTERN的操作符。缺省时，只列出用户创建的操作符。
\dO[S+] [PATTERN]	列出排序规则。	如果声明了PATTERN，只列出名字匹配PATTERN的操作符。缺省时，只列出用户创建的操作符。
\dp [PATTERN]	列出一列可用的表、视图、序列以及相关的权限信息。	如果指定了PATTERN，只列出名字匹配PATTERN的表、视图、序列。
\drds [PATRN1 [PATRN2]]	列出所有修改过的配置参数。	-
\dT[S+] [PATTERN]	列出所有的数据类型。	如果指定了PATTERN，只列出名字匹配PATTERN的类型。
\du[+] [PATTERN]	列出所有数据库角色。说明：因为用户和群组的概念被统一为角色，所以这个命令等价于\dg。为了和以前兼容，所以保留两个命令。	如果指定了PATTERN，则只列出名字匹配PATTERN的角色。
\dE[S+] [PATTERN] \di[S+] [PATTERN] \ds[S+] [PATTERN] \dt[S+] [PATTERN] \dv[S+] [PATTERN]	这一组命令，字母E，i，s，t和v分别代表了外部表，索引，序列，表和视图。可以以任意顺序指定其中一个或者它们的组合来获取对象的这些类型。例如：\dit列出所有的表和索引。	-
\dx[+] [PATTERN]	列出安装数据库的扩展信息。	如果指定了PATTERN，则只列出名字匹配PATTERN的扩展信息。
\l[+]	列出服务器上所有数据库的名字、所有者、字符集编码以及使用权限。	-
\sf[+] FUNCNAME	显示函数的定义。	-

表5 格式化元命令

参数	参数说明	取值范围
\a	对齐模式和非对齐模式之间的切换。	-
\C [TITLE ]	把正在打印的表的标题设置为一个查询的结果或者取消这样的设置。	-
\f [STRING]	对于不对齐的查询输出，显示或者设置域分隔符。	-
\H	切换HTML输出模式（当前此模式为关闭状态）。	-
\pset NAME [VALUE]	设置影响查询结果表输出的选项。NAME的取值见表6。	-
\t [on\|off]	切换输出的字段名的信息和行计数脚注。	-
\T [STRING]	指定在使用HTML输出格式时放在table标签里的属性。如果参数为空，不设置。	-
\x [on\|off\|auto]	切换扩展行格式。	-