支持的版本: 当前 (17) / 16 / 15 / 14 / 13
开发版本: devel
不支持的版本: 12 / 11 / 10 / 9.6 / 9.5 / 9.4 / 9.3 / 9.2 / 9.1 / 9.0 / 8.4 / 8.3

F.23. pageinspect — 数据库页面的底层检查 #

pageinspect 模块提供了一些函数,允许您在低级别检查数据库页面的内容,这对于调试很有用。所有这些函数只能由超级用户使用。

F.23.1. 通用函数 #

get_raw_page(relname text, fork text, blkno bigint) returns bytea

get_raw_page 读取指定关系的指定块,并将其副本作为 bytea 值返回。这允许获取该块的单个时间一致的副本。fork 对于主数据分叉应为 'main',对于 空闲空间映射应为 'fsm',对于 可见性映射应为 'vm',对于初始化分叉应为 'init'

get_raw_page(relname text, blkno bigint) returns bytea

get_raw_page 的简写版本,用于从主分叉读取。等效于 get_raw_page(relname, 'main', blkno)

page_header(page bytea) returns record

page_header 显示所有 PostgreSQL 堆和索引页面的通用字段。

应传递使用 get_raw_page 获取的页面映像。例如

test=# SELECT * FROM page_header(get_raw_page('pg_class', 0));
    lsn    | checksum | flags  | lower | upper | special | pagesize | version | prune_xid
-----------+----------+--------+-------+-------+---------+----------+---------+-----------
 0/24A1B50 |        0 |      1 |   232 |   368 |    8192 |     8192 |       4 |         0

返回的列对应于 PageHeaderData 结构中的字段。有关详细信息,请参见 src/include/storage/bufpage.h

checksum 字段是存储在页面中的校验和,如果页面以某种方式损坏,则该校验和可能不正确。如果未为此实例启用数据校验和,则存储的值没有意义。

page_checksum(page bytea, blkno bigint) returns smallint

page_checksum 计算页面的校验和,就像它位于给定的块中一样。

应传递使用 get_raw_page 获取的页面映像。例如

test=# SELECT page_checksum(get_raw_page('pg_class', 0), 0);
 page_checksum
---------------
         13443

请注意,校验和取决于块号,因此应传递匹配的块号(除非进行深奥的调试)。

使用此函数计算的校验和可以与函数 page_headerchecksum 结果字段进行比较。如果为此实例启用了数据校验和,则两个值应相等。

fsm_page_contents(page bytea) returns text

fsm_page_contents 显示一个FSM页面的内部节点结构。例如

test=# SELECT fsm_page_contents(get_raw_page('pg_class', 'fsm', 0));

输出是一个多行字符串,页面内的二叉树中每个节点一行。仅打印那些非零的节点。还打印了所谓的“下一个”指针,该指针指向页面中要返回的下一个槽。

有关FSM页面的结构的更多信息,请参见 src/backend/storage/freespace/README

F.23.2. 堆函数 #

heap_page_items(page bytea) returns setof record

heap_page_items 显示堆页面上的所有行指针。对于那些正在使用的行指针,还会显示元组头以及元组原始数据。所有元组都会显示,无论这些元组在复制原始页面时是否对 MVCC 快照可见。

应传递使用 get_raw_page 获取的堆页面映像。例如

test=# SELECT * FROM heap_page_items(get_raw_page('pg_class', 0));

有关返回字段的说明,请参见 src/include/storage/itemid.hsrc/include/access/htup_details.h

heap_tuple_infomask_flags 函数可用于解包堆元组的 t_infomaskt_infomask2 的标志位。

tuple_data_split(rel_oid oid, t_data bytea, t_infomask integer, t_infomask2 integer, t_bits text [, do_detoast bool]) returns bytea[]

tuple_data_split 将元组数据拆分为属性,方式与后端内部相同。

test=# SELECT tuple_data_split('pg_class'::regclass, t_data, t_infomask, t_infomask2, t_bits) FROM heap_page_items(get_raw_page('pg_class', 0));

应使用与 heap_page_items 的返回属性相同的参数调用此函数。

