网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts盘古助手
华为云Astro大屏应用
计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
云手机服务器 CPH
专属主机 DeH
弹性伸缩 AS
镜像服务 IMS
函数工作流 FunctionGraph
云耀云服务器(旧版)
VR云渲游平台 CVR
Huawei Cloud EulerOS
云化数据中心 CloudDC
网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
CDN与智能边缘
内容分发网络 CDN
智能边缘云 IEC
智能边缘平台 IEF
CloudPond云服务
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
可信智能计算服务 TICS
推荐系统 RES
云搜索服务 CSS
数据可视化 DLV
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
湖仓构建 LakeFormation
智能数据洞察 DataArts Insight
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
开天aPaaS
应用平台 AppStage
开天企业工作台 MSSE
开天集成工作台 MSSI
API中心 API Hub
云消息服务 KooMessage
交换数据空间 EDS
云地图服务 KooMap
云手机服务 KooPhone
组织成员账号 OrgID
云空间服务 KooDrive
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
区块链
区块链服务 BCS
数字资产链 DAC
华为云区块链引擎服务 HBS
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
价格
成本优化最佳实践
专属云商业逻辑
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
其他
管理控制台
消息中心
产品价格详情
系统权限
客户关联华为云合作伙伴须知
公共问题
宽限期保留期
奖励推广计划
活动
云服务信任体系能力说明
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts盘古助手
华为云Astro大屏应用
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
存储容灾服务 SDRS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
云存储网关 CSG
专属分布式存储服务 DSS
数据工坊 DWR
地图数据 MapDS
键值存储服务 KVS
容器
云容器引擎 CCE
云容器实例 CCI
容器镜像服务 SWR
云原生服务中心 OSC
应用服务网格 ASM
华为云UCS
数据库
云数据库 RDS
数据复制服务 DRS
文档数据库服务 DDS
分布式数据库中间件 DDM
云数据库 GaussDB
云数据库 GeminiDB
数据管理服务 DAS
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
AI开发平台ModelArts
华为HiLens
图引擎服务 GES
图像识别 Image
文字识别 OCR
自然语言处理 NLP
内容审核 Moderation
图像搜索 ImageSearch
医疗智能体 EIHealth
企业级AI应用开发专业套件 ModelArts Pro
人脸识别服务 FRS
对话机器人服务 CBS
语音交互服务 SIS
人证核身服务 IVS
视频智能分析服务 VIAS
城市智能体
自动驾驶云服务 Octopus
盘古大模型 PanguLargeModels
IoT物联网
设备接入 IoTDA
全球SIM联接 GSL
IoT数据分析 IoTA
路网数字化服务 DRIS
IoT边缘 IoTEdge
设备发放 IoTDP
企业应用
域名注册服务 Domains
云解析服务 DNS
企业门户 EWP
ICP备案
商标注册
华为云WeLink
华为云会议 Meeting
隐私保护通话 PrivateNumber
语音通话 VoiceCall
消息&短信 MSGSMS
云管理网络
SD-WAN 云服务
边缘数据中心管理 EDCM
云桌面 Workspace
应用与数据集成平台 ROMA Connect
ROMA资产中心 ROMA Exchange
API全生命周期管理 ROMA API
政企自服务管理 ESM
视频
实时音视频 SparkRTC
视频直播 Live
视频点播 VOD
媒体处理 MPC
视频接入服务 VIS
数字内容生产线 MetaStudio
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
专属云
专属计算集群 DCC
开发者工具
SDK开发指南
API签名指南
DevStar
华为云命令行工具服务 KooCLI
Huawei Cloud Toolkit
CodeArts API
云化转型
云架构中心
云采用框架
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
客户运营能力
国际站常见问题
支持计划
专业服务
合作伙伴支持计划
我的凭证
华为云公共事业服务云平台
工业软件
工业数字模型驱动引擎
硬件开发工具链平台云服务
工业数据转换引擎云服务
本文导读

