Sophie

Sophie

distrib > Mandriva > 2008.1 > x86_64 > media > main-testing > by-pkgid > bab02a23fa9f3df8d66a9a3231b50245 > files > 388

postgresql8.3-docs-8.3.6-2mdv2008.1.x86_64.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<HTML
><HEAD
><TITLE
>pageinspect</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
REV="MADE"
HREF="mailto:pgsql-docs@postgresql.org"><LINK
REL="HOME"
TITLE="PostgreSQL 8.3.6 Documentation"
HREF="index.html"><LINK
REL="UP"
TITLE="Additional Supplied Modules"
HREF="contrib.html"><LINK
REL="PREVIOUS"
TITLE="oid2name"
HREF="oid2name.html"><LINK
REL="NEXT"
TITLE="pgbench"
HREF="pgbench.html"><LINK
REL="STYLESHEET"
TYPE="text/css"
HREF="stylesheet.css"><META
HTTP-EQUIV="Content-Type"
CONTENT="text/html; charset=ISO-8859-1"><META
NAME="creation"
CONTENT="2009-02-03T04:34:16"></HEAD
><BODY
CLASS="SECT1"
><DIV
CLASS="NAVHEADER"
><TABLE
SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="5"
ALIGN="center"
VALIGN="bottom"
>PostgreSQL 8.3.6 Documentation</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="top"
><A
HREF="oid2name.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="top"
><A
HREF="contrib.html"
>Fast Backward</A
></TD
><TD
WIDTH="60%"
ALIGN="center"
VALIGN="bottom"
>Appendix F. Additional Supplied Modules</TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="top"
><A
HREF="contrib.html"
>Fast Forward</A
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="top"
><A
HREF="pgbench.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><DIV
CLASS="SECT1"
><H1
CLASS="SECT1"
><A
NAME="PAGEINSPECT"
>F.17. pageinspect</A
></H1
><A
NAME="AEN101923"
></A
><P
>  The <TT
CLASS="FILENAME"
>pageinspect</TT
> module provides functions that allow you to
  inspect the contents of database pages at a low level, which is useful for
  debugging purposes.  All of these functions may be used only by superusers.
 </P
><DIV
CLASS="SECT2"
><H2
CLASS="SECT2"
><A
NAME="AEN101927"
>F.17.1. Functions</A
></H2
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
><CODE
CLASS="FUNCTION"
>get_raw_page(text, int) returns bytea</CODE
></DT
><DD
><P
>      <CODE
CLASS="FUNCTION"
>get_raw_page</CODE
> reads the specified block of the named
      table and returns a copy as a <TT
CLASS="TYPE"
>bytea</TT
> value.  This allows a
      single time-consistent copy of the block to be obtained.
     </P
></DD
><DT
><CODE
CLASS="FUNCTION"
>page_header(bytea) returns record</CODE
></DT
><DD
><P
>      <CODE
CLASS="FUNCTION"
>page_header</CODE
> shows fields that are common to all
      <SPAN
CLASS="PRODUCTNAME"
>PostgreSQL</SPAN
> heap and index pages.
     </P
><P
>      A page image obtained with <CODE
CLASS="FUNCTION"
>get_raw_page</CODE
> should be
      passed as argument.  For example:
     </P
><PRE
CLASS="PROGRAMLISTING"
>test=# SELECT * FROM page_header(get_raw_page('pg_class', 0));
    lsn    | tli | flags | lower | upper | special | pagesize | version | prune_xid
-----------+-----+-------+-------+-------+---------+----------+---------+-----------
 0/24A1B50 |   1 |     1 |   232 |   368 |    8192 |     8192 |       4 |         0
     </PRE
><P
>      The returned columns correspond to the fields in the
      <TT
CLASS="STRUCTNAME"
>PageHeaderData</TT
> struct.
      See <TT
CLASS="FILENAME"
>src/include/storage/bufpage.h</TT
> for details.
    </P
></DD
><DT
><CODE
CLASS="FUNCTION"
>heap_page_items(bytea) returns setof record</CODE
></DT
><DD
><P
>      <CODE
CLASS="FUNCTION"
>heap_page_items</CODE
> shows all line pointers on a heap
      page.  For those line pointers that are in use, tuple headers are also
      shown. All tuples are shown, whether or not the tuples were visible to
      an MVCC snapshot at the time the raw page was copied.
     </P
><P
>      A heap page image obtained with <CODE
CLASS="FUNCTION"
>get_raw_page</CODE
> should
      be passed as argument.  For example:
     </P
><PRE
CLASS="PROGRAMLISTING"
>test=# SELECT * FROM heap_page_items(get_raw_page('pg_class', 0));
     </PRE
><P
>      See <TT
CLASS="FILENAME"
>src/include/storage/itemid.h</TT
> and
      <TT
CLASS="FILENAME"
>src/include/access/htup.h</TT
> for explanations of the fields
      returned.
     </P
></DD
><DT
><CODE
CLASS="FUNCTION"
>bt_metap(text) returns record</CODE
></DT
><DD
><P
>      <CODE
CLASS="FUNCTION"
>bt_metap</CODE
> returns information about a btree
      index's metapage.  For example:
     </P
><PRE
CLASS="PROGRAMLISTING"
>test=# SELECT * FROM bt_metap('pg_cast_oid_index');
-[ RECORD 1 ]-----
magic     | 340322
version   | 2
root      | 1
level     | 0
fastroot  | 1
fastlevel | 0
     </PRE
></DD
><DT
><CODE
CLASS="FUNCTION"
>bt_page_stats(text, int) returns record</CODE
></DT
><DD
><P
>      <CODE
CLASS="FUNCTION"
>bt_page_stats</CODE
> returns summary information about
      single pages of btree indexes.  For example:
     </P
><PRE
CLASS="PROGRAMLISTING"
>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
     </PRE
></DD
><DT
><CODE
CLASS="FUNCTION"
>bt_page_items(text, int) returns setof record</CODE
></DT
><DD
><P
>      <CODE
CLASS="FUNCTION"
>bt_page_items</CODE
> returns detailed information about
      all of the items on a btree index page.  For example:
     </P
><PRE
CLASS="PROGRAMLISTING"
>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
     </PRE
></DD
></DL
></DIV
></DIV
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="oid2name.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="index.html"
ACCESSKEY="H"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="pgbench.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>oid2name</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="contrib.html"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>pgbench</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>