如果 do_detoasttrue,则将根据需要对属性进行反压缩。默认值为 false

heap_page_item_attrs(page bytea, rel_oid regclass [, do_detoast bool]) returns setof record

heap_page_item_attrsheap_page_items 等效,不同之处在于它将元组原始数据作为属性数组返回,这些属性可以通过 do_detoast 可选地进行反压缩,默认值为 false

应传递使用 get_raw_page 获取的堆页面映像。例如

test=# SELECT * FROM heap_page_item_attrs(get_raw_page('pg_class', 0), 'pg_class'::regclass);
heap_tuple_infomask_flags(t_infomask integer, t_infomask2 integer) returns record

heap_tuple_infomask_flagsheap_page_items 返回的 t_infomaskt_infomask2 解码为人类可读的由标志名称组成的数组集合,其中一列包含所有标志,另一列包含组合标志。例如

test=# SELECT t_ctid, raw_flags, combined_flags
         FROM heap_page_items(get_raw_page('pg_class', 0)),
           LATERAL heap_tuple_infomask_flags(t_infomask, t_infomask2)
         WHERE t_infomask IS NOT NULL OR t_infomask2 IS NOT NULL;

应使用与 heap_page_items 的返回属性相同的参数调用此函数。

对于考虑到多个原始位的值的源代码级宏(例如 HEAP_XMIN_FROZEN),将显示组合标志。

有关返回的标志名称的说明,请参见 src/include/access/htup_details.h

F.23.3. B 树函数 #

bt_metap(relname text) returns record

bt_metap 返回有关 B 树索引元页面的信息。例如

test=# SELECT * FROM bt_metap('pg_cast_oid_index');
-[ RECORD 1 ]-------------+-------
magic                     | 340322
version                   | 4
root                      | 1
level                     | 0
fastroot                  | 1
fastlevel                 | 0
last_cleanup_num_delpages | 0
last_cleanup_num_tuples   | 230
allequalimage             | f
bt_page_stats(relname text, blkno bigint) returns record

bt_page_stats 返回有关 B 树索引数据页面的摘要信息。例如

test=# SELECT * FROM bt_page_stats('pg_cast_oid_index', 1);
-[ RECORD 1 ]-+-----
blkno         | 1
type          | l
live_items    | 224
dead_items    | 0
avg_item_size | 16
page_size     | 8192
free_size     | 3668
btpo_prev     | 0
btpo_next     | 0
btpo_level    | 0
btpo_flags    | 3
bt_multi_page_stats(relname text, blkno bigint, blk_count bigint) returns setof record

bt_multi_page_stats 返回与 bt_page_stats 相同的信息,但会对从 blkno 开始并延伸 blk_count 页的页面范围中的每个页面执行此操作。如果 blk_count 为负数,则会报告从 blkno 到索引末尾的所有页面。例如

test=# SELECT * FROM bt_multi_page_stats('pg_proc_oid_index', 5, 2);
-[ RECORD 1 ]-+-----
blkno         | 5
type          | l
live_items    | 367
dead_items    | 0
avg_item_size | 16
page_size     | 8192
free_size     | 808
btpo_prev     | 4
btpo_next     | 6
btpo_level    | 0
btpo_flags    | 1
-[ RECORD 2 ]-+-----
blkno         | 6
type          | l
live_items    | 367
dead_items    | 0
avg_item_size | 16
page_size     | 8192
free_size     | 808
btpo_prev     | 5
btpo_next     | 7
btpo_level    | 0
btpo_flags    | 1
bt_page_items(relname text, blkno bigint) returns setof record

bt_page_items 返回有关 B 树索引页面上所有项的详细信息。例如

test=# SELECT itemoffset, ctid, itemlen, nulls, vars, data, dead, htid, tids[0:2] AS some_tids
        FROM bt_page_items('tenk2_hundred', 5);
 itemoffset |   ctid    | itemlen | nulls | vars |          data           | dead |  htid  |      some_tids