元命令参考

更新时间:2024-10-31 GMT+08:00
分享

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

注意事项

  • 一个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命令可以自由地在一行里面混合。但是在任何情况下,一条元命令的参数不能延续超过行尾。

元命令

元命令的详细说明请参见表1表2表3表4表6表8表9表10表12

须知:

以下命令中所提到的FILE代表文件路径。此路径可以是绝对路径(如/home/gauss/file.txt),也可以是相对路径(file.txt,file.txt会默认在用户执行gsql命令所在的路径下创建)。

表1 一般的元命令

参数

参数说明

取值范围

\copyright

显示GaussDB的版本和版权信息。

-

\g [FILE] or ;

执行查询(并将结果发送到文件或管道)。

-

\h(\help) [NAME]

给出指定SQL语句的语法帮助。

如果没有给出NAME,gsql将列出可获得帮助的所有命令。如果NAME是一个星号(*),则显示所有SQL语句的语法帮助。

\parallel [on [num]|off]

控制并发执行开关。

  • on:打开控制并发执行开关,且最大并发数为num。
  • off:关闭控制并发执行开关。
说明:
  • 不支持事务中开启并发执行以及并发中开启事务。
  • 不支持\d这类元命令的并发。
  • 并发select返回结果混乱问题,此为客户可接受,core、进程停止响应不可接受。
  • 不推荐在并发中使用set语句,否则导致结果与预期不一致。
  • 不支持创建临时表!如需使用临时表,需要在开启parallel之前创建好,并在parallel内部使用。parallel内部不允许创建临时表。
  • \parallel执行时最多会启动num个独立的gsql进程连接服务器。
  • \parallel中所有作业的持续时间不能超过session_timeout,否则可能会导致并发执行过程中断连。
  • 在\parallel on 之后一条或多条命令,会等到\parallel off执行后才会执行,因而,\parallel on之后需要有对应的\parallel off,否则\parallel on后的命令都无法执行。

num的默认值:1024。

须知:
  • 服务器能接受的最大连接数受max_connection及当前已有连接数限制。
  • 设置num时请考虑服务器当前可接受的实际连接数合理指定。

\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 }[LOAD] [LOAD_DISCARD 'string'] [ with ] [ binary ] [ oids ] [ delimiter [ as ] 'character' ] [ useeof ] [ null [ as ] 'string' ] [ csv [ header ] [ quote [ as ] 'character' ] [ escape [ as ] 'character' ] [ force quote column_list | * ] [ force not null column_list ] ] [parallel integer]

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

说明:
  • \COPY只适合小批量,格式良好的数据导入,导入数据应优先选择GDS或COPY。
  • \COPY 可以指定数据导入时的客户端数量,从而实现数据文件的并行导入,目前并发数范围为[1, 8]。
  • \COPY并行导入目前存在以下约束:临时表的并行导入不支持、在事务内的并行导入不支持、对二进制文件的并行导入不支持、数据导入支持AES128加密时不支持以及COPY选项中存在EOL。在这些情况下,即使指定了parallel参数,仍然会走非并行流程。
  • \COPY的text格式和csv格式均支持header功能
  • 其中LOAD功能为gs_loader进行语法转换后调用copy的标识,非主动调用功能。
  • 其中LOAD_DISCARD功能为gs_loader解析后discard文件路径,非主动调用功能。

\echo [STRING]

把字符串写到标准输出。

\i FILE

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

\i+ FILE KEY

执行加密文件中的命令。

\ir FILE

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

\ir+ FILE KEY

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

\o [FILE]

把所有的查询结果发送到文件里。

\qecho [STRING]

把字符串写到查询结果输出流里。

说明:

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

表4 显示信息元命令

参数

参数说明

取值范围

示例

\d[S+]

列出当前search_path中模式下所有的表、视图和序列。当search_path中不同模式存在同名对象时,只显示search_path中位置靠前模式下的同名对象。

