他のバージョンの文書11 | 10 | 9.6 | 9.5 | 9.4 | 9.3 | 9.2 | 9.1 | 9.0 | 8.4 | 8.3 | 8.2 | 8.1 | 8.0 | 7.4 | 7.3 | 7.2

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

チェックサムはブロック番号に依存するので、(難解なデバッグをする場合以外は)対応するブロック番号を渡さなければならないことに注意してください。

この関数で計算されたチェックサムは、page_header関数のchecksum結果フィールドと比較できます。 このインスタンスに対してデータチェックサムが有効になっていれば、二つの値は等しくならなければなりません。

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_detoasttrueの場合、属性は必要に応じて非TOAST化されます。 デフォルト値は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)によって非TOAST化可能な属性の配列として返すところが異なります。

get_raw_pageで取得できるヒープページのイメージを引数として渡してください。 以下に例を示します。

test=# SELECT * FROM heap_page_item_attrs(get_raw_page('pg_class', 0), 'pg_class'::regclass);

fsm_page_contents(page bytea) returns text

fsm_page_contentsは、FSMページの内部ノード構造を表示します。 出力は複数行からなる文字列で、各行がページ内のバイナリツリー(二分木)の1ノードを表します。 それらのノードのうち、非ゼロのノードのみが出力されます。 そのページから返される次のスロットを指し示すための"next(次)"と呼ばれるポインタも出力されます。

FSMページの構造に関する更に詳しい情報は、src/backend/storage/freespace/READMEを参照してください。

F.22.2. B-tree関数

bt_metap(relname text) returns record

bt_metapはB-treeインデックスのメタページに関する情報を返却します。 以下に例を示します。

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-treeインデックスの個別のページについての要約情報を返却します。 以下に例を示します。

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-treeインデックスページ上の全項目についての詳細情報を返却します。 以下に例を示します。

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-treeのリーフページでは、ctidはヒープタプルを指します。 中間のページでは、ctidのブロック番号部分はインデックス自体の中の他のページを指しますが、オフセット部分(2番目の数)は無視され、通常は1になっています。

最も右側でないすべてのページ(btpo_nextフィールドの値が0でないページ)において、最初の項目は高いキー、つまりそのページに現れるすべての項目の上限となるdataになりますが、一方でそのctidフィールドには意味がありません。 また、リーフでないページにおいて最初の実データ項目(高いキーでない最初の項目)は、そのdataフィールドに実際の値が入っていないマイナス無限大の項目になります。 しかし、そのような項目でも、そのctidフィールドには有効な下方リンクが入っています。

bt_page_items(page bytea) returns setof record

ページをbt_page_itemsbyteaの値として渡すことも可能です。 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.3. 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_infoBRINインデックスのメタページについて様々な情報を返します。 以下に例を示します。

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_dataBRINインデックスの範囲マップページのタプル識別子のリストを返します。 以下に例を示します。

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_itemsBRINデータページに記録されているデータを返します。 以下に例を示します。

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.4. GIN関数

gin_metapage_info(page bytea) returns record

gin_metapage_infoGINインデックスのメタページに関する情報を返します。 以下に例を示します。

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_itemsGINのリーフページに格納されているデータについての情報を返します。 以下に例を示します。

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.5. 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_statsHASHインデックスのバケットページやオーバーフローページに関する情報を返します。 以下に例を示します。

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_itemsHASHインデックスページのバケットページやオーバーフローページに保存されたデータに関する情報を返します。 以下に例を示します。

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_infoHASHインデックスの特定のオーバーフローページに対するビットマップページのビットの状態を表示します。 以下に例を示します。

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_infoHASHインデックスのメタページに保存された情報を返します。 以下に例を示します。

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}