------------+-----------+---------+-------+------+-------------------------+------+--------+---------------------
          1 | (16,1)    |      16 | f     | f    | 30 00 00 00 00 00 00 00 |      |        |
          2 | (16,8292) |     616 | f     | f    | 24 00 00 00 00 00 00 00 | f    | (1,6)  | {"(1,6)","(10,22)"}
          3 | (16,8292) |     616 | f     | f    | 25 00 00 00 00 00 00 00 | f    | (1,18) | {"(1,18)","(4,22)"}
          4 | (16,8292) |     616 | f     | f    | 26 00 00 00 00 00 00 00 | f    | (4,18) | {"(4,18)","(6,17)"}
          5 | (16,8292) |     616 | f     | f    | 27 00 00 00 00 00 00 00 | f    | (1,2)  | {"(1,2)","(1,19)"}
          6 | (16,8292) |     616 | f     | f    | 28 00 00 00 00 00 00 00 | f    | (2,24) | {"(2,24)","(4,11)"}
          7 | (16,8292) |     616 | f     | f    | 29 00 00 00 00 00 00 00 | f    | (2,17) | {"(2,17)","(11,2)"}
          8 | (16,8292) |     616 | f     | f    | 2a 00 00 00 00 00 00 00 | f    | (0,25) | {"(0,25)","(3,20)"}
          9 | (16,8292) |     616 | f     | f    | 2b 00 00 00 00 00 00 00 | f    | (0,10) | {"(0,10)","(0,14)"}
         10 | (16,8292) |     616 | f     | f    | 2c 00 00 00 00 00 00 00 | f    | (1,3)  | {"(1,3)","(3,9)"}
         11 | (16,8292) |     616 | f     | f    | 2d 00 00 00 00 00 00 00 | f    | (6,28) | {"(6,28)","(11,1)"}
         12 | (16,8292) |     616 | f     | f    | 2e 00 00 00 00 00 00 00 | f    | (0,27) | {"(0,27)","(1,13)"}
         13 | (16,8292) |     616 | f     | f    | 2f 00 00 00 00 00 00 00 | f    | (4,17) | {"(4,17)","(4,21)"}
(13 rows)

这是一个 B 树叶子页面。所有指向表的元组恰好都是发布列表元组(所有这些元组总共存储 100 个 6 字节的 TID)。在 itemoffset 编号为 1 的位置还有一个高键元组。ctid 用于存储有关此示例中每个元组的编码信息,尽管叶子页面元组通常直接在 ctid 字段中存储堆 TID。tids 是存储为发布列表的 TID 列表。

在内部页面(未显示)中,ctid 的块号部分是下行链路,它是索引本身中另一个页面的块号。ctid 的偏移量部分(第二个数字)存储有关元组的编码信息,例如存在的列数(后缀截断可能已删除不需要的后缀列)。截断的列被视为具有值负无穷大

htid 显示元组的堆 TID,无论底层的元组表示形式如何。此值可能与 ctid 匹配,或者可能从发布列表元组和内部页面元组使用的替代表示形式中解码而来。内部页面中的元组通常会截断实现级别的堆 TID 列,该列表示为 NULL htid 值。

请注意,任何非最右侧页面(在 btpo_next 字段中具有非零值的任何页面)上的第一项都是该页面的高键,这意味着其 data 用作该页面上出现的所有项的上限,而其 ctid 字段不指向另一个块。此外,在内部页面上,第一个真实数据项(不是高键的第一个项)可靠地截断了每一列,导致其 data 字段中没有实际值。但是,此类项在其 ctid 字段中具有有效的下行链路。

有关 B 树索引结构的更多详细信息,请参见 第 64.1.4.1 节。有关重复数据删除和发布列表的更多详细信息,请参见 第 64.1.4.3 节

bt_page_items(page bytea) returns setof record

也可以将页面作为 bytea 值传递给 bt_page_items。应将使用 get_raw_page 获取的页面映像作为参数传递。因此,最后一个示例也可以像这样重写

test=# SELECT itemoffset, ctid, itemlen, nulls, vars, data, dead, htid, tids[0:2] AS some_tids
        FROM bt_page_items(get_raw_page('tenk2_hundred', 5));
 itemoffset |   ctid    | itemlen | nulls | vars |          data           | dead |  htid  |      some_tids