-

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

1
gaussdb=# \d

\d[S+] NAME

列出指定表、视图和索引的结构。当search_path中不同模式存在同名对象时,只显示search_path中位置靠前模式下的同名对象。

-

假设存在表a,列出指定表a的结构。

1
gaussdb=# \dtable+ a

\d+ [PATTERN]

列出所有表、视图和索引。当search_path中不同模式存在同名对象时,只显示search_path中位置靠前模式下的同名对象。

如果声明了PATTERN,只显示名称匹配PATTERN的表、视图和索引。

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

1
gaussdb=# \d+ f*

\da[S] [PATTERN]

列出所有可用的聚集函数,以及它们操作的数据类型和返回值类型。当search_path中不同模式存在同名对象时,只显示search_path中位置靠前模式下的同名对象。

如果声明了PATTERN,只显示名称匹配PATTERN的聚集函数。

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

1
gaussdb=# \da f*

\db[+] [PATTERN]

列出所有可用的表空间。

如果声明了PATTERN,只显示名称匹配PATTERN的表空间。

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

1
gaussdb=# \db p*

\dc[S+] [PATTERN]

列出所有字符集之间的可用转换。当search_path中不同模式存在同名对象时,只显示search_path中位置靠前模式下的同名对象。

如果声明了PATTERN,只显示名称匹配PATTERN的转换。

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

1
gaussdb=# \dc *

\dC[+] [PATTERN]

列出所有类型转换。当search_path中不同模式存在同名对象时,只显示search_path中位置靠前模式下的同名对象。

PATTERN需要使用实际类型名,不能使用别名。

如果声明了PATTERN,只显示名称匹配PATTERN的转换。

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

1
gaussdb=# \dC c*

\dd[S] [PATTERN]

显示所有匹配PATTERN的描述。当search_path中不同模式存在同名对象时,只显示search_path中位置靠前模式下的同名对象。

如果没有给出参数,则显示所有可视对象。“对象”包括:聚集、函数、操作符、类型、关系(表、视图、索引、序列、大对象)、规则。

列出所有可视对象。

1
gaussdb=# \dd

\ddp [PATTERN]

显示所有默认的使用权限。

如果指定了PATTERN,只显示名称匹配PATTERN的使用权限。

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

1
gaussdb=# \ddp

\dD[S+] [PATTERN]

列出所有可用域。当search_path中不同模式存在同名对象时,只显示search_path中位置靠前模式下的同名对象。

如果声明了PATTERN,只显示名称匹配PATTERN的域。

列出所有可用域。

1
gaussdb=# \dD

\det[+] [PATTERN]

列出所有的外部表。当search_path中不同模式存在同名对象时,只显示search_path中位置靠前模式下的同名对象。

如果声明了PATTERN,只显示名称匹配PATTERN的表。

列出所有的外部表。

1
gaussdb=# \det

\des[+] [PATTERN]

列出所有的外部服务器。

如果声明了PATTERN,只显示名称匹配PATTERN的服务器。

列出所有的外部服务器。

1
gaussdb=# \des

\deu[+] [PATTERN]

列出用户映射信息。

如果声明了PATTERN,只显示名称匹配PATTERN的信息。

列出用户映射信息。

1
gaussdb=# \deu

\dew[+] [PATTERN]

列出封装的外部数据。

如果声明了PATTERN,只显示名称匹配PATTERN的数据。

列出封装的外部数据。

1
gaussdb=# \dew

\df[antw][S+] [PATTERN]

列出所有可用函数,以及它们的参数和返回的数据类型。a代表聚集函数,n代表普通函数,t代表触发器,w代表窗口函数。当search_path中不同模式存在同名对象时,只显示search_path中位置靠前模式下的同名对象。

如果声明了PATTERN,只显示名称匹配PATTERN的函数。

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

