F.22. pageinspect #
pageinspect 模块提供了一组函数,允许你在底层检查数据库页的内容,这对调试很有帮助。所有这些函数都只能由超级用户使用。
F.22.1. 通用函数
-
get_raw_page(relname text, fork text, blkno int) returns bytea get_raw_page读取指定关系的指定块,并以bytea值的形式返回其副本。这样就能获得该块在单一时刻的一致副本。fork应当为'main'(主数据分支)、'fsm'(空闲空间映射)、'vm'(可见性映射)或'init'(初始化分支)。-
get_raw_page(relname text, blkno int) 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 int4) returns smallint page_checksum计算该页面在位于给定块号时的校验和。应将用
get_raw_page获得的页面映像作为参数传入。例如:test=# SELECT page_checksum(get_raw_page('pg_class', 0), 0); page_checksum --------------- 13443注意,校验和依赖于块号,因此应传入匹配的块号(除非是在做某些特殊的调试工作)。
可以将此函数计算出的校验和与
checksum结果字段进行比较,该字段来自函数page_header。如果本实例启用了数据校验和,那么这两个值应当相等。-
fsm_page_contents(page bytea) returns text fsm_page_contents显示 FSM 页的内部节点结构。例如:test=# SELECT fsm_page_contents(get_raw_page('pg_class', 'fsm', 0));输出是一个多行字符串,页内二叉树中的每个节点对应一行。只打印非零节点。还会打印所谓的“next”指针,它指向下一个将从该页返回的槽位。
参见
src/backend/storage/freespace/README,了解 FSM 页面结构的更多信息。
F.22.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.h和src/include/access/htup_details.h。-
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_detoast为true,则会按需对属性执行去 TOAST 化处理。默认值为false。-
heap_page_item_attrs(page bytea, rel_oid regclass [, do_detoast bool]) returns setof record heap_page_item_attrs与heap_page_items等效,不同之处在于它将元组原始数据作为属性数组返回,并且可以通过do_detoast选择是否对这些属性执行去 TOAST 化处理;该参数默认为false。应将用
get_raw_page获得的堆页面映像作为参数传入。例如:test=# SELECT * FROM heap_page_item_attrs(get_raw_page('pg_class', 0), 'pg_class'::regclass);
F.22.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 | 3 root | 1 level | 0 fastroot | 1 fastlevel | 0 oldest_xact | 582 last_cleanup_num_tuples | 1000-
bt_page_stats(relname text, blkno int) 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 | 256 dead_items | 0 avg_item_size | 12 page_size | 8192 free_size | 4056 btpo_prev | 0 btpo_next | 0 btpo | 0 btpo_flags | 3-
bt_page_items(relname text, blkno int) returns setof record bt_page_items返回 B-树索引页中所有项的详细信息。例如:test=# SELECT * FROM bt_page_items('pg_cast_oid_index', 1); itemoffset | ctid | itemlen | nulls | vars | data ------------+---------+---------+-------+------+------------- 1 | (0,1) | 12 | f | f | 23 27 00 00 2 | (0,2) | 12 | f | f | 24 27 00 00 3 | (0,3) | 12 | f | f | 25 27 00 00 4 | (0,4) | 12 | f | f | 26 27 00 00 5 | (0,5) | 12 | f | f | 27 27 00 00 6 | (0,6) | 12 | f | f | 28 27 00 00 7 | (0,7) | 12 | f | f | 29 27 00 00 8 | (0,8) | 12 | f | f | 2a 27 00 00在 B-树叶页中,
ctid指向一个堆元组。在内部页中,ctid的块号部分指向索引本身的另一个页面,而偏移量部分(第二个数字)被忽略,通常为 1。请注意,任何非最右页(即
btpo_next字段值非零的页面)的第一项都是该页的“高键”,这意味着其data充当该页上所有项的上界,而其ctid字段没有意义。另外,在非叶子页上,第一个真正的数据项(第一个不是高键的项)是一个“负无穷”项,其data字段中没有实际值。不过,这样的项在ctid字段中确实有一个有效的下行链接。-
bt_page_items(page bytea) returns setof record 也可以将页作为
bytea值传给bt_page_items。应将用get_raw_page获得的页面映像作为参数传入。因此,上一个示例也可以改写成下面这样:test=# SELECT * FROM bt_page_items(get_raw_page('pg_cast_oid_index', 1)); itemoffset | ctid | itemlen | nulls | vars | data ------------+---------+---------+-------+------+------------- 1 | (0,1) | 12 | f | f | 23 27 00 00 2 | (0,2) | 12 | f | f | 24 27 00 00 3 | (0,3) | 12 | f | f | 25 27 00 00 4 | (0,4) | 12 | f | f | 26 27 00 00 5 | (0,5) | 12 | f | f | 27 27 00 00 6 | (0,6) | 12 | f | f | 28 27 00 00 7 | (0,7) | 12 | f | f | 29 27 00 00 8 | (0,8) | 12 | f | f | 2a 27 00 00其余细节与上一项中的说明相同。
F.22.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 | value ------------+--------+--------+----------+----------+-------------+-------------- 137 | 0 | 1 | t | f | f | 137 | 0 | 2 | f | f | f | {1 .. 88} 138 | 4 | 1 | t | f | f | 138 | 4 | 2 | f | f | f | {89 .. 176} 139 | 8 | 1 | t | f | f | 139 | 8 | 2 | f | f | f | {177 .. 264}返回的列对应于
BrinMemTuple和BrinValues结构体中的字段。详细信息见src/include/access/brin_tuple.h。
F.22.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.22.6. Hash 函数
-
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) | 1053474816hash_bitmap_info(index oid, blkno int) returns recordhash_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}