postgres 15源码浅析（2）—— psql新功能\dconfig

摘要

翻了一下PostgreSQL 15的release文档，发现psql也有了10余项的升级，一起来撸一下其中一项新的功能的代码——\dconfig.

环境及代码

环境

我这里使用的是本机win11 的WSL ubuntu。

代码

代码用的是最新的master分支，应该和15beta差不多吧。

psql代码结构

psql的代码结构很简单，基本就是启动之后在MainLoop函数中等待接收处理命令行的字符输入（细节以后可以慢慢撸，今天主要看看\dconfig这个命令是如何处理），接收到命令后做简单的处理，如果是’\'反斜杠的命令，则进入HandleSlashCmds函数进行处理，后续交由execcommand来执行具体的命令，\dconfig属于\d的子命令，因此被分配到exec_command**_d**函数中，最终交由describeConfigurationParameters函数通过libpq驱动执行相应的sql。

以上是调用栈，比较简单清晰，不详细介绍了。

\dconfig命令

改命令是由describeConfigurationParameters函数进行处理的，这些命令处理函数基本上都长成一个样子，即有3个参数。

• pattern：子命令或命令参数，比如只想看其中一个参数，可以在\dconfig 后面加参数名。 \dconfig shared_memory_size

postgres@LAPTOP-4OF1323N:~$ psql
psql (15beta1)
Type "help" for help.

postgres=# \dconfig shared_memory_size
List of configuration parameters
     Parameter      | Value
--------------------+-------
 shared_memory_size | 143MB
(1 row)

• verbose：是否显示详细信息，即+号

postgres=# \dconfig+ shared_memory_size
                  List of configuration parameters
     Parameter      | Value |  Type   | Context  | Access privileges
--------------------+-------+---------+----------+-------------------
 shared_memory_size | 143MB | integer | internal |
(1 row)

postgres=#

• showSystem：显示系统(级别)信息，即S

这个命令没有S的信息，函数里面没有showSystem的处理

不带参数执行

	printfPQExpBuffer(&buf,
					  "SELECT s.name AS \"%s\", "
					  "pg_catalog.current_setting(s.name) AS \"%s\"",
					  gettext_noop("Parameter"),
					  gettext_noop("Value"));

在qsql开启-E选型执行

可以看到实际上数据是从pg_catalog.pg_settings里面取到的。

带参数执行

	if (pattern)
		processSQLNamePattern(pset.db, &buf, pattern,
							  false, false,
							  NULL, "pg_catalog.lower(s.name)", NULL,
							  NULL, NULL, NULL);

可以看到多了查询条件。

详细信息

	if (verbose)
	{
		appendPQExpBuffer(&buf,", s.vartype AS \"%s\", s.context AS \"%s\", ",
						  gettext_noop("Type"),
						  gettext_noop("Context"));
		if (pset.sversion >= 150000)
			printACLColumn(&buf, "p.paracl");
		else
			appendPQExpBuffer(&buf, "NULL AS \"%s\"",
						gettext_noop("Access privileges"));
	}

结束

这部分的代码比较简单，但是新增\dconfig命令的目的属实有点看不懂了，感觉有点鸡肋了，因为在psql里面有show命令，在外面有pg_config命令，都有类似\dconfig的功能。

不过，撸了一遍psql的代码之后，感觉解析命令代码的地方可以做一些改动，变成可以读取配置将常用的sql写入配置文件，这样用户可以编辑配置文件自定常用命令。比如DBA们往往都总结了一些日常巡检的sql或者自己排查问题的sql。那么把他们写入一个key/value的配置文件中用psql来驱动调用这些SQL。每一个长命令对应一个别名（key），例如：

• 配置：

Key	Value
link	select state,count(1) from pg_stat_activity group by 1;

在psql里面 输入命令\xlink，则显示：“连接状态，是否有长事务，活跃连接数占比”；

当然也可以用一个命令查看慢sql，\xslow等等……，命令名称可自己定义。

这个先留个坑，应该比较好实现，但因为我不了解DBA的习惯，不知道DBA们是不是觉得这个功能实用——“自定义命令”的psql。如果觉得有用欢迎大家留言，我好有动力去实现这个功能。

备注

往期挖的坑，后续填上。

待填的坑	挖坑时间
理解bki	2022-05-22
实现自定义命令的psql	2022-05-24