1
gaussdb=# \df

\dF[+] [PATTERN]

列出所有的文本搜索配置信息。当search_path中不同模式存在同名对象时,只显示search_path中位置靠前模式下的同名对象。

如果声明了PATTERN,只显示名称匹配PATTERN的配置信息。

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

1
gaussdb=# \dF+

\dFd[+] [PATTERN]

列出所有的文本搜索字典。当search_path中不同模式存在同名对象时,只显示search_path中位置靠前模式下的同名对象。

如果声明了PATTERN,只显示名称匹配PATTERN的字典。

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

1
gaussdb=# \dFd

\dFp[+] [PATTERN]

列出所有的文本搜索分析器。当search_path中不同模式存在同名对象时,只显示search_path中位置靠前模式下的同名对象。

如果声明了PATTERN,只显示名称匹配PATTERN的分析器。

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

1
gaussdb=# \dFp

\dFt[+] [PATTERN]

列出所有的文本搜索模板。当search_path中不同模式存在同名对象时,只显示search_path中位置靠前模式下的同名对象。

如果声明了PATTERN,只显示名称匹配PATTERN的模板。

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

1
gaussdb=# \dFt

\dg[+] [PATTERN]

列出所有数据库角色。

说明:

因为用户和群组的概念被统一为角色,所以这个命令等价于\du。为了和以前兼容,所以保留两个命令。

如果指定了PATTERN,只显示名称匹配PATTERN的角色。

列出名称为“j?e”所有数据库角色(“?”表示任一字符)。

1
gaussdb=# \dg j?e

\dl

\lo_list的别名,显示一个大对象的列表。

-

列出所有的大对象。

1
gaussdb=# \dl

\dL[S+] [PATTERN]

列出可用的程序语言。

如果指定了PATTERN,只列出名称匹配PATTERN的语言。

列出可用的程序语言。

1
gaussdb=# \dL

\dm[S+] [PATTERN]

列出物化视图。当search_path中不同模式存在同名对象时,只显示search_path中位置靠前模式下的同名对象。

如果指定了PATTERN,只列出名称匹配PATTERN的物化视图。

列出物化视图。

1
gaussdb=# \dm

\dn[S+] [PATTERN]

列出所有模式(名称空间)。如果向命令追加+,会列出每个模式相关的权限及描述。

如果声明了PATTERN,只列出名称匹配PATTERN的模式名。缺省时,只列出用户创建的模式。

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

1
gaussdb=# \dn+ d*

\do[S] [PATTERN]

列出所有可用的操作符,以及它们的操作数和返回的数据类型。当search_path中不同模式存在同名对象时,只显示search_path中位置靠前模式下的同名对象。

如果声明了PATTERN,只列出名称匹配PATTERN的操作符。缺省时,只列出用户创建的操作符。

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

1
gaussdb=# \do

\dO[S+] [PATTERN]

列出排序规则。当search_path中不同模式存在同名对象时,只显示search_path中位置靠前模式下的同名对象。

如果声明了PATTERN,只列出名称匹配PATTERN的规则。缺省时,只列出用户创建的规则。

列出排序规则。

1
gaussdb=# \dO

\dp [PATTERN]

列出一列可用的表、视图以及相关的权限信息。当search_path中不同模式存在同名对象时,只显示search_path中位置靠前模式下的同名对象。

\dp显示结果如下:

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

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

如果指定了PATTERN,只列出名称匹配PATTERN的表、视图。

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

1
gaussdb=# \dp

\drds [PATTERN1 [PATTERN2]]

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

如果声明了PATTERN,只列出名称匹配PATTERN的规则。缺省或指定*时,则会列出所有设置。

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

1
gaussdb=# \drds * dbname

\dT[S+] [PATTERN]

列出所有的数据类型。当search_path中不同模式存在同名对象时,只显示search_path中位置靠前模式下的同名对象。

