金仓数据库KingbaseES客户端应用参考手册--6. dropuser

6.1. 简介：

dropuser — 删除一个KingbaseES用户账户。

dropuser是一个命令行工具，该命令行工具位于KingbaseES安装目录的bin目录下。用来删除一个已有的KingbaseES用户。只有超级用户以及具有CREATEROLE特权的用户能够移除KingbaseES用户（要移除一个超级用户，你必须自己是一个超级用户）。

dropuser是SQL命令 DROP ROLE 的一个包装器。在通过这个工具和其他方法访问服务器来删除用户之间没有实质性的区别。

6.2. 命令行参数：

dropuser [ connection-option ...] [ option ...] [ username ]

6.3. 参数说明：

dropuser接受下列命令行参数：

username

指定要删除的KingbaseES用户的名字。如果没有在命令行指定并且使用了-i/--interactive选项，你将被提醒要求输入一个用户名。

-e --echo

回显dropuser生成并发送给服务器的命令信息。

-i --interactive

在实际删除该用户之前提示要求确认，并且在没有在命令行指定用户名提示要求输入一个用户名。

-V --version

打印dropuser版本信息并退出。

--if-exists

如果用户不存在时不要抛出一个错误。在这种情况下将发出一个提示。

-? --help

显示有关dropuser命令的帮助并退出。

dropuser也接受下列命令行参数作为连接参数：

-h host --host=host

指定运行服务器的机器的主机名。如果该值以一个斜线开始，它被用作 Unix 域套接字的目录。

-p port --port=port

指定服务器正在监听连接的 TCP 端口或本地 Unix 域套接字文件扩展。

-U username --username=username

要使用哪个用户来连接数据库（不是要移除的用户名）。

-w --no-password

从不发出一个输入密码提示。如果服务器要求密码认证并且没有其他方式提供密码（例如一个.kbpass文件），那么连接尝试将会失败。这个选项对于批处理任务和脚本有用，因为在其中没有一个用户来输入密码。

-W --password

强制dropuser在连接到一个数据库之前提示要求输入一个密码。

这个选项不是必不可少的，因为如果服务器要求密码认证，dropuser将自动提示要求输入一个密码。但是，dropuser将浪费一次连接尝试来发现服务器想要一个密码。在某些情况下值得用-W来避免额外的连接尝试。

6.4. 环境变量：

KINGBASE_HOST

指定要连接的主机名，默认连接到localhost。

KINGBASE_PORT

指定要连接的服务器的端口号，默认为54321。需要根据数据库实际部署修订。

KCIUSER

指定要使用哪个用户连接数据库。默认与使用数据库的操作系统用户名相同。

SYS_COLOR

指定是否在诊断消息中使用颜色。可能的值是always, auto, never. 和大部分其他KingbaseES工具相似，这个工具也使用libkci支持的环境变量。

6.5. 错误信息诊断：

在有错误发生时，可以在 DROP ROLE 和 ksql 中找潜在问题和错误消息的提示信息。数据库服务器必须运行在目标主机上。同样，任何libkci前端库使用的默认连接设置和环境变量都将适用于此。

6.6. 示例：

要从默认数据库服务器删除用户joe：

$ dropuser joe

要使用在主机eden、端口 5000 上的服务器删除用户joe，并带有验证和回显，可使用下面的命令：

$ dropuser -p 5000 -h eden -i -e joe
Role "joe" will be permanently removed.
Are you sure? (y/n) y
DROP ROLE joe;

6.7. 备注：

无

6.8. 参考：

createuser , DROP ROLE