在知识库中专注阅读，并随时返回相关工具与课程
大家好，这里是公众号 DBA学习之路，分享一些学习国产数据库路上的知识和经验。 @TOC目录 经常使用 Oracle 数据库的 DBA 对 sqlplus 命令肯定不陌生，而在 KingbaseES 数据库中，对应的工具就是 KSQL。 熟悉我文章的朋友可能知道，我在使用 sqlplus 工具时，经常使用 sas 来快速连接 Oracle 数据库，其实就是使用 alias 别名的方式创建了一个快捷
大家好，这里是公众号 DBA学习之路，分享一些学习国产数据库路上的知识和经验。
本章目标：掌握本章核心知识点 前置要求：完成前序章节学习 预计时长：60 分钟
经常使用 Oracle 数据库的 DBA 对 sqlplus 命令肯定不陌生，而在 KingbaseES 数据库中，对应的工具就是 KSQL。
熟悉我文章的朋友可能知道，我在使用 sqlplus 工具时，经常使用 sas 来快速连接 Oracle 数据库，其实就是使用 alias 别名的方式创建了一个快捷方式，虽然是一个小技巧，但是对数据库维护来说十分便捷。
在接触使用 KingbaseES 时，自然也想着研究一下 KSQL 有没有类似的快捷方式使用，经过仔细研究发现，KSQL 实现的方式比 Oracle 多多了，本文就介绍一下 KSQL 免密登录的几种方式，以及我总结的最佳免密配置方式。
KingbaseES KSQL 工具面向的是所有使用 KingbaseES 的用户，主要是数据库管理员人员。KSQL 是 KingbaseES 数据库的一个组件，在安装 KingbaseES 数据库时，默认会安装 KSQL。
KSQL 工具很容易使用，没接触过的建议查看 ksql 帮助命令来大致了解一下如何使用：
1[kingbase@kes:/home/kingbase]$ ksql --help2ksql是Kingbase 的交互式客户端工具。3使用方法:4 ksql [选项]... [数据库名称 [用户名称]]5通用选项:6 -c, --command=命令 执行单一命令(SQL或内部指令)然后结束7 -d, --dbname=DBNAME 指定要连接的数据库 (默认："kingbase")8 -f, --file=文件名 从文件中执行命令然后退出9 -l, --list 列出所有可用的数据库,然后退出10 -v, --set=, --variable=NAME=VALUE11 设置ksql变量NAME为VALUE12 (例如，-v ON_ERROR_STOP=1)13 -V，--version 输出版本信息，然后退出14 -X, --no-ksqlrc 不读取启动文档(~/.ksqlrc)15 -1 ("one"), --single-transaction16 作为一个单一事务来执行命令文件(如果是非交互型的)17 -?, --help[=options] 显示此帮助，然后退出18 --help=commands 列出反斜线命令，然后退出19 --help=variables 列出特殊变量，然后退出2021输入和输出选项:22 -a, --echo-all 显示所有来自于脚本的输入23 -b, --echo-errors 回显失败的命令24 -e, --echo-queries 显示发送给服务器的命令25 -E, --echo-hidden 显示内部命令产生的查询26 -L, --log-file=文件名 将会话日志写入文件27 -M, --enable-client-encryption28 启用使用客户端加密功能29 -n, --no-readline 禁用增强命令行编辑功能(readline)30 -o，--outPut=FILENAME 将查询结果发送到file(or |pipe)31 -q，--quiet 静静地运行(没有消息，只有查询输出)32 -s, --single-step 单步模式 (确认每个查询)33 -S, --single-line 单行模式 (一行就是一条 SQL 命令)3435输出格式选项 :36 -A，--no-align 不对齐表输出模式37 --csv CSV(逗号分隔值)表输出模式38 -F, --field-separator=STRING39 用于未对齐输出的字段分隔符(默认值:"|")40 -H，--html HTML表输出模式41 -P, --pset=变量[=参数] 设置将变量打印到参数的选项(查阅 \pset 命令)42 -R, --record-separator=STRING43 记录分隔符用于未对齐输出(默认:newline)44 -t, --tuples-only 只打印记录i45 -T, --table-attr=文本 设定 HTML 表格标记属性（例如,宽度,边界)46 -x，--expanded 打开扩展表outPut47 -z, --field-separator-zero48 将未对齐输出的字段分隔符设置为零字节49 -0, --record-separator-zero50 将未对齐输出的记录分隔符设置为零字节5152联接选项:53 -h, --host=主机名 数据库服务器主机或socket目录(默认："本地接口")54 -p, --port=端口 数据库服务器的端口(默认："54321")55 -U，--username=USERNAME 数据库用户名(默认:"kingbase")56 -w, --no-password 永远不提示输入口令57 -W, --password 强制口令提示 (自动)58 -C，--client-cert-path cert-authentication文件路径59 -k，--client-certkey-path 证书认证私钥文件路径60 -K, --client-certpin-path 读取私钥文件的加密pin码文件路径6162更多信息，请在ksql中输入 "\?"（用于内部命令），63或者参考Kingbase ES文档中的ksql章节。这里只是简单介绍以下 KSQL 工具。
想要使用 KSQL 连接数据库，首先得知道数据库的名称，主机名，数据库用户以及数据库的端口号：
-d：要连接的数据库名称，默认为 kingbase-h：数据库服务器主机名，默认为本地接口-p：数据库服务器的端口，默认为 54321-U：数据库用户名，默认为 kingbase-w：永远不提示输入口令连接数据库：
1## 使用全参数指定方式连接，这种方式比较繁琐，但是规范2[kingbase@kes:/home/kingbase]$ ksql -d kingbase -h kes -p 54321 -U system3用户 system 的口令：4输入 "help" 来获取帮助信息.56kingbase=#为了更快捷的连接数据库，可以尝试不指定参数名称来连接，忽略参数，自动填充默认值：
1[kingbase@kes:/home/kingbase]$ ksql kingbase system2用户 system 的口令：3输入 "help" 来获取帮助信息.45kingbase=#有默认值的选项可以不用指定，当不指定参数选项时，第一个被接收到的值将被解释为数据库名称（如果已经给出数据库名称，就解释为用户名）。不指定主机名，则默认连接当前主机上的数据库。
这里参照我在 oracle 数据库的习惯，第一个想到的是使用别名的方式，实现起来最简单快捷：
1## 配置别名 ksql2cat<<-EOF>>~/.bash_profile3alias ksql='ksql -d kingbase -h kes -p 54321 -U system'4EOF56source .bash_profile78## 直接使用 ksql 连接数据库9[kingbase@kes:/home/kingbase]$ ksql10用户 system 的口令：11输入 "help" 来获取帮助信息.1213kingbase=#但是，测试下来我感觉这种方式有点鸡肋，因为需要手动输入数据库用户密码，ksql 不支持明文指定密码的选项，好像没有类似 / as sysdba 类似的本地认证登录方式（有可能支持，但是我不知道，知道的朋友可以留言告知，谢谢）。
在查阅官方文档之后发现，可以通过环境变量的方式，将 KINGBASE_DATABASE、 KINGBASE_HOST、KINGBASE_PORT、KINGBASE_USER 以及 KINGBASE_PASSWORD 设置为适当的值来实现免密登录：
1cat<<-EOF>>~/.bash_profile2export KINGBASE_HOST=kes3export KINGBASE_PORT=543214export KINGBASE_DATABASE=kingbase5export KINGBASE_USER=system6export KINGBASE_PASSWORD=kingbase7EOF89source ~/.bash_profile1011## 此时只需要直接执行 ksql 就可以连接数据库12[kingbase@kes:/home/kingbase]$ ksql13输入 "help" 来获取帮助信息.1415kingbase=#这个方式完全实现了我的需求，但是明文密码存放在环境变量配置文件中，比较容易被人看到，不太安全。
除了环境变量方式，官方提供了 ~/.kbpass 文件来避免输入密码的方式，也很方便， kbpass 文件内容格式如下：
1hostname:port:database:username:password需要注意的几点：
: 时，必须用反斜杠 \: 进行转义* 可以匹配任何字段中的任何值（密码除外）配置 kbpass 文件免密登录：
1## 创建 kbpass 文件2cat<<-EOF>~/.kbpass3kes:54321:kingbase:system:kingbase4EOF56## 授权文件 600 权限，仅用于 kingbase 用户访问7## 警告: 口令文件"/home/kingbase/.kbpass"的访问权限过大; 权限应设置为 u=rw (0600)或更少8chmod 600 ~/.kbpass910## 使用 kbpass 需要严格指定参数选项信息，否则无法匹配 kbpass 文件中的密码11[kingbase@kes:/home/kingbase]$ ksql -h kes -p 54321 -d kingbase -U system12输入 "help" 来获取帮助信息.1314kingbase=#这种方式虽然不需要明文显示密码，并且能不需要输入密码连接数据库，但是需要严格指定数据库信息，也不太方便。
使用别名的好处就是配置比较方便快捷：
1## 配置别名2cat<<-EOF>>~/.bash_profile3alias ksql='ksql -d kingbase -h kes -p 54321 -U system'4EOF56source .bash_profile78## 配置 kbpass 文件9cat<<-EOF>~/.kbpass10kes:54321:kingbase:system:kingbase11EOF1213chmod 600 ~/.kbpass1415## 免密连接16[kingbase@kes:/home/kingbase]$ ksql17输入 "help" 来获取帮助信息.1819kingbase=#如果有多个数据库实例，只需要创建多个别名，然后在 kbpass 文件中加上对应数据库行即可，例如：
1## 配置连接 test 库2cat<<-EOF>>~/.bash_profile3alias ksql1='ksql -d test -h kes -p 54321 -U system'4EOF56source .bash_profile78## kbpass 文件新增一行配置9cat<<-EOF>>~/.kbpass10kes:54321:test:system:kingbase11EOF1213## 免密连接 test 库14[kingbase@kes:/home/kingbase]$ ksql115输入 "help" 来获取帮助信息.1617test=#使用环境变量的方式：
1## 创建一个数据库名称命名的 .kingbase 环境变量文件，这样方便多个数据库进行切换2cp .bash_profile .kingbase34## 增加对应环境变量的配置信息，不需要加密码变量5cat<<-EOF>>~/.kingbase6export KINGBASE_HOST=kes7export KINGBASE_PORT=543218export KINGBASE_DATABASE=kingbase9export KINGBASE_USER=system10EOF1112source ~/.kingbase1314## 配置 kbpass 文件15cat<<-EOF>~/.kbpass16kes:54321:kingbase:system:kingbase17EOF1819chmod 600 ~/.kbpass2021## 免密连接22[kingbase@kes:/home/kingbase]$ ksql23输入 "help" 来获取帮助信息.2425kingbase=#如果有多个数据库实例，只需要创建多个环境变量文件，然后在 kbpass 文件中加上对应数据库行即可，例如：
1## 创建一个数据库名称命名的 .test 环境变量文件2cp .bash_profile .test34## 增加对应环境变量的配置信息，不需要加密码变量5cat<<-EOF>>~/.test6export KINGBASE_HOST=kes7export KINGBASE_PORT=543218export KINGBASE_DATABASE=test9export KINGBASE_USER=system10EOF1112source ~/.test1314## kbpass 文件新增一行配置15cat<<-EOF>>~/.kbpass16kes:54321:test:system:kingbase17EOF1819## 免密连接 test 库20[kingbase@kes:/home/kingbase]$ ksql21输入 "help" 来获取帮助信息.2223test=#本文介绍了 KSQL 连接 KingbaseES 数据库的多种方式，通过以上测试以及对安全性的要求，建议大家可以使用 alias 或环境变量 + kbpass 的方式来配置免密登录，配置简单，使用便捷。
后来，群友提供了一个官方本地认证的免密方式，配置比较简单。
修改 /data/sys_hba.conf 配置文件：
1# TYPE DATABASE USER ADDRESS METHOD23# "local" is for Unix domain socket connections only4local all all scram-sha-256将 local 认证方式 scram-sha-256 修改为 trust 即可：
1# TYPE DATABASE USER ADDRESS METHOD23# "local" is for Unix domain socket connections only4local all all trust重启数据库生效：
1sys_ctl restart本地免密连接：
1[kingbase@kes:/home/kingbase]$ ksql -U sso test -p 543212ksql (V8.0)3输入 "help" 来获取帮助信息.45test=> exit如果遇到无法免密登录的情况：
1[kingbase@kes:/home/kingbase]$ ksql -U sso test -p 543212用户 sso 的口令：3ksql: 错误: 无法连接到服务器：fe_sendauth: no password supplied可能是因为配置了以下环境变量：
1export KINGBASE_HOST=kes2export KINGBASE_PORT=543213export KINGBASE_DATABASE=test4export KINGBASE_USER=system注释之后，退出重登 kingbase 主机用户即可：
1[kingbase@kes:/home/kingbase]$ exit2注销3[root@kes ~]# su - kingbase4上一次登录： 六 10月 12 10:29:19 CST 2024 pts/0 上5[kingbase@kes:/home/kingbase]$ ksql -U sso test -p 543216ksql (V8.0)7输入 "help" 来获取帮助信息.89test=> exit所以，看起来最佳免密方式为：sys_hba.conf + alias
1alias ksystem='ksql test system'2alias ksso='ksql test sso'别名连接：
1[kingbase@kes:/home/kingbase]$ ksystem 2ksql (V8.0)3输入 "help" 来获取帮助信息.45test=# \conninfo6以用户 "system" 的身份，通过套接字"/tmp"在端口"54321"连接到数据库 "test"7test=# \q8[kingbase@kes:/home/kingbase]$ ksso9ksql (V8.0)10输入 "help" 来获取帮助信息.1112test=> \conninfo 13以用户 "sso" 的身份，通过套接字"/tmp"在端口"54321"连接到数据库 "test"14test=> \q后续补充就到这了。