------------+-----------+---------+-------+------+-------------------------+------+--------+---------------------
          1 | (16,1)    |      16 | f     | f    | 30 00 00 00 00 00 00 00 |      |        |
          2 | (16,8292) |     616 | f     | f    | 24 00 00 00 00 00 00 00 | f    | (1,6)  | {"(1,6)","(10,22)"}
          3 | (16,8292) |     616 | f     | f    | 25 00 00 00 00 00 00 00 | f    | (1,18) | {"(1,18)","(4,22)"}
          4 | (16,8292) |     616 | f     | f    | 26 00 00 00 00 00 00 00 | f    | (4,18) | {"(4,18)","(6,17)"}
          5 | (16,8292) |     616 | f     | f    | 27 00 00 00 00 00 00 00 | f    | (1,2)  | {"(1,2)","(1,19)"}
          6 | (16,8292) |     616 | f     | f    | 28 00 00 00 00 00 00 00 | f    | (2,24) | {"(2,24)","(4,11)"}
          7 | (16,8292) |     616 | f     | f    | 29 00 00 00 00 00 00 00 | f    | (2,17) | {"(2,17)","(11,2)"}
          8 | (16,8292) |     616 | f     | f    | 2a 00 00 00 00 00 00 00 | f    | (0,25) | {"(0,25)","(3,20)"}
          9 | (16,8292) |     616 | f     | f    | 2b 00 00 00 00 00 00 00 | f    | (0,10) | {"(0,10)","(0,14)"}
         10 | (16,8292) |     616 | f     | f    | 2c 00 00 00 00 00 00 00 | f    | (1,3)  | {"(1,3)","(3,9)"}
         11 | (16,8292) |     616 | f     | f    | 2d 00 00 00 00 00 00 00 | f    | (6,28) | {"(6,28)","(11,1)"}
         12 | (16,8292) |     616 | f     | f    | 2e 00 00 00 00 00 00 00 | f    | (0,27) | {"(0,27)","(1,13)"}
         13 | (16,8292) |     616 | f     | f    | 2f 00 00 00 00 00 00 00 | f    | (4,17) | {"(4,17)","(4,21)"}
(13 rows)

所有其他详细信息与前一个项目中的说明相同。

F.23.4. BRIN 函数 #

brin_page_type(page bytea) returns text

brin_page_type 返回给定页面的页面类型BRIN索引页面,如果页面无效,则会抛出错误BRIN页面的内部节点结构。例如

test=# SELECT brin_page_type(get_raw_page('brinidx', 0));
 brin_page_type
----------------
 meta
brin_metapage_info(page bytea) returns record

brin_metapage_info 返回有关BRIN索引元页面的各种信息。例如

test=# SELECT * FROM brin_metapage_info(get_raw_page('brinidx', 0));
   magic    | version | pagesperrange | lastrevmappage
------------+---------+---------------+----------------
 0xA8109CFA |       1 |             4 |              2
brin_revmap_data(page bytea) returns setof tid

brin_revmap_data 返回BRIN索引范围映射页面中的元组标识符列表。例如

test=# SELECT * FROM brin_revmap_data(get_raw_page('brinidx', 2)) LIMIT 5;
  pages
---------
 (6,137)
 (6,138)
 (6,139)
 (6,140)
 (6,141)
brin_page_items(page bytea, index oid) returns setof record

brin_page_items 返回存储在BRIN数据页面中的数据。例如

test=# SELECT * FROM brin_page_items(get_raw_page('brinidx', 5),
                                     'brinidx')
       ORDER BY blknum, attnum LIMIT 6;
 itemoffset | blknum | attnum | allnulls | hasnulls | placeholder | empty |    value
------------+--------+--------+----------+----------+-------------+-------+--------------
        137 |      0 |      1 | t        | f        | f           | f     |
        137 |      0 |      2 | f        | f        | f           | f     | {1 .. 88}
        138 |      4 |      1 | t        | f        | f           | f     |
        138 |      4 |      2 | f        | f        | f           | f     | {89 .. 176}
        139 |      8 |      1 | t        | f        | f           | f     |
        139 |      8 |      2 | f        | f        | f           | f     | {177 .. 264}

