<function>bt_index_check</function> tests that its target, a B-Tree index, respects a variety of invariants. Example usage: bt_index_checkは対象となるB-Treeインデックスが、様々な不変量を維持していることをテストします。 例を示します。

test=# SELECT bt_index_check(index => c.oid, heapallindexed => i.indisunique),
               c.relname,
               c.relpages
FROM pg_index i
JOIN pg_opclass op ON i.indclass[0] = op.oid
JOIN pg_am am ON op.opcmethod = am.oid
JOIN pg_class c ON i.indexrelid = c.oid
JOIN pg_namespace n ON c.relnamespace = n.oid
WHERE am.amname = 'btree' AND n.nspname = 'pg_catalog'
-- Don't check temp tables, which may be from another session:
AND c.relpersistence != 't'
-- Function may throw an error when this is omitted:
AND c.relkind = 'i' AND i.indisready AND i.indisvalid
ORDER BY c.relpages DESC LIMIT 10;
 bt_index_check |             relname             | relpages
----------------+---------------------------------+----------
                | pg_depend_reference_index       |       43
                | pg_depend_depender_index        |       40
                | pg_proc_proname_args_nsp_index  |       31
                | pg_description_o_c_o_index      |       21
                | pg_attribute_relid_attnam_index |       14
                | pg_proc_oid_index               |       10
                | pg_attribute_relid_attnum_index |        9
                | pg_amproc_fam_proc_index        |        5
                | pg_amop_opr_fam_index           |        5
                | pg_amop_fam_strat_index         |        5
(10 rows)

This example shows a session that performs verification of the 10 largest catalog indexes in the database <quote>test</quote>. Verification of the presence of heap tuples as index tuples is requested for the subset that are unique indexes. Since no error is raised, all indexes tested appear to be logically consistent. Naturally, this query could easily be changed to call <function>bt_index_check</function> for every index in the database where verification is supported. この例では、データベース「test」中のもっとも大きな10個のカタログインデックスの検証を行うセッションを示しています。 インデックスタプルに対応するヒープタプルの存在の検証が、ユニークインデックスであるインデックスの一部に対して要求されています。 エラーは出ていないので、テストしたすべてのインデックスは論理的に一貫していることがわかります。 当然のことながら、この問い合わせは、検証可能なデータベース中のすべてのインデックスに対してbt_index_checkを呼び出すように変更できます。

<function>bt_index_check</function> acquires an <literal>AccessShareLock</literal> on the target index and the heap relation it belongs to. This lock mode is the same lock mode acquired on relations by simple <literal>SELECT</literal> statements. <function>bt_index_check</function> does not verify invariants that span child/parent relationships, but will verify the presence of all heap tuples as index tuples within the index when <parameter>heapallindexed</parameter> is <literal>true</literal>. When a routine, lightweight test for corruption is required in a live production environment, using <function>bt_index_check</function> often provides the best trade-off between thoroughness of verification and limiting the impact on application performance and availability. bt_index_checkは、ターゲットとなるインデックスと、それが所属するヒープリレーションに対してAccessShareLockを獲得します。 このロックモードは、単純なSELECT文がリレーションに対して獲得するのと同じものです。 bt_index_checkは、子／親関係に渡る不変量を検査しませんが、heapallindexedがtrueの場合には、インデックス中のインデックスタプルに対応するすべてのヒープタプルの存在が検証されます。 実行中の運用環境で定期的、軽量なデータ破損検査が必要な場合、bt_index_checkを使うのが、検査の完全性と、アプリケーションの性能と稼働への影響を限定することとの間の最良のトレードオフになることがしばしばあります。