如果指定了PATTERN,只列出名称匹配PATTERN的类型。

列出所有的数据类型。

1
gaussdb=# \dT

\du[+] [PATTERN]

列出所有数据库角色。

说明:

因为用户和群组的概念被统一为角色,所以这个命令等价于\dg。为了和以前兼容,所以保留两个命令。

如果指定了PATTERN,则只列出名称匹配PATTERN的角色。

列出所有数据库角色。

1
gaussdb=# \du

\dE[S+] [PATTERN]

\di[S+] [PATTERN]

\ds[S+] [PATTERN]

\dt[S+] [PATTERN]

\dv[S+] [PATTERN]

这一组命令,字母E,i,s,t和v分别代表着外部表,索引,序列,表和视图。可以以任意顺序指定其中一个或者它们的组合来列出这些对象。当search_path中不同模式存在同名对象时,只显示search_path中位置靠前模式下的同名对象。例如:\dit列出所有的索引和表。在命令名称后面追加+,则每一个对象的物理尺寸以及相关的描述也会被列出。

如果指定了PATTERN,只列出名称匹配该PATTERN的对象。默认情况下只会显示用户创建的对象。通过PATTERN或者S修饰符可以把系统对象包括在内。

列出所有的索引和视图。

1
gaussdb=# \div

\dx[+] [PATTERN]

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

如果指定了PATTERN,则只列出名称匹配PATTERN的扩展信息。

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

1
gaussdb=# \dx

\l[+]

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

-

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

1
gaussdb=# \l

\sf[+] FUNCNAME

显示函数的定义。

说明:

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

-

假设存在函数function_a和函数名带圆括号的函数func()name,列出函数的定义。

1
2
3
gaussdb=# \sf function_a
gaussdb=# \sf 
"func()name"(argtype1, argtype2)

\z [PATTERN]

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

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

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

1
gaussdb=# \z
表5 权限的参数说明

参数

参数说明

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

ALTER:允许用户修改指定对象的属性。

P

DROP:允许用户删除指定的对象。

m

COMMENT:允许用户定义或修改指定对象的注释。

i

INDEX:允许用户在指定表上创建索引。

v

VACUUM:允许用户对指定的表执行ANALYZE和VACUUM操作。

*

给前面权限的授权选项。

表6 格式化元命令

参数

参数说明

\a

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

\C [STRING]

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

\f [STRING]

对于不对齐的查询输出,显示或者设置域分隔符。

\H

  • 若当前模式为文本格式,则切换为HTML输出格式。
  • 若当前模式为HTML格式,则切换回文本格式。

\pset NAME [VALUE]

设置影响查询结果表输出的选项。NAME的取值见表7

\t [on|off]

切换输出的字段名的信息和行计数脚注。

\T [STRING]

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

\x [on|off|auto]

切换扩展行格式。

表7 可调节的打印选项

选项

选项说明

取值范围

border

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

  • 在HTML格式下,取值范围为大于0的整数。
  • 在其他格式下,取值范围:
    • 0:无边框
    • 1:内部分隔线
    • 2:台架

expanded (或x)

在正常和扩展格式之间切换。

  • 当打开扩展格式时,查询结果用两列显示,字段名称在左、数据在右。这个模式在数据无法放进通常的“水平”模式的屏幕时很有用。
  • 在正常格式下,当查询输出的格式比屏幕宽时,用扩展格式。正常格式只对aligned和wrapped格式有用。

fieldsep

声明域分隔符来实现非对齐输出。这样就可以创建其他程序希望的制表符或逗号分隔的输出。要设置制表符域分隔符,键入\pset fieldsep '\t'。缺省域分隔符是 '|' (竖条符)。

-

fieldsep_zero

声明域分隔符来实现非对齐输出到零字节。

-

footer

用来切换脚注。

-

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,则不设置表的属性。

-

title

为随后打印的表设置标题。这个可以用于给输出一个描述性标签。如果没有给出value,不设置标题。