返回的列对应于 BrinMemTupleBrinValues 结构中的字段。有关详细信息,请参见 src/include/access/brin_tuple.h

F.23.5. GIN 函数 #

gin_metapage_info(page bytea) returns record

gin_metapage_info 返回有关GIN索引元页面的各种信息。例如

test=# SELECT * FROM gin_metapage_info(get_raw_page('gin_index', 0));
-[ RECORD 1 ]----+-----------
pending_head     | 4294967295
pending_tail     | 4294967295
tail_free_size   | 0
n_pending_pages  | 0
n_pending_tuples | 0
n_total_pages    | 7
n_entry_pages    | 6
n_data_pages     | 0
n_entries        | 693
version          | 2
gin_page_opaque_info(page bytea) returns record

gin_page_opaque_info 返回有关GIN索引不透明区域的信息,例如页面类型。例如

test=# SELECT * FROM gin_page_opaque_info(get_raw_page('gin_index', 2));
 rightlink | maxoff |         flags
-----------+--------+------------------------
         5 |      0 | {data,leaf,compressed}
(1 row)
gin_leafpage_items(page bytea) returns setof record

gin_leafpage_items 返回有关存储在压缩GIN叶子页面中的数据的信息。例如

test=# SELECT first_tid, nbytes, tids[0:5] AS some_tids
        FROM gin_leafpage_items(get_raw_page('gin_test_idx', 2));
 first_tid | nbytes |                        some_tids
-----------+--------+----------------------------------------------------------
 (8,41)    |    244 | {"(8,41)","(8,43)","(8,44)","(8,45)","(8,46)"}
 (10,45)   |    248 | {"(10,45)","(10,46)","(10,47)","(10,48)","(10,49)"}
 (12,52)   |    248 | {"(12,52)","(12,53)","(12,54)","(12,55)","(12,56)"}
 (14,59)   |    320 | {"(14,59)","(14,60)","(14,61)","(14,62)","(14,63)"}
 (167,16)  |    376 | {"(167,16)","(167,17)","(167,18)","(167,19)","(167,20)"}
 (170,30)  |    376 | {"(170,30)","(170,31)","(170,32)","(170,33)","(170,34)"}
 (173,44)  |    197 | {"(173,44)","(173,45)","(173,46)","(173,47)","(173,48)"}
(7 rows)

F.23.6. GiST 函数 #

gist_page_opaque_info(page bytea) returns record

gist_page_opaque_infoGiST索引页面的不透明区域返回信息,例如 NSN、右链接和页面类型。例如

test=# SELECT * FROM gist_page_opaque_info(get_raw_page('test_gist_idx', 2));
 lsn | nsn | rightlink | flags
-----+-----+-----------+--------
 0/1 | 0/0 |         1 | {leaf}
(1 row)
gist_page_items(page bytea, index_oid regclass) returns setof record

gist_page_items 返回有关存储在GiST索引页面中的数据的信息。例如

test=# SELECT * FROM gist_page_items(get_raw_page('test_gist_idx', 0), 'test_gist_idx');
 itemoffset |   ctid    | itemlen | dead |             keys
------------+-----------+---------+------+-------------------------------
          1 | (1,65535) |      40 | f    | (p)=("(185,185),(1,1)")
          2 | (2,65535) |      40 | f    | (p)=("(370,370),(186,186)")
          3 | (3,65535) |      40 | f    | (p)=("(555,555),(371,371)")
          4 | (4,65535) |      40 | f    | (p)=("(740,740),(556,556)")
          5 | (5,65535) |      40 | f    | (p)=("(870,870),(741,741)")
          6 | (6,65535) |      40 | f    | (p)=("(1000,1000),(871,871)")
(6 rows)
gist_page_items_bytea(page bytea) returns setof record

gist_page_items 相同,但将键数据作为原始 bytea blob 返回。由于它不尝试解码键,因此它不需要知道涉及哪个索引。例如

