每个具有任何手动创建的初始数据的目录(有些没有)都有一个对应的 .dat 文件,其中包含其初始数据的可编辑格式。
每个 .dat 文件都包含 Perl 数据结构文字,这些文字只是被 eval 来生成一个内存中的数据结构,该结构由哈希引用的数组组成,每个目录行一个。下面是从 pg_database.dat 中稍微修改的摘录,将演示主要特性
[
# A comment could appear here.
{ oid => '1', oid_symbol => 'Template1DbOid',
descr => 'database\'s default template',
datname => 'template1', encoding => 'ENCODING',
datlocprovider => 'LOCALE_PROVIDER', datistemplate => 't',
datallowconn => 't', dathasloginevt => 'f', datconnlimit => '-1', datfrozenxid => '0',
datminmxid => '1', dattablespace => 'pg_default', datcollate => 'LC_COLLATE',
datctype => 'LC_CTYPE', datlocale => 'DATLOCALE', datacl => '_null_' },
]
需要注意的点
文件的整体布局是:左方括号,一个或多个花括号集,每个花括号集代表一个目录行,右方括号。在每个右花括号后写一个逗号。
在每个目录行中,写入逗号分隔的key => value对。允许的key是目录的列名,加上元数据键oid、oid_symbol、array_type_oid和descr。(oid和oid_symbol的使用在下面的第 67.2.2 节中描述,而array_type_oid在第 67.2.4 节中描述。descr为对象提供描述字符串,该字符串将根据需要插入到pg_description或pg_shdescription中。)虽然元数据键是可选的,但必须提供目录的已定义的所有列,除非目录的 .h 文件指定了列的默认值。(在上面的示例中,datdba 字段已被省略,因为 pg_database.h 为其提供了合适的默认值。)
所有值都必须用单引号引起来。用反斜杠转义值中使用的单引号。用作数据的反斜杠可以(但不需要)加倍;这遵循 Perl 的简单引号文字的规则。请注意,作为数据出现的反斜杠将按照与转义字符串常量相同的规则(请参阅第 4.1.2.2 节),被引导扫描器视为转义;例如,\t 转换为制表符。如果实际上希望在最终值中包含反斜杠,则需要写四个反斜杠:Perl 会删除两个,留下 \\ 供引导扫描器查看。
空值用 _null_ 表示。(请注意,无法创建仅为该字符串的值。)
注释以 # 开头,并且必须在其自己的行上。
作为其他目录条目的 OID 的字段值应由符号名称而不是实际的数字 OID 表示。(在上面的示例中,dattablespace 包含这样的引用。)这在下面的第 67.2.3 节中描述。
由于哈希是无序的数据结构,因此字段顺序和行布局在语义上并不重要。但是,为了保持一致的外观,我们设置了一些规则,这些规则由格式化脚本reformat_dat_file.pl应用
在每对花括号内,元数据字段 oid、oid_symbol、array_type_oid 和 descr(如果存在)首先出现,然后按照定义的顺序出现目录自己的字段。
根据需要,在字段之间插入换行符,以将行长度限制为 80 个字符(如果可能)。元数据字段和常规字段之间也会插入换行符。
如果目录的 .h 文件为列指定了默认值,并且数据条目具有相同的值,则 reformat_dat_file.pl 将从数据文件中省略它。这使数据表示保持紧凑。
reformat_dat_file.pl 按原样保留空行和注释行。
建议在提交目录数据补丁之前运行 reformat_dat_file.pl。为了方便起见,您可以简单地更改为 src/include/catalog/ 并运行 make reformat-dat-files。
如果要添加使数据表示更小的新方法,则必须在 reformat_dat_file.pl 中实现它,并教导 Catalog::ParseData() 如何将数据扩展回完整表示形式。
可以通过写入 oid => 元数据字段为初始数据中出现的目录行分配手动分配的 OID。此外,如果分配了 OID,可以通过写入 nnnnoid_symbol => 元数据字段为该 OID 创建 C 宏。name
如果其他预加载的行中有对它们的 OID 引用,则预加载的目录行必须具有预先分配的 OID。如果必须从 C 代码中引用行的 OID,也需要预先分配的 OID。如果两种情况都不适用,则可以省略 oid 元数据字段,在这种情况下,引导代码会自动分配一个 OID。在实践中,我们通常为给定目录中所有或所有预加载的行预先分配 OID,即使实际上只交叉引用了其中的一部分。
在 C 代码中编写任何 OID 的实际数值被认为是非常糟糕的形式;请始终使用宏。对 pg_proc OID 的直接引用非常常见,以至于有一个特殊的机制可以自动创建必要的宏;请参阅 src/backend/utils/Gen_fmgrtab.pl。类似地,但由于历史原因,不是以相同的方式完成的,有一种自动方法可以为 pg_type OID 创建宏。oid_symbol 条目因此在这两个目录中不是必需的。同样,系统目录和索引的 pg_class OID 的宏会自动设置。对于所有其他系统目录,您必须通过 oid_symbol 条目手动指定所需的任何宏。
要查找新的预加载行的可用 OID,请运行脚本 src/include/catalog/unused_oids。它打印未使用的 OID 的包含范围(例如,输出行 45-900 表示 OID 45 到 900 尚未分配)。当前,OID 1–9999 保留用于手动分配;unused_oids 脚本只是查看目录头和 .dat 文件,以查看哪些 OID 没有出现。您还可以使用 duplicate_oids 脚本来检查错误。(genbki.pl 将为任何没有手动分配 OID 的行分配 OID,并且它还会在编译时检测重复的 OID。)
当为不希望立即提交的补丁选择 OID 时,最佳做法是使用一组或多或少连续的 OID,从 8000-9999 范围内的某个随机选择开始。这最大限度地降低了与其他同时开发的补丁发生 OID 冲突的风险。为了使 8000-9999 范围可用于开发目的,在将补丁提交到主 git 存储库后,其 OID 应重新编号到该范围以下的可用空间中。通常,这将在每个开发周期结束时完成,同时移动该周期中提交的补丁消耗的所有 OID。脚本 renumber_oids.pl 可用于此目的。如果发现未提交的补丁与最近提交的补丁存在 OID 冲突,renumber_oids.pl 也可能有助于从这种情况中恢复。
由于这种可能重新编号补丁分配的 OID 的约定,在补丁包含在正式版本中之前,补丁分配的 OID 不应被视为稳定。但是,我们不会更改手动分配的对象 OID 一旦发布,因为这会产生各种兼容性问题。
如果 genbki.pl 需要为没有手动分配 OID 的目录条目分配 OID,它将使用 10000-11999 范围内的值。服务器的 OID 计数器在引导运行开始时设置为 10000,以便在引导处理期间动态创建的任何对象也在此范围内接收 OID。(通常的 OID 分配机制会注意防止任何冲突。)
OID 低于 FirstUnpinnedObjectId (12000) 的对象被认为是“已固定”,阻止它们被删除。(有少数例外,它们在 IsPinnedObject() 中是硬编码的。)initdb 会在准备好创建未固定的对象后立即强制将 OID 计数器提升到 FirstUnpinnedObjectId。因此,在 initdb 的后期阶段创建的对象,例如在运行 information_schema.sql 脚本时创建的对象,不会被固定,而 genbki.pl 已知的所有对象都将被固定。
在正常数据库操作期间分配的 OID 被限制为 16384 或更高。这确保了 10000-16383 范围可用于 genbki.pl 自动分配的或在 initdb 期间自动分配的 OID。这些自动分配的 OID 不被认为是稳定的,并且可能因一个安装而异。
原则上,从一个初始目录行到另一个目录行的交叉引用可以通过仅在引用字段中写入被引用行的预分配 OID 来完成。但是,这违反了项目策略,因为它容易出错,难以读取,并且如果重新编号新分配的 OID 则容易出现故障。因此 genbki.pl 提供了机制来写入符号引用。规则如下
通过将 BKI_LOOKUP( 附加到列的定义中,可以在特定的目录列中启用符号引用,其中 lookuprule)lookuprule 是被引用目录的名称,例如 pg_proc。 BKI_LOOKUP 可以附加到类型为 Oid、regproc、oidvector 或 Oid[] 的列;在后两种情况下,它意味着对数组的每个元素执行查找。
也可以将 BKI_LOOKUP(encoding) 附加到整数列,以引用字符集编码,这些编码当前不表示为目录 OID,但 genbki.pl 知道其一组值。
在某些目录列中,允许条目为零而不是有效的引用。如果允许这样做,请写 BKI_LOOKUP_OPT 而不是 BKI_LOOKUP。然后,您可以为条目写 0。(如果该列声明为 regproc,您可以选择写 - 而不是 0。)除了此特殊情况,BKI_LOOKUP 列中的所有条目都必须是符号引用。 genbki.pl 将警告无法识别的名称。
大多数类型的目录对象都只是通过它们的名称来引用。请注意,类型名称必须与被引用的 pg_type 条目的 typname 完全匹配;您不能使用任何别名,例如 integer 代表 int4。
如果一个函数在 pg_proc.dat 条目中是唯一的(这就像 regproc 输入一样),则可以使用其 proname 来表示。否则,请像 regprocedure 一样将其写为 proname(argtypename,argtypename,...)。参数类型名称必须与它们在 pg_proc.dat 条目的 proargtypes 字段中的拼写完全相同。不要插入任何空格。
运算符由 oprname(lefttype,righttype) 表示,类型名称的拼写必须与它们在 pg_operator.dat 条目的 oprleft 和 oprright 字段中出现的拼写完全一致。(对于一元运算符的省略操作数,请写 0。)
操作类和操作族的名称仅在访问方法内是唯一的,因此它们由 access_method_name/object_name 表示。
在所有这些情况下,都没有为模式限定提供任何规定;在引导期间创建的所有对象都应位于 pg_catalog 模式中。
genbki.pl 在运行时会解析所有符号引用,并将简单的数字 OID 放入生成的 BKI 文件中。因此,引导后端无需处理符号引用。
即使目录没有需要查找的初始数据,也最好使用 BKI_LOOKUP 或 BKI_LOOKUP_OPT 标记 OID 引用列。这允许 genbki.pl 记录系统目录中存在的外键关系。该信息在回归测试中用于检查不正确的条目。另请参阅宏 DECLARE_FOREIGN_KEY、DECLARE_FOREIGN_KEY_OPT、DECLARE_ARRAY_FOREIGN_KEY 和 DECLARE_ARRAY_FOREIGN_KEY_OPT,它们用于声明对于 BKI_LOOKUP 而言过于复杂的外键关系(通常是多列外键)。
大多数标量数据类型都应具有对应的数组类型(即,元素类型为标量类型的标准 varlena 数组类型,并通过标量类型的 pg_type 条目的 typarray 字段引用)。在大多数情况下,genbki.pl 能够自动生成数组类型的 pg_type 条目。
要使用此功能,只需在标量类型的 pg_type 条目中写入 array_type_oid => 元数据字段,指定用于数组类型的 OID。然后,您可以省略 nnnntyparray 字段,因为它将自动填充该 OID。
生成的数组类型的名称是标量类型的名称,并前置下划线。数组条目的其他字段从 pg_type.h 中的 BKI_ARRAY_DEFAULT( 注释填充,如果不存在该注释,则从标量类型复制。(value)typalign 也有一个特殊情况。)然后,两个条目的 typelem 和 typarray 字段会设置为相互交叉引用。
以下是一些关于在更新目录数据文件时执行常见任务的最简单方法的建议。
向具有默认值的目录添加新列: 使用 BKI_DEFAULT( 注释将该列添加到头文件中。只需通过在需要非默认值的现有行中添加字段来调整数据文件。value)
向没有默认值的现有列添加默认值: 向头文件添加 BKI_DEFAULT 注释,然后运行 make reformat-dat-files 以删除现在多余的字段条目。
删除列(无论其是否具有默认值): 从头文件中删除该列,然后运行 make reformat-dat-files 以删除现在无用的字段条目。
更改或删除现有默认值: 您不能简单地更改头文件,因为这会导致当前数据被错误地解释。首先运行 make expand-dat-files 以使用所有显式插入的默认值重写数据文件,然后更改或删除 BKI_DEFAULT 注释,然后运行 make reformat-dat-files 以再次删除多余的字段。
Ad-hoc 批量编辑: 可以修改 reformat_dat_file.pl 以执行多种类型的批量更改。查找其块注释,显示可以在其中插入一次性代码的位置。在以下示例中,我们将把 pg_proc 中的两个布尔字段合并为一个 char 字段
将具有默认值的新列添加到 pg_proc.h
+ /* see PROKIND_ categories below */ + char prokind BKI_DEFAULT(f);
创建一个基于 reformat_dat_file.pl 的新脚本以动态插入适当的值
- # At this point we have the full row in memory as a hash
- # and can do any operations we want. As written, it only
- # removes default values, but this script can be adapted to
- # do one-off bulk-editing.
+ # One-off change to migrate to prokind
+ # Default has already been filled in by now, so change to other
+ # values as appropriate
+ if ($values{proisagg} eq 't')
+ {
+ $values{prokind} = 'a';
+ }
+ elsif ($values{proiswindow} eq 't')
+ {
+ $values{prokind} = 'w';
+ }
运行新脚本
$ cd src/include/catalog $ perl rewrite_dat_with_prokind.pl pg_proc.dat
此时,pg_proc.dat 包含所有三个列:prokind、proisagg 和 proiswindow,尽管它们仅在具有非默认值的行中显示。
从 pg_proc.h 中删除旧列
- /* is it an aggregate? */ - bool proisagg BKI_DEFAULT(f); - - /* is it a window function? */ - bool proiswindow BKI_DEFAULT(f);
最后,运行 make reformat-dat-files 以从 pg_proc.dat 中删除无用的旧条目。
有关用于批量编辑的脚本的更多示例,请参见附加到此消息的 convert_oid2name.pl 和 remove_pg_type_oid_symbols.pl:https://postgresql.ac.cn/message-id/CAJVSVGVX8gXnPm+Xa=DxR7kFYprcQ1tNcCT5D0O3ShfnM6jehA@mail.gmail.com
如果您发现文档中有任何不正确、与您对特定功能的体验不符或需要进一步澄清的地方,请使用此表格报告文档问题。