diff options
Diffstat (limited to 'doc/src')
| -rw-r--r-- | doc/src/sgml/amcheck.sgml | 14 | ||||
| -rw-r--r-- | doc/src/sgml/ref/pg_amcheck.sgml | 11 |
2 files changed, 21 insertions, 4 deletions
diff --git a/doc/src/sgml/amcheck.sgml b/doc/src/sgml/amcheck.sgml index 2b9c1a9205f..780fd05a73b 100644 --- a/doc/src/sgml/amcheck.sgml +++ b/doc/src/sgml/amcheck.sgml @@ -58,7 +58,7 @@ <variablelist> <varlistentry> <term> - <function>bt_index_check(index regclass, heapallindexed boolean) returns void</function> + <function>bt_index_check(index regclass, heapallindexed boolean, checkunique boolean) returns void</function> <indexterm> <primary>bt_index_check</primary> </indexterm> @@ -115,7 +115,10 @@ ORDER BY c.relpages DESC LIMIT 10; 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 + <literal>true</literal>. When <parameter>checkunique</parameter> + is <literal>true</literal> <function>bt_index_check</function> will + check that no more than one among duplicate entries in unique + index is visible. 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 @@ -126,7 +129,7 @@ ORDER BY c.relpages DESC LIMIT 10; <varlistentry> <term> - <function>bt_index_parent_check(index regclass, heapallindexed boolean, rootdescend boolean) returns void</function> + <function>bt_index_parent_check(index regclass, heapallindexed boolean, rootdescend boolean, checkunique boolean) returns void</function> <indexterm> <primary>bt_index_parent_check</primary> </indexterm> @@ -139,7 +142,10 @@ ORDER BY c.relpages DESC LIMIT 10; 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> + index. When <parameter>checkunique</parameter> + is <literal>true</literal> <function>bt_index_parent_check</function> will + check that no more than one among duplicate entries in unique + index is visible. 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 diff --git a/doc/src/sgml/ref/pg_amcheck.sgml b/doc/src/sgml/ref/pg_amcheck.sgml index 20c2897accb..067c806b46d 100644 --- a/doc/src/sgml/ref/pg_amcheck.sgml +++ b/doc/src/sgml/ref/pg_amcheck.sgml @@ -432,6 +432,17 @@ PostgreSQL documentation </para> </listitem> </varlistentry> + + <varlistentry> + <term><option>--checkunique</option></term> + <listitem> + <para> + For each index with unique constraint checked, verify that no more than + one among duplicate entries is visible in the index using <xref linkend="amcheck"/>'s + <option>checkunique</option> option. + </para> + </listitem> + </varlistentry> </variablelist> </para> |