test=# SELECT * FROM gist_page_items_bytea(get_raw_page('test_gist_idx', 0));
 itemoffset |   ctid    | itemlen | dead |                                      key_data
------------+-----------+---------+------+-----------------------------------------​-------------------------------------------
          1 | (1,65535) |      40 | f    | \x00000100ffff28000000000000c0644000000000​00c06440000000000000f03f000000000000f03f
          2 | (2,65535) |      40 | f    | \x00000200ffff28000000000000c0744000000000​00c074400000000000e064400000000000e06440
          3 | (3,65535) |      40 | f    | \x00000300ffff28000000000000207f4000000000​00207f400000000000d074400000000000d07440
          4 | (4,65535) |      40 | f    | \x00000400ffff28000000000000c0844000000000​00c084400000000000307f400000000000307f40
          5 | (5,65535) |      40 | f    | \x00000500ffff28000000000000f0894000000000​00f089400000000000c884400000000000c88440
          6 | (6,65535) |      40 | f    | \x00000600ffff28000000000000208f4000000000​00208f400000000000f889400000000000f88940
          7 | (7,65535) |      40 | f    | \x00000700ffff28000000000000408f4000000000​00408f400000000000288f400000000000288f40
(7 rows)

F.23.7. 哈希函数 #

hash_page_type(page bytea) returns text

hash_page_type 返回给定HASH索引页面的页面类型。例如

test=# SELECT hash_page_type(get_raw_page('con_hash_index', 0));
 hash_page_type
----------------
 metapage
hash_page_stats(page bytea) returns setof record

hash_page_stats 返回有关HASH索引页面中的数据的信息。例如

test=# SELECT * FROM hash_page_stats(get_raw_page('con_hash_index', 1));
-[ RECORD 1 ]---+-----------
live_items      | 407
dead_items      | 0
page_size       | 8192
free_size       | 8
hasho_prevblkno | 4096
hasho_nextblkno | 8474
hasho_bucket    | 0
hasho_flag      | 66
hasho_page_id   | 65408
hash_page_items(page bytea) returns setof record

hash_page_items 返回有关存储在HASH索引页面的页面类型。例如

test=# SELECT * FROM hash_page_items(get_raw_page('con_hash_index', 1)) LIMIT 5;
 itemoffset |   ctid    |    data
------------+-----------+------------
          1 | (899,77)  | 1053474816
          2 | (897,29)  | 1053474816
          3 | (894,207) | 1053474816
          4 | (892,159) | 1053474816
          5 | (890,111) | 1053474816
hash_bitmap_info(index oid, blkno bigint) returns record

hash_bitmap_info 显示HASH索引页面中的数据的信息。例如

test=# SELECT * FROM hash_bitmap_info('con_hash_index', 2052);
 bitmapblkno | bitmapbit | bitstatus
-------------+-----------+-----------
          65 |         3 | t
hash_metapage_info(page bytea) returns record

hash_metapage_info 返回存储在HASH索引页面中的数据的信息。例如

test=# SELECT magic, version, ntuples, ffactor, bsize, bmsize, bmshift,
test-#     maxbucket, highmask, lowmask, ovflpoint, firstfree, nmaps, procid,
test-#     regexp_replace(spares::text, '(,0)*}', '}') as spares,
test-#     regexp_replace(mapp::text, '(,0)*}', '}') as mapp
test-# FROM hash_metapage_info(get_raw_page('con_hash_index', 0));
-[ RECORD 1 ]-------------------------------------------------​------------------------------
magic     | 105121344
version   | 4
ntuples   | 500500
ffactor   | 40
bsize     | 8152
bmsize    | 4096
bmshift   | 15
maxbucket | 12512
highmask  | 16383
lowmask   | 8191
ovflpoint | 28
firstfree | 1204
nmaps     | 1
procid    | 450
spares    | {0,0,0,0,0,0,1,1,1,1,1,1,1,1,3,4,4,4,45,55,58,59,​508,567,628,704,1193,1202,1204}
mapp      | {65}

提交更正

如果您在文档中看到任何不正确、与您使用特定功能的经验不符或需要进一步澄清的内容,请使用此表单报告文档问题。