F.22. pageinspect

pageinspect模块提供的功能可让您从低级别检查数据库页面的内容,这对于调试目的很有用。所有这些功能只能由超级用户使用。

F.22.1. 一般功能

  • get_raw_page(relname text, fork text, blkno int) returns bytea

    • get_raw_page读取命名关系的指定块,并以bytea值的形式返回副本。这允许获得该块的单个时间一致的副本。 * fork *对于主数据分支应为'main',对于自由空间 Map 应为'fsm',对于可见性 Map 应为'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

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

可以将此函数计算出的校验和与函数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.22.2. 堆函数

  • heap_page_items(page bytea) returns setof record

    • heap_page_items显示堆页面上的所有行指针。对于正在使用的那些行指针,还显示了 Tuples 标题和 Tuples 原始数据。显示所有 Tuples,无论 Tuples 是否在复制原始页面时对 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

  • 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以与后端内部相同的方式将 Tuples 数据拆分为属性。
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,则将根据需要删除该属性。默认值为false

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

    • heap_page_item_attrs等效于heap_page_items,不同之处在于它返回 Tuples 原始数据作为属性数组,并且可以选择由* do_detoast *(默认情况下为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指向堆 Tuples。在内部页中,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 索引范围 Map 页面中的 Tuples 标识符列表。例如:
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}

返回的列对应于BrinMemTupleBrinValues结构中的字段。有关详细信息,请参见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_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 int) 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}