-

tuples_only (或者t)

在完全显示和只显示实际的表数据之间切换。完全显示将输出像列头、标题、各种脚注等信息。在tuples_only模式下,只显示实际的表数据。

-

feedback

切换是否输出结果行数

-

表8 连接元命令

参数

参数说明

取值范围

\c[onnect] [DBNAME|- USER|- HOST|- PORT|-]

连接到一个新的数据库。当数据库名称长度超过63个字节时,默认前63个字节有效,连接到前63个字节对应的数据库,但是gsql的命令提示符中显示的数据库对象名仍为截断前的名称。

说明:

重新建立连接时,如果切换数据库登录用户,将可能会出现交互式输入,要求输入新用户的连接密码。该密码最长长度为999字节,受限于GUC参数password_max_length的最大值。

-

\encoding [ENCODING]

设置客户端字符编码格式。

不带参数时,显示当前的编码格式。

\conninfo

输出当前连接的数据库的信息。

-

表9 操作系统元命令

参数

参数说明

取值范围

\cd [DIR]

切换当前的工作目录。

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

\setenv NAME [VALUE]

设置环境变量NAME为VALUE,如果没有给出VALUE值,则不设置环境变量。

-

\timing [on|off]

以毫秒为单位显示每条SQL语句的执行时间(不包括显示的打印时间)

  • on表示打开显示。
  • off表示关闭显示。

\! [COMMAND]

返回到一个单独的Unix shell或者执行Unix命令COMMAND。

-

表10 变量元命令

参数

参数说明

\prompt [TEXT] NAME

提示用户用文本格式来指定变量名称。

\set [NAME [VALUE]]

设置内部变量NAME为VALUE或者如果给出了多于一个值,设置为所有这些值的连接结果。如果没有给出第二个参数,只设变量不设值。

有一些常用变量被gsql特殊对待,它们是一些选项设置,通常所有特殊对待的变量都是由大写字母组成(可能还有数字和下划线)。 表11是一个所有特殊对待的变量列表。

\unset NAME

不设置(或删除)gsql变量名。

表11 \set常用命令

名称

命令说明

取值范围

\set VERBOSITY value

这个选项可以设置为值default,verbose,terse之一以控制错误报告的冗余行。

value取值范围:default, verbose,terse

\set ON_ERROR_STOP value

如果设置了这个变量,脚本处理将马上停止。如果该脚本是从另外一个脚本调用的,那个脚本也会按同样的方式停止。如果最外层的脚本不是从一次交互的gsql会话中调用的而是用-f选项调用的,gsql将返回错误代码3,以示这个情况与致命错误条件的区别(错误代码为1)。

value取值范围为:on/off,true/false,yes/no,1/0

\set AUTOCOMMIT [on|off]

设置当前gsql连接的自动提交行为,on为打开自动提交,off为关闭自动提交。默认情况下,gsql连接处于自动提交模式,每个单独的语句都被隐式提交。如果基于性能或者其它方面考虑,需要关闭自动提交时,需要用户自己显示地发出COMMIT命令来保证事务的提交。例如,在指定的业务SQL执行完之后发送COMMIT语句显式提交,特别是gsql客户端退出之前务必保证所有的事务已经提交。

说明:

gsql默认使用自动提交模式,若关闭自动提交,将会导致后面执行的语句都受到隐式事务包裹,数据库中不支持在事务中执行的语句不能在此模式下执行。

  • on表示打开自动提交。
  • off表示关闭自动提交。
表12 大对象元命令

参数

参数说明

\lo_list

显示一个目前存储在该数据库里的所有GaussDB大对象和提供给他们的注释。

PATTERN