<function>bt_index_parent_check</function> tests that its target, a B-Tree index, respects a variety of invariants. Optionally, when the <parameter>heapallindexed</parameter> argument is <literal>true</literal>, the function verifies the presence of all heap tuples that should be found within the index. When the optional <parameter>rootdescend</parameter> argument is <literal>true</literal>, verification re-finds tuples on the leaf level by performing a new search from the root page for each tuple. The checks that can be performed by <function>bt_index_parent_check</function> are a superset of the checks that can be performed by <function>bt_index_check</function>. <function>bt_index_parent_check</function> can be thought of as a more thorough variant of <function>bt_index_check</function>: unlike <function>bt_index_check</function>, <function>bt_index_parent_check</function> also checks invariants that span parent/child relationships, including checking that there are no missing downlinks in the index structure. <function>bt_index_parent_check</function> follows the general convention of raising an error if it finds a logical inconsistency or other problem. bt_index_parent_checkは、ターゲットとなるB-Treeインデックスが様々な不変量を保っていることを検査します。 オプションとして、heapallindexed引数がtrueの場合、インデックスに対応して存在すべきすべてのヒープタプルの存在を検証します。 省略可能な引数rootdescendがtrueであれば、各タプルに対するルートページから新しく探索することで、検証はリーフレベルのタプルを再び見つけます。 bt_index_parent_checkにより実施される検査は、bt_index_checkにより実施される検査のスーパーセットになっています。 bt_index_parent_checkは、bt_index_checkの更なる完璧版であると考えることができます。 つまり、bt_index_checkと違ってbt_index_parent_checkは、インデックス構造中のダウンリンクに漏れがないことを含め、親／子関係に渡る不変量も検査します。 bt_index_parent_checkは、論理的な非一貫性やその他の問題を発見した場合、一般的な習慣に従ってエラーを報告します。

A <literal>ShareLock</literal> is required on the target index by <function>bt_index_parent_check</function> (a <literal>ShareLock</literal> is also acquired on the heap relation). These locks prevent concurrent data modification from <command>INSERT</command>, <command>UPDATE</command>, and <command>DELETE</command> commands. The locks also prevent the underlying relation from being concurrently processed by <command>VACUUM</command>, as well as all other utility commands. Note that the function holds locks only while running, not for the entire transaction. bt_index_parent_checkは、ターゲットインデックスにShareLockを獲得することを必要とします。 （ShareLockはヒープリレーションにも獲得されます。） このロックは、INSERT、UPDATE、DELETEが並行してデータ更新することを防ぎます。 また、このロックはVACUUMその他のユーティリティコマンドによって、背後にあるリレーションが同時に処理されることを防ぎます。 この関数は実行中のみロックを保持し、トランザクション全体に保持するのではないことに注意してください。

<function>bt_index_parent_check</function>'s additional verification is more likely to detect various pathological cases. These cases may involve an incorrectly implemented B-Tree operator class used by the index that is checked, or, hypothetically, undiscovered bugs in the underlying B-Tree index access method code. Note that <function>bt_index_parent_check</function> cannot be used when hot standby mode is enabled (i.e., on read-only physical replicas), unlike <function>bt_index_check</function>. bt_index_parent_checkによる追加の検査では、様々な病的な事象を検出する可能性があります。 これらの現象は、チェック対象のインデックスが使用している間違った実装がされたB-Tree演算子クラスによるものや、もしかしたら関連するB-Treeインデックスアクセスメソッドのコード中のまだ見つかっていないバグによるものなのかもしれません。 bt_index_checkと違って、bt_index_parent_checkは、ホットスタンバイモードが有効な場合（すなわち、読み出し専用物理レプリカ）では使用できません。

Checks a table, sequence, or materialized view for structural corruption, where pages in the relation contain data that is invalidly formatted, and for logical corruption, where pages are structurally valid but inconsistent with the rest of the database cluster. リレーションのページが不正なフォーマットのデータを含む構造上の破損と、ページは構造的に正しいものの、データベースクラスタの他の部分と一貫していない論理上の破損に関してテーブル、シーケンス、またはマテリアライズドビューを検査します。

The following optional arguments are recognized: 次のようなオプションの引数を認識します。

For each corruption detected, <function>verify_heapam</function> returns a row with the following columns: 個々の破損の検出に対してverify_heapamは以下の列を含む行を返します。