pageinspect
モジュールは、デバッグの際に有用となる低レベルなデータベースページの内容を調べることができる関数を提供します。
これらの関数はすべて、スーパーユーザのみが使用することができます。
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
チェックサムはブロック番号に依存するので、(難解なデバッグをする場合以外は)対応するブロック番号を渡さなければならないことに注意してください。
この関数で計算されたチェックサムは、page_header
関数のchecksum
結果フィールドと比較できます。
このインスタンスに対してデータチェックサムが有効になっていれば、二つの値は等しくならなければなりません。
fsm_page_contents(page bytea) returns text
fsm_page_contents
は、FSMページの内部ノード構造を表示します。
以下に例を示します。
test=# SELECT fsm_page_contents(get_raw_page('pg_class', 'fsm', 0));
出力は複数行からなる文字列で、各行がページ内のバイナリツリー(二分木)の1ノードを表します。 それらのノードのうち、非ゼロのノードのみが出力されます。 そのページから返される次のスロットを指し示すための"next(次)"と呼ばれるポインタも出力されます。
FSMページの構造に関する更に詳しい情報は、src/backend/storage/freespace/README
を参照してください。
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
を参照してください。
heap_tuple_infomask_flags
関数を使用すると、ヒープタプルのt_infomask
およびt_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_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
(デフォルトはfalse
)によって非TOAST化可能な属性の配列として返すところが異なります。
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_flags
は、heap_page_items
から返されるt_infomask
およびt_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
など、複数のrawビットの値を考慮するソースレベルのマクロから得られたビットを表示します。
返されるフラグ名の説明については、src/include/access/htup_details.h
を参照して下さい。
bt_metap(relname text) returns record
bt_metap
はB-treeインデックスのメタページに関する情報を返します。
以下に例を示します。
test=# SELECT * FROM bt_metap('pg_cast_oid_index'); -[ RECORD 1 ]-----------+------- magic | 340322 version | 4 root | 1 level | 0 fastroot | 1 fastlevel | 0 oldest_xact | 582 last_cleanup_num_tuples | 1000 allequalimage | f
bt_page_stats(relname text, blkno int) returns record
bt_page_stats
は、B-treeインデックスの個別のページについての要約情報を返します。
以下に例を示します。
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 | 0 btpo_flags | 3
bt_page_items(relname text, blkno int) returns setof record
bt_page_items
は、B-treeインデックスページ上の全項目についての詳細情報を返します。
以下に例を示します。
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-treeのリーフページです。
テーブルを指し示すすべてのタプルは、ポスティングリストのタプルになっています(これらはすべて6バイトTIDが合計100個格納されます)。
また、itemoffset
番号1には「ハイキー(high key)」タプルもあります。
この例では、各タプルに関するエンコードされた情報を格納するためにctid
が使用されていますが、リーフページタプルでは、ヒープTIDが直接ctid
フィールドに格納されることがよくあります。
tids
はポスティングリストとして格納されるTIDのリストです。
内部ページ(示されていません)では、ctid
のブロック番号部分は、「ダウンリンク(downlink)」であり、インデックス内の他のページのブロック番号です。
ctid
のオフセット部分(2番め)には、存在する列の数など、タプルに関するエンコードされた情報が格納されます(サフィックスの切り捨てによって、不要なサフィックス列が削除されている場合があります)。
切り捨てられた列は、「マイナス無限大(minus infinity)」を持つものとして扱われます。
htid
は、基礎となるタプル表現に関係なく、タプルのヒープTIDを示します。
この値は、ctid
と一致する場合もあれば、ポスティングリストのタプルおよび内部ページのタプルが使用する別の表現からデコードされる場合もあります。
内部ページのタプルでは、実装レベルのヒープTID列が切り捨てられ、NULL htid
値として表されます。
右端以外のページ(btpo_next
フィールドの値が0でないページ)において、最初の項目はページの「ハイキー」であることに注意してください。
つまりそのページに現れるすべての項目の上限となるdata
になりますが、一方でそのctid
フィールドは別のブロックを指していないことを意味します。
また、内部ページでは、最初の実データ項目(ハイキーでない最初の項目)は、確実にすべての列が切り捨てられ、そのdata
フィールドに実際の値は残りません。
しかし、そのような項目でも、そのctid
フィールドには有効なダウンリンクが入っています。
B-Treeインデックスの構造についての詳細は63.4.1を参照してください。 重複排除とポスティングリストについての詳細は63.4.2を参照してください。
bt_page_items(page bytea) returns setof record
ページをbt_page_items
にbytea
の値として渡すことも可能です。
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)
その他の詳細はすべて前の項目で説明したものと同じです。
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
を参照して下さい。
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)
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}