很多\d命令都可以用一个PATTERN参数来指定要被显示的对象名称。在最简单的情况下,PATTERN正好就是该对象的准确名称。在PATTERN中的字符通常会被变成小写形式(就像在SQL名称中那样),例如\dt FOO将会显示名为foo的表。就像在SQL名称中那样,把PATTERN放在双引号中可以阻止它被转换成小写形式。如果需要在一个PATTERN中包括一个真正的双引号字符,则需要把它写成两个相邻的双引号,这同样是符合SQL引用标识符的规则。例如,\dt "FOO""BAR"将显示名为FOO"BAR(不是foo"bar)的表。和普通的SQL名称规则不同,不能只在PATTERN的一部分周围放上双引号,例如\dt FOO"FOO"BAR将会显示名为fooFOObar的表。

不使用PATTERN参数时,\d命令会显示当前schema搜索路径中可见的全部对象——这等价于用*作为PATTERN。所谓对象可见是指可以直接用名称引用该对象,而不需要用schema来进行限定。要查看数据库中所有的对象而不管它们的可见性,可以把*.*用作PATTERN。

如果放在一个PATTERN中,*将匹配任意字符序列(包括空序列),而?会匹配任意的单个字符(这种记号方法就像 Unix shell 的文件名PATTERN一样)。例如,\dt int*会显示名称以int开始的表。但是如果被放在双引号内,*和?就会失去这些特殊含义而变成普通的字符。

包含一个点号(.)的PATTERN被解释为一个schema名称模式后面跟上一个对象名称模式。例如,\dt foo*.*bar*会显示名称以foo开始的schema中所有名称包括bar的表。如果没有出现点号,那么模式将只匹配当前schema搜索路径中可见的对象。同样,双引号内的点号会失去其特殊含义并且变成普通的字符。

高级用户可以使用字符类等正则表达式记法,如[0-9]可以匹配任意数字。所有的正则表达式特殊字符都按照POSIX正则表达式所说的工作。以下字符除外:

  • .会按照上面所说的作为一种分隔符。
  • *会被翻译成正则表达式记号.*。
  • ?会被翻译成.。
  • $则按字面意思匹配。

根据需要,可以通过书写?、(R+|)、(R|)和R?来分别模拟PATTERN字符.、R*和R?。$不需要作为一个正则表达式字符,因为PATTERN必须匹配整个名称,而不是像正则表达式的常规用法那样解释(换句话说,$会被自动地追加到PATTERN上)。如果不希望该PATTERN的匹配位置被固定,可以在开头或者结尾写上*。注意在双引号内,所有的正则表达式特殊字符会失去其特殊含义并且按照其字面意思进行匹配。另外,在操作符名称PATTERN中(即\do的PATTERN参数),正则表达式特殊字符也按照字面意思进行匹配。

DELIMITER

更改SQL语句之间分隔符命令,分隔符默认值为“;”。

DELIMITER命令用来为客户端设置一个分隔符。当用户设置分隔符后,gsql客户端识别到分隔符时,会立即将SQL语句发送到服务端执行,但是服务端仍然将“;”看做SQL语句分隔符,并相应的处理SQL语句。

注意事项:

  • delimiter符号目前不是自由设定的,结束符范围有限制,目前接受大小写字母组合或特殊字符组合(~/!/@/#/^/&/`/?/+/-/*//(除号)/%/</>/=),其中常见的用法是“//”。
  • 符号组合中尽量使用无歧义符号组合,特殊符号组合(注释符:“\*”、“--”,以加号“+”或减号“-”结尾的符号组合)目前不支持用于delimiter命名。
  • delimiter长度范围:0~15。
  • 设置的结束符的级别是会话级别的,当切换数据库时delimiter_name会设置为默认值“;”。
  • 用户如果想使用其他字符组合例如“adbc $$”,可以使用引号包含,例如delimiter "adbc $$",但使用时也需要使用引号包含,例如:select 1"adbc $$"。
  • delimiter分隔符只有sql_compatibility = 'B'时支持。
提示

您即将访问非华为云网站,请注意账号